https://github.com/termux/termux-language-server

🛠️ A language server for some specific bash scripts
https://github.com/termux/termux-language-server

archlinux ebuild gentoo lsp-server makepkg package-manager packaging pacman pkgbuild portage termux

Last synced: 14 days ago
JSON representation

🛠️ A language server for some specific bash scripts

• Host: GitHub
• URL: https://github.com/termux/termux-language-server
• Owner: termux
• License: gpl-3.0
• Created: 2023-09-21T20:16:32.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-08T22:57:46.000Z (about 1 year ago)
• Last Synced: 2024-04-13T21:07:36.937Z (about 1 year ago)
• Topics: archlinux, ebuild, gentoo, lsp-server, makepkg, package-manager, packaging, pacman, pkgbuild, portage, termux
• Language: Python
• Homepage: https://termux-language-server.readthedocs.io/
• Size: 334 KB
• Stars: 41
• Watchers: 8
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# termux-language-server

[![readthedocs](https://shields.io/readthedocs/termux-language-server)](https://termux-language-server.readthedocs.io)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/termux/termux-language-server/main.svg)](https://results.pre-commit.ci/latest/github/termux/termux-language-server/main)

[![github/workflow](https://github.com/termux/termux-language-server/actions/workflows/main.yml/badge.svg)](https://github.com/termux/termux-language-server/actions)

[![codecov](https://codecov.io/gh/termux/termux-language-server/branch/main/graph/badge.svg)](https://codecov.io/gh/termux/termux-language-server)

[![DeepSource](https://deepsource.io/gh/termux/termux-language-server.svg/?show_trend=true)](https://deepsource.io/gh/termux/termux-language-server)

[![github/downloads](https://shields.io/github/downloads/termux/termux-language-server/total)](https://github.com/termux/termux-language-server/releases)

[![github/downloads/latest](https://shields.io/github/downloads/termux/termux-language-server/latest/total)](https://github.com/termux/termux-language-server/releases/latest)

[![github/issues](https://shields.io/github/issues/termux/termux-language-server)](https://github.com/termux/termux-language-server/issues)

[![github/issues-closed](https://shields.io/github/issues-closed/termux/termux-language-server)](https://github.com/termux/termux-language-server/issues?q=is%3Aissue+is%3Aclosed)

[![github/issues-pr](https://shields.io/github/issues-pr/termux/termux-language-server)](https://github.com/termux/termux-language-server/pulls)

[![github/issues-pr-closed](https://shields.io/github/issues-pr-closed/termux/termux-language-server)](https://github.com/termux/termux-language-server/pulls?q=is%3Apr+is%3Aclosed)

[![github/discussions](https://shields.io/github/discussions/termux/termux-language-server)](https://github.com/termux/termux-language-server/discussions)

[![github/milestones](https://shields.io/github/milestones/all/termux/termux-language-server)](https://github.com/termux/termux-language-server/milestones)

[![github/forks](https://shields.io/github/forks/termux/termux-language-server)](https://github.com/termux/termux-language-server/network/members)

[![github/stars](https://shields.io/github/stars/termux/termux-language-server)](https://github.com/termux/termux-language-server/stargazers)

[![github/watchers](https://shields.io/github/watchers/termux/termux-language-server)](https://github.com/termux/termux-language-server/watchers)

[![github/contributors](https://shields.io/github/contributors/termux/termux-language-server)](https://github.com/termux/termux-language-server/graphs/contributors)

[![github/commit-activity](https://shields.io/github/commit-activity/w/termux/termux-language-server)](https://github.com/termux/termux-language-server/graphs/commit-activity)

[![github/last-commit](https://shields.io/github/last-commit/termux/termux-language-server)](https://github.com/termux/termux-language-server/commits)

[![github/release-date](https://shields.io/github/release-date/termux/termux-language-server)](https://github.com/termux/termux-language-server/releases/latest)

[![github/license](https://shields.io/github/license/termux/termux-language-server)](https://github.com/termux/termux-language-server/blob/main/LICENSE)

[![github/languages](https://shields.io/github/languages/count/termux/termux-language-server)](https://github.com/termux/termux-language-server)

[![github/languages/top](https://shields.io/github/languages/top/termux/termux-language-server)](https://github.com/termux/termux-language-server)

[![github/directory-file-count](https://shields.io/github/directory-file-count/termux/termux-language-server)](https://github.com/termux/termux-language-server)

[![github/code-size](https://shields.io/github/languages/code-size/termux/termux-language-server)](https://github.com/termux/termux-language-server)

[![github/repo-size](https://shields.io/github/repo-size/termux/termux-language-server)](https://github.com/termux/termux-language-server)

[![github/v](https://shields.io/github/v/release/termux/termux-language-server)](https://github.com/termux/termux-language-server)

[![pypi/status](https://shields.io/pypi/status/termux-language-server)](https://pypi.org/project/termux-language-server/#description)

[![pypi/v](https://shields.io/pypi/v/termux-language-server)](https://pypi.org/project/termux-language-server/#history)

[![pypi/downloads](https://shields.io/pypi/dd/termux-language-server)](https://pypi.org/project/termux-language-server/#files)

[![pypi/format](https://shields.io/pypi/format/termux-language-server)](https://pypi.org/project/termux-language-server/#files)

[![pypi/implementation](https://shields.io/pypi/implementation/termux-language-server)](https://pypi.org/project/termux-language-server/#files)

[![pypi/pyversions](https://shields.io/pypi/pyversions/termux-language-server)](https://pypi.org/project/termux-language-server/#files)

Language server for some specific bash scripts:

- Android [Termux](https://termux.dev)

  - [`build.sh`](https://github.com/termux/termux-packages/wiki/Creating-new-package)

  - [`*.subpackage.sh`](https://github.com/termux/termux-packages/wiki/Creating-new-package#writing-a-subpackage-script)

- [ArchLinux](https://archlinux.org)/Windows [Msys2](https://msys2.org)

  - [`PKGBUILD`](https://wiki.archlinux.org/title/PKGBUILD)

  - [`*.install`](https://wiki.archlinux.org/title/PKGBUILD#install)

  - [`makepkg.conf`](https://man.archlinux.org/man/makepkg.conf.5.en)

- [Gentoo](https://www.gentoo.org/)

  - [`*.ebuild`](https://dev.gentoo.org/~zmedico/portage/doc/man/ebuild.5.html)

  - `*.eclass`

  - [`make.conf`](https://dev.gentoo.org/~zmedico/portage/doc/man/make.conf.5.html)

  - [`color.map`](https://dev.gentoo.org/~zmedico/portage/doc/man/color.map.5.html)

- Debian/Ubuntu

  - [`devscripts.conf` and `.devscripts`](https://manpages.ubuntu.com/manpages/bionic/man5/devscripts.conf.5.html)

- zsh

  - [`*.mdd`](https://github.com/zsh-users/zsh/blob/57248b88830ce56adc243a40c7773fb3825cab34/Etc/zsh-development-guide#L285-L288)

This language server only provides extra features which

[bash-language-server](https://github.com/bash-lsp/bash-language-server)

doesn't support:

- [x] [Diagnostic](https://microsoft.github.io/language-server-protocol/specifications/specification-current#diagnostic):

  - [x] error

    - [x] required variables

    - [x] variable type: string/array/function

    - [x] variable values

  - [x] warning

    - [x] variable order

    - [x] unsorted values

    - [x] style check

      - [x] `PKGBUILD`: by [namcap](https://wiki.archlinux.org/title/Namcap)

- [x] [Document Formatting](https://microsoft.github.io/language-server-protocol/specifications/specification-current#textDocument_formatting):

  - [x] sort variables

  - [x] sort values

- [x] [Document Link](https://microsoft.github.io/language-server-protocol/specifications/specification-current#textDocument_documentLink):

  - [x] `build.sh`: 

  - [x] `PKGBUILD`:

    - [x] ArchLinux: 

    - [x] Windows Msys2: 

  - [ ] `ebuild`: 

- [x] [Hover](https://microsoft.github.io/language-server-protocol/specifications/specification-current#textDocument_hover)

- [x] [Completion](https://microsoft.github.io/language-server-protocol/specifications/specification-current#textDocument_completion)

  - [x] builtin variables

  - [x] package names

    - [ ] `build.sh`

    - [x] `PKGBUILD`: by [pyalpm](https://github.com/ornitorrincos/pyalpm)

    - [ ] `ebuild`

- [ ] [Code Action](https://microsoft.github.io/language-server-protocol/specifications/specification-current#textDocument_codeAction)

  - [ ] `PKGBUILD`

    - [ ] generate a template by the name of directory containing `PKGBUILD`, the

      templates comes from:

      - [ ] customized by user

      - [ ] [pip2pkgbuild](https://github.com/wenLiangcan/pip2pkgbuild)

      - [ ] [cpan2aur](https://metacpan.org/release/CPANPLUS-Dist-Arch)

      - [ ] [gem2arch](https://github.com/anatol/gem2arch)

      - [ ] [arch-hs](https://github.com/berberman/arch-hs)

    - [ ] update `.SRCINFO` by `makepkg --printsrcinfo > .SRCINFO`

    - [ ] update `pkgsums` by [`updpkgsums`](https://gitlab.archlinux.org/pacman/pacman-contrib)

    - [ ] update version by a `nvcheck.toml` to tell this

      program where to search new version:

```toml

[package_name]

source = "github"

github = "author_name/repo_name"

use_max_tag = true

```

Other features:

- [x] [pre-commit-hooks](https://pre-commit.com/)

  - [x] linter

  - [x] formatter

## Screenshots

### Diagnostic

![diagnostic](https://github.com/termux/termux-language-server/assets/32936898/598c371f-151d-442f-b782-e504a3d08872)

### Document Link

![document link](https://github.com/Freed-Wu/pkgbuild-language-server/assets/32936898/d3777f3c-9b75-41f9-b6b3-1c4ec55c7283)

### Hover

![keyword](https://github.com/Freed-Wu/requirements-language-server/assets/32936898/91bfde00-28f7-4376-8b7a-10a0bd56ba51)

![package](https://github.com/Freed-Wu/pkgbuild-language-server/assets/32936898/3d9fa906-35ea-4063-a9eb-06282d3e8596)

### Completion

![completion](https://github.com/Freed-Wu/pkgbuild-language-server/assets/32936898/c060690c-071b-41a0-bde5-dce338f4e779)

![arch](https://github.com/termux/termux-language-server/assets/32936898/e10b40c6-515e-4d50-9526-d32ea26b9238)

![license](https://github.com/termux/termux-language-server/assets/32936898/13109df3-30ba-4371-ad0a-aa7f46c8e80a)

![depends](https://github.com/termux/termux-language-server/assets/32936898/a70b41ae-cf4b-44cc-bb10-a54cb5488f30)

## How Does It Work

See [here](https://github.com/neomutt/lsp-tree-sitter#usage).

Read

[![readthedocs](https://shields.io/readthedocs/termux-language-server)](https://termux-language-server.readthedocs.io)

to know more.