From bfe0a56852a3ac6f1ae4ddf8f57a497fd2e61ffe Mon Sep 17 00:00:00 2001 From: "Wu, Zhenyu" Date: Thu, 7 Mar 2024 14:18:51 +0800 Subject: [PATCH] :wheelchair: Add template --- .pre-commit-config.yaml | 4 +- README.md | 169 +++++ copier.yml | 37 + template/.github/workflows/main.yml | 109 +++ template/.gitignore | 134 ++++ template/.gitlint | 5 + template/.pre-commit-config.yaml | 89 +++ template/.readthedocs.yaml | 15 + template/.yamllint.yaml | 8 + template/LICENSE | 674 ++++++++++++++++++ template/README.md | 53 ++ template/docs/api/{{ project }}.md | 7 + template/docs/conf.py | 64 ++ template/docs/index.md | 35 + template/docs/requirements.txt | 6 + template/docs/resources/configure.md | 131 ++++ template/docs/resources/install.md | 21 + template/docs/resources/requirements.md | 12 + template/pyproject.toml | 115 +++ template/requirements.txt | 4 + template/requirements/colorize.txt | 3 + template/requirements/dev.txt | 4 + template/requirements/misc.txt | 3 + template/src/{{ module }}/__init__.py | 14 + template/src/{{ module }}/__main__.py | 117 +++ template/src/{{ module }}/_shtab.py | 16 + .../assets/json/{{ language }}.json | 21 + .../{{ module }}/assets/queries/import.scm | 1 + template/src/{{ module }}/finders.py | 49 ++ template/src/{{ module }}/misc/__init__.py | 19 + .../src/{{ module }}/misc/{{ language }}.py | 32 + template/src/{{ module }}/py.typed | 0 template/src/{{ module }}/schema.py | 132 ++++ template/src/{{ module }}/server.py | 224 ++++++ template/src/{{ module }}/utils.py | 60 ++ template/templates/class.txt | 2 + template/templates/def.txt | 12 + template/templates/metainfo.py.j2 | 22 + template/templates/noarg.txt | 1 + template/tests/test_utils.py | 25 + 40 files changed, 2447 insertions(+), 2 deletions(-) create mode 100644 copier.yml create mode 100644 template/.github/workflows/main.yml create mode 100644 template/.gitignore create mode 100755 template/.gitlint create mode 100644 template/.pre-commit-config.yaml create mode 100644 template/.readthedocs.yaml create mode 100755 template/.yamllint.yaml create mode 100644 template/LICENSE create mode 100644 template/README.md create mode 100644 template/docs/api/{{ project }}.md create mode 100644 template/docs/conf.py create mode 100644 template/docs/index.md create mode 100755 template/docs/requirements.txt create mode 100644 template/docs/resources/configure.md create mode 100644 template/docs/resources/install.md create mode 100644 template/docs/resources/requirements.md create mode 100644 template/pyproject.toml create mode 100755 template/requirements.txt create mode 100755 template/requirements/colorize.txt create mode 100755 template/requirements/dev.txt create mode 100755 template/requirements/misc.txt create mode 100644 template/src/{{ module }}/__init__.py create mode 100644 template/src/{{ module }}/__main__.py create mode 100644 template/src/{{ module }}/_shtab.py create mode 100644 template/src/{{ module }}/assets/json/{{ language }}.json create mode 100644 template/src/{{ module }}/assets/queries/import.scm create mode 100644 template/src/{{ module }}/finders.py create mode 100644 template/src/{{ module }}/misc/__init__.py create mode 100644 template/src/{{ module }}/misc/{{ language }}.py create mode 100644 template/src/{{ module }}/py.typed create mode 100644 template/src/{{ module }}/schema.py create mode 100644 template/src/{{ module }}/server.py create mode 100644 template/src/{{ module }}/utils.py create mode 100644 template/templates/class.txt create mode 100644 template/templates/def.txt create mode 100644 template/templates/metainfo.py.j2 create mode 100644 template/templates/noarg.txt create mode 100644 template/tests/test_utils.py diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 617abd6..ccc2bfd 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,5 +1,5 @@ --- -exclude: (^templates/.*|.*\.json$) +exclude: ^template(s)?/ repos: - repo: https://github.com/pre-commit/pre-commit-hooks @@ -23,7 +23,7 @@ repos: - id: check-toml - id: check-json - repo: https://github.com/Lucas-C/pre-commit-hooks - rev: v1.5.4 + rev: v1.5.5 hooks: - id: remove-crlf - repo: https://github.com/codespell-project/codespell diff --git a/README.md b/README.md index eeee7b0..8d8ae88 100644 --- a/README.md +++ b/README.md @@ -205,8 +205,177 @@ mutt-language-server --generate-schema neomuttrc ![hover](https://github.com/neomutt/lsp-tree-sitter/assets/32936898/22a0347e-3d4f-45c5-833b-e89225ce3b74) +## Template + +This project provides a template for +[copier](https://github.com/copier-org/copier). + +For example, you want to create a language server for a filetype named +[`zathurarc`](https://pwmt.org/projects/zathura/documentation/). Please follow +the following steps: + +### Create a tree-sitter parser + +1. Create a tree-sitter-parser from [template](https://github.com/tree-sitter-grammars/template). +2. Publish it to PYPI + +You can see if +[py-tree-sitter-languages](https://github.com/grantjenks/py-tree-sitter-languages) +supports the language where you want to create a language server. + +### Copy a template + +```sh +$ copier copy gh:neomutt/lsp-tree-sitter /path/to/your/XXX-language-server +🎤 What is your language name? +zathurarc +🎤 What is your file patterns? split by " " +*.zathurarc zathurarc +🎤 What is your project name? +zathura-language-server +🎤 What is your Python module name? +zathura_language_server +🎤 What is your Python class name? +ZathuraLanguageServer +🎤 What is your tree-sitter parser name? +tree-sitter-zathurarc +🎤 What is your user name? +wzy + +Copying from template version None +create . +... +$ cd /path/to/your/XXX-language-server +$ tree . + . +├──  docs # documents +│ ├──  api +│ │ └──  zathura-language-server.md +│ ├──  conf.py +│ ├──  index.md +│ ├──  requirements.txt +│ └──  resources +│ ├──  configure.md +│ ├──  install.md +│ └──  requirements.md +├──  LICENSE +├──  pyproject.toml +├──  README.md +├──  requirements # optional dependencies +│ ├──  colorize.txt +│ ├──  dev.txt +│ └──  misc.txt +├──  requirements.txt +├──  src +│ └──  zathura_language_server +│ ├──  __init__.py +│ ├──  __main__.py +│ ├──  _shtab.py +│ ├──  assets +│ │ ├──  json # json schemas generated by misc/XXX.py +│ │ │ └──  zathurarc.json +│ │ └──  queries # tree-sitter queries +│ │ └──  import.scm +│ ├──  finders.py # project specific finders +│ ├──  misc +│ │ ├──  __init__.py +│ │ └──  zathurarc.py +│ ├──  py.typed +│ ├──  schema.py # project specific schemas +│ ├──  server.py # main file for server +│ └──  utils.py +├──  templates +│ ├──  class.txt +│ ├──  def.txt +│ ├──  metainfo.py.j2 +│ └──  noarg.txt +└──  tests +└──  test_utils.py +``` + +1. Edit `schema.py` to convert a tree-sitter's tree to a json, which is the + core function of `XXX-langauge-server --convert` +2. Edit a `misc/XXX.py` to generate json schemas, which is the core function of + `XXX-languageserver --generate-schema` +3. Edit `server.py` to make sure the LSP features can work for specific + tree-sitter parsers. +4. Edit `queries/XXX.scm` to make sure the LSP features can work for specific + tree-sitter parsers if you use them. +5. Edit `finders.py` to add the language specific finders for + `XXX-languageserver --check` and `XXX-languageserver --format` + +### Test if it can work + +```sh +$ git init +$ pip install -e . +$ which zathura-language-server +~/.local/bin/zathura-language-server +``` + +1. Refer `docs/resources/configure.md` to configure your language server for + your editor. +2. Refer `README.md` to see the LSP features provided by your language server. + +```sh +vi /path/to/zathurarc +``` + +You can test the LSP features. + +Refer to see how to publish the documents. + ## References +These following language servers can be a good example for beginners: + +### [zathura-language-server](https://github.com/Freed-Wu/zathura-language-server) + +`zathurarc`'s syntax only has 4 directives: + +- `set option value` +- `include /the/path` +- `map key function` +- `unmap key` + +Very few directives make creating +[tree-sitter-zathurarc](https://github.com/Freed-Wu/tree-sitter-zathurarc) and +editing `schema.py` very easy. So I am highly recommended starting from it. + +### [tmux-language-server](https://github.com/Freed-Wu/tmux-language-server) + +`tmux.conf` is more complex than `zathurarc`. It has not only +`set option = value` and `source /the/path`, but also 170+ other directives. + +### [mutt-language-server](https://github.com/neomutt/mutt-language-server) + +`muttrc` or `neomuttrc` has the following directives: + +- `set option = value` +- `source /the/path` +- 80+ other directives + +However, its `set` syntax is very flexible. The following syntaxes are legal: + +- `set option2 = value1 option2 = value2 ...` +- `set option`: a shortcut for `set option = yes` +- `set nooption`: a shortcut for `set option = no` +- `set invoption` +- `set nooption1 invoption2 option3 ...` +- ... + +So, in fact it is harder than `tmux.conf`, IMO. + +### [termux-language-server](https://github.com/termux/termux-language-server) + +`build.sh`, `PKGBUILD`, `*.ebuild` use same syntax of bash. However, they use +different json schemas. If the language where you want to create a language +server, you can refer it to know how to handle this situation. + +### Other references + +Some useful URLs for beginners who want to develop language servers: + - some [Chinese blogs](https://freed-wu.github.io/tag/lsp/) about how I write these language servers - [tree-sitter](https://tree-sitter.github.io/tree-sitter/) diff --git a/copier.yml b/copier.yml new file mode 100644 index 0000000..3113317 --- /dev/null +++ b/copier.yml @@ -0,0 +1,37 @@ +--- +_templates_suffix: "" +_answers_file: .copier-answers.yml +_subdirectory: template + +language: + type: str + help: What is your language name? + +patterns: + type: str + help: What is your file patterns? split by " " + default: "*.{{ language }}" + +project: + type: str + help: What is your project name? + default: "{{ language }}-language-server" + +module: + type: str + help: What is your Python module name? + default: "{{ project | replace('-', '_') }}" + +class: + type: str + help: What is your Python class name? + default: "{{ module | replace('_', ' ') | title | replace(' ', '') }}" + +parser: + type: str + help: What is your tree-sitter parser name? + default: "tree-sitter-{{ language }}" + +user: + type: str + help: What is your user name? diff --git a/template/.github/workflows/main.yml b/template/.github/workflows/main.yml new file mode 100644 index 0000000..5541811 --- /dev/null +++ b/template/.github/workflows/main.yml @@ -0,0 +1,109 @@ +--- +"on": + push: + paths-ignore: + - "**.md" + - docs/* + pull_request: + paths-ignore: + - "**.md" + - docs/* + workflow_dispatch: + +# https://github.com/softprops/action-gh-release/issues/236 +permissions: + contents: write + +env: + PYTHONUTF8: "1" + python-version: 3.x + cache: pip + +jobs: + test: + strategy: + fail-fast: false + matrix: + runs-on: + - ubuntu-latest + - macos-latest + - windows-latest + runs-on: $\{\{matrix.runs-on\}\} + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: $\{\{env.python-version\}\} + cache: $\{\{env.cache\}\} + cache-dependency-path: |- + requirements.txt + requirements/dev.txt + - name: Install dependencies + run: | + pip install -e '.[dev]' + - name: Test + run: | + pytest --cov + - uses: codecov/codecov-action@v3 + build: + needs: test + strategy: + fail-fast: false + matrix: + runs-on: + - ubuntu-latest + - macos-latest + - windows-latest + runs-on: $\{\{matrix.runs-on\}\} + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: $\{\{env.python-version\}\} + cache: $\{\{env.cache\}\} + cache-dependency-path: |- + requirements.txt + requirements/dev.txt + - name: Install dependencies + run: | + pip install build + - name: Build + run: | + pyproject-build + - uses: pypa/gh-action-pypi-publish@release/v1 + if: runner.os == 'Linux' && startsWith(github.ref, 'refs/tags/') + with: + password: $\{\{secrets.PYPI_API_TOKEN\}\} + - uses: actions/upload-artifact@v3 + if: runner.os == 'Linux' && ! startsWith(github.ref, 'refs/tags/') + with: + path: | + dist/* + - uses: softprops/action-gh-release@v1 + if: runner.os == 'Linux' && startsWith(github.ref, 'refs/tags/') + with: + # body_path: build/CHANGELOG.md + files: | + dist/* + + deploy-aur: + needs: build + runs-on: ubuntu-latest + if: startsWith(github.ref, 'refs/tags/') + steps: + - uses: {{ user }}/update-aur-package@v1.0.11 + with: + package_name: {{ project }} + ssh_private_key: $\{\{secrets.AUR_SSH_PRIVATE_KEY\}\} + + deploy-nur: + needs: build + runs-on: ubuntu-latest + if: startsWith(github.ref, 'refs/tags/') + steps: + - name: Trigger Workflow + run: > + curl -X POST -d '{"ref": "main"}' + -H "Accept: application/vnd.github.v3+json" + -H "Authorization: Bearer $\{\{secrets.GH_TOKEN\}\}" + https://api.github.com/repos/{{ user }}/nur-packages/actions/workflows/version.yml/dispatches diff --git a/template/.gitignore b/template/.gitignore new file mode 100644 index 0000000..2c7a6e1 --- /dev/null +++ b/template/.gitignore @@ -0,0 +1,134 @@ +/result +_version.py +_metainfo.py + +# create by https://github.com/iamcco/coc-gitignore (Sat Jun 17 2023 19:59:16 GMT+0800 (China Standard Time)) +# pydev.gitignore: +.pydevproject + +# create by https://github.com/iamcco/coc-gitignore (Sat Jun 17 2023 19:59:20 GMT+0800 (China Standard Time)) +# Python.gitignore: +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ diff --git a/template/.gitlint b/template/.gitlint new file mode 100755 index 0000000..89a3f32 --- /dev/null +++ b/template/.gitlint @@ -0,0 +1,5 @@ +#!/usr/bin/env -S gitlint -C +[ignore-by-title] +regex=.* +ignore=body-is-missing +# ex: filetype=dosini diff --git a/template/.pre-commit-config.yaml b/template/.pre-commit-config.yaml new file mode 100644 index 0000000..54bdff3 --- /dev/null +++ b/template/.pre-commit-config.yaml @@ -0,0 +1,89 @@ +--- +exclude: ^templates/.*|.*\.json$ + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: check-added-large-files + - id: fix-byte-order-marker + - id: check-case-conflict + - id: check-shebang-scripts-are-executable + - id: check-merge-conflict + - id: trailing-whitespace + - id: mixed-line-ending + - id: end-of-file-fixer + - id: detect-private-key + - id: check-symlinks + - id: check-ast + - id: debug-statements + - id: requirements-txt-fixer + - id: check-xml + - id: check-yaml + - id: check-toml + - id: check-json + - repo: https://github.com/Lucas-C/pre-commit-hooks + rev: v1.5.5 + hooks: + - id: remove-crlf + - repo: https://github.com/codespell-project/codespell + rev: v2.2.6 + hooks: + - id: codespell + additional_dependencies: + - tomli + - repo: https://github.com/jorisroovers/gitlint + rev: v0.19.1 + hooks: + - id: gitlint + args: + - --msg-filename + - repo: https://github.com/editorconfig-checker/editorconfig-checker.python + rev: 2.7.3 + hooks: + - id: editorconfig-checker + - repo: https://github.com/jumanjihouse/pre-commit-hooks + rev: 3.0.0 + hooks: + - id: check-mailmap + - repo: https://github.com/rhysd/actionlint + rev: v1.6.26 + hooks: + - id: actionlint + - repo: https://github.com/adrienverge/yamllint + rev: v1.35.1 + hooks: + - id: yamllint + - repo: https://github.com/executablebooks/mdformat + rev: 0.7.17 + hooks: + - id: mdformat + additional_dependencies: + - mdformat-pyproject + - mdformat-gfm + - mdformat-myst + - mdformat-toc + - mdformat-deflist + - mdformat-beautysh + - mdformat-ruff + - mdformat-config + - mdformat-web + - repo: https://github.com/DavidAnson/markdownlint-cli2 + rev: v0.12.1 + hooks: + - id: markdownlint-cli2 + additional_dependencies: + - markdown-it-texmath + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.2.1 + hooks: + - id: ruff + - id: ruff-format + - repo: https://github.com/kumaraditya303/mirrors-pyright + rev: v1.1.350 + hooks: + - id: pyright + +ci: + skip: + - pyright diff --git a/template/.readthedocs.yaml b/template/.readthedocs.yaml new file mode 100644 index 0000000..1da6547 --- /dev/null +++ b/template/.readthedocs.yaml @@ -0,0 +1,15 @@ +# https://docs.readthedocs.io/en/stable/config-file/v2.html +--- +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3" + +formats: + - htmlzip + +python: + install: + - requirements: docs/requirements.txt diff --git a/template/.yamllint.yaml b/template/.yamllint.yaml new file mode 100755 index 0000000..6c83761 --- /dev/null +++ b/template/.yamllint.yaml @@ -0,0 +1,8 @@ +#!/usr/bin/env -S yamllint -c +--- +extends: default + +rules: + comments: + # https://github.com/prettier/prettier/issues/6780 + min-spaces-from-content: 1 diff --git a/template/LICENSE b/template/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/template/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/template/README.md b/template/README.md new file mode 100644 index 0000000..10dec2e --- /dev/null +++ b/template/README.md @@ -0,0 +1,53 @@ +# {{ project }} + +[![readthedocs](https://shields.io/readthedocs/{{ project }})](https://{{ project }}.readthedocs.io) +[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/{{ user }}/{{ project }}/main.svg)](https://results.pre-commit.ci/latest/github/{{ user }}/{{ project }}/main) +[![github/workflow](https://github.com/{{ user }}/{{ project }}/actions/workflows/main.yml/badge.svg)](https://github.com/{{ user }}/{{ project }}/actions) +[![codecov](https://codecov.io/gh/{{ user }}/{{ project }}/branch/main/graph/badge.svg)](https://codecov.io/gh/{{ user }}/{{ project }}) +[![DeepSource](https://deepsource.io/gh/{{ user }}/{{ project }}.svg/?show_trend=true)](https://deepsource.io/gh/{{ user }}/{{ project }}) + +[![github/downloads](https://shields.io/github/downloads/{{ user }}/{{ project }}/total)](https://github.com/{{ user }}/{{ project }}/releases) +[![github/downloads/latest](https://shields.io/github/downloads/{{ user }}/{{ project }}/latest/total)](https://github.com/{{ user }}/{{ project }}/releases/latest) +[![github/issues](https://shields.io/github/issues/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/issues) +[![github/issues-closed](https://shields.io/github/issues-closed/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/issues?q=is%3Aissue+is%3Aclosed) +[![github/issues-pr](https://shields.io/github/issues-pr/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/pulls) +[![github/issues-pr-closed](https://shields.io/github/issues-pr-closed/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/pulls?q=is%3Apr+is%3Aclosed) +[![github/discussions](https://shields.io/github/discussions/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/discussions) +[![github/milestones](https://shields.io/github/milestones/all/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/milestones) +[![github/forks](https://shields.io/github/forks/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/network/members) +[![github/stars](https://shields.io/github/stars/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/stargazers) +[![github/watchers](https://shields.io/github/watchers/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/watchers) +[![github/contributors](https://shields.io/github/contributors/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/graphs/contributors) +[![github/commit-activity](https://shields.io/github/commit-activity/w/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/graphs/commit-activity) +[![github/last-commit](https://shields.io/github/last-commit/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/commits) +[![github/release-date](https://shields.io/github/release-date/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/releases/latest) + +[![github/license](https://shields.io/github/license/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}/blob/main/LICENSE) +[![github/languages](https://shields.io/github/languages/count/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}) +[![github/languages/top](https://shields.io/github/languages/top/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}) +[![github/directory-file-count](https://shields.io/github/directory-file-count/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}) +[![github/code-size](https://shields.io/github/languages/code-size/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}) +[![github/repo-size](https://shields.io/github/repo-size/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}) +[![github/v](https://shields.io/github/v/release/{{ user }}/{{ project }})](https://github.com/{{ user }}/{{ project }}) + +[![pypi/status](https://shields.io/pypi/status/{{ project }})](https://pypi.org/project/{{ project }}/#description) +[![pypi/v](https://shields.io/pypi/v/{{ project }})](https://pypi.org/project/{{ project }}/#history) +[![pypi/downloads](https://shields.io/pypi/dd/{{ project }})](https://pypi.org/project/{{ project }}/#files) +[![pypi/format](https://shields.io/pypi/format/{{ project }})](https://pypi.org/project/{{ project }}/#files) +[![pypi/implementation](https://shields.io/pypi/implementation/{{ project }})](https://pypi.org/project/{{ project }}/#files) +[![pypi/pyversions](https://shields.io/pypi/pyversions/{{ project }})](https://pypi.org/project/{{ project }}/#files) + +A language server for {{ language }}. + +- [x] [Document Link](https://microsoft.github.io/language-server-protocol/specifications/specification-current#textDocument_documentLink) +- [x] [Diagnostic](https://microsoft.github.io/language-server-protocol/specifications/specification-current#diagnostic) +- [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) + +## How Does It Work + +See [here](https://github.com/neomutt/lsp-tree-sitter#usage). + +See +[![readthedocs](https://shields.io/readthedocs/{{ project }})](https://{{ project }}.readthedocs.io) +to know more. diff --git a/template/docs/api/{{ project }}.md b/template/docs/api/{{ project }}.md new file mode 100644 index 0000000..6eac269 --- /dev/null +++ b/template/docs/api/{{ project }}.md @@ -0,0 +1,7 @@ +# {{ project }} + +```{autofile} ../../src/*/*.py +--- +module: +--- +``` diff --git a/template/docs/conf.py b/template/docs/conf.py new file mode 100644 index 0000000..d80d4f9 --- /dev/null +++ b/template/docs/conf.py @@ -0,0 +1,64 @@ +r"""Configure the Sphinx documentation builder. + +https://www.sphinx-doc.org/en/master/usage/configuration.html +""" + +from {{ module }} import __version__ as version # type: ignore +from {{ module }}._metainfo import ( # type: ignore + author, + copyright, + project, +) + +__all__ = ["version", "author", "copyright", "project"] + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. + +# -- Project information ----------------------------------------------------- +language = "en" +locale_dirs = ["locale"] +gettext_compact = False + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.githubpages", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", + "myst_parser", + "sphinxcontrib.autofile", + "sphinxcontrib.requirements_txt", +] + +myst_heading_anchors = 3 +myst_title_to_header = True +todo_include_todos = True + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +# html_static_path = ["_static"] diff --git a/template/docs/index.md b/template/docs/index.md new file mode 100644 index 0000000..54082cc --- /dev/null +++ b/template/docs/index.md @@ -0,0 +1,35 @@ + + +```{toctree} +--- +hidden: +glob: +caption: resources +--- +resources/* +``` + +```{toctree} +--- +hidden: +glob: +caption: API +--- +api/* +``` + +```{toctree} +--- +hidden: +caption: Index +--- +genindex +modindex +search +``` + +```{include} ../README.md +--- +relative-docs: docs +--- +``` diff --git a/template/docs/requirements.txt b/template/docs/requirements.txt new file mode 100755 index 0000000..dc36ad4 --- /dev/null +++ b/template/docs/requirements.txt @@ -0,0 +1,6 @@ +#!/usr/bin/env -S pip install -r + +-e . +myst-parser +sphinxcontrib-autofile +sphinxcontrib-requirements-txt diff --git a/template/docs/resources/configure.md b/template/docs/resources/configure.md new file mode 100644 index 0000000..7343c82 --- /dev/null +++ b/template/docs/resources/configure.md @@ -0,0 +1,131 @@ +# Configure + +- For windows, change `~/.config` to `~/AppData/Local` +- For macOS, change `~/.config` to `~/Library` + +## (Neo)[Vim](https://www.vim.org) + +For vim: + +- Change `~/.config/nvim` to `~/.vim` +- Change `init.vim` to `vimrc` + +### [coc.nvim](https://github.com/neoclide/coc.nvim) + +`~/.config/nvim/coc-settings.json`: + +```json +{ + "languageserver": { + "{{ language }}": { + "command": "{{ project }}", + "filetypes": [ + "{{ language }}" + ] + } + } +} +``` + +### [vim-lsp](https://github.com/prabirshrestha/vim-lsp) + +`~/.config/nvim/init.vim`: + +```vim +if executable('{{ project }}') + augroup lsp + autocmd! + autocmd User lsp_setup call lsp#register_server({ + \ 'name': '{{ language }}', + \ 'cmd': {server_info->['{{ project }}']}, + \ 'whitelist': ['{{ language }}'], + \ }) + augroup END +endif +``` + +## [Neovim](https://neovim.io) + +`~/.config/nvim/init.lua`: + +```lua +vim.api.nvim_create_autocmd({ "BufEnter" }, { + pattern = { "{{ language }}*" }, + callback = function() + vim.lsp.start({ + name = "{{ language }}", + cmd = { "{{ project }}" } + }) + end, +}) +``` + +## [Emacs](https://www.gnu.org/software/emacs) + +`~/.emacs.d/init.el`: + +```lisp +(make-lsp-client :new-connection +(lsp-stdio-connection + `(,(executable-find "{{ project }}"))) + :activation-fn (lsp-activate-on "{{ language }}*") + :server-id "{{ language }}"))) +``` + +## [Helix](https://helix-editor.com/) + +`~/.config/helix/languages.toml`: + +```toml +[[language]] +name = "{{ language }}" +language-servers = [ "{{ project }}",] + +[language_server.{{ project }}] +command = "{{ project }}" +``` + +## [KaKoune](https://kakoune.org/) + +### [kak-lsp](https://github.com/kak-lsp/kak-lsp) + +`~/.config/kak-lsp/kak-lsp.toml`: + +```toml +[language_server.{{ project }}] +filetypes = [ "{{ language }}",] +command = "{{ project }}" +``` + +## [Sublime](https://www.sublimetext.com) + +`~/.config/sublime-text-3/Packages/Preferences.sublime-settings`: + +```json +{ + "clients": { + "{{ language }}": { + "command": [ + "{{ project }}" + ], + "enabled": true, + "selector": "source.{{ language }}" + } + } +} +``` + +## [Visual Studio Code](https://code.visualstudio.com/) + +[An official support of generic LSP client is pending](https://github.com/microsoft/vscode/issues/137885). + +### [vscode-glspc](https://gitlab.com/ruilvo/vscode-glspc) + +`~/.config/Code/User/settings.json`: + +```json +{ + "glspc.serverPath": "{{ project }}", + "glspc.languageId": "{{ language }}" +} +``` diff --git a/template/docs/resources/install.md b/template/docs/resources/install.md new file mode 100644 index 0000000..9a12ca1 --- /dev/null +++ b/template/docs/resources/install.md @@ -0,0 +1,21 @@ +# Install + +## [AUR](https://aur.archlinux.org/packages/{{ project }}) + +```sh +paru -S {{ project }} +``` + +## [NUR](https://nur.nix-community.org/repos/{{ user }}) + +```sh +nix-env -iA nixos.nur.repos.{{ user }}.{{ project }} +``` + +## [PYPI](https://pypi.org/project/{{ project }}) + +```sh +pip install {{ project }} +``` + +See [requirements](requirements) to know `extra_requires`. diff --git a/template/docs/resources/requirements.md b/template/docs/resources/requirements.md new file mode 100644 index 0000000..1a5d436 --- /dev/null +++ b/template/docs/resources/requirements.md @@ -0,0 +1,12 @@ +# Requirements + +```{requirements} ../../requirements.txt +--- +title: Mandatory Requirements +--- +``` + +```{requirements} ../../requirements/*.txt +--- +--- +``` diff --git a/template/pyproject.toml b/template/pyproject.toml new file mode 100644 index 0000000..412498d --- /dev/null +++ b/template/pyproject.toml @@ -0,0 +1,115 @@ +[build-system] +requires = ["setuptools_scm[toml] >= 6.2", "setuptools-generate >= 0.0.6"] +build-backend = "setuptools.build_meta" + +# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html +[project] +name = "{{ project }}" +description = "language server for {{ language }}" +readme = "README.md" +# type_a | type_b +requires-python = ">= 3.10" +keywords = ["{{ language }}", "language server"] +classifiers = [ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Topic :: Software Development :: Build Tools", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Operating System :: Microsoft :: Windows", + "Operating System :: POSIX", + "Operating System :: Unix", + "Operating System :: MacOS", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: Implementation :: CPython", + "Programming Language :: Python :: Implementation :: PyPy", +] +dynamic = ["version", "dependencies", "optional-dependencies"] + +[[project.authors]] +name = "Wu Zhenyu" +email = "wuzhenyu@ustc.edu" + +[project.license] +text = "GPL v3" + +[project.urls] +Homepage = "https://{{ project }}.readthedocs.io" +Download = "https://github.com/{{ user }}/{{ project }}/releases" +"Bug Report" = "https://github.com/{{ user }}/{{ project }}/issues" +Source = "https://github.com/{{ user }}/{{ project }}" + +[project.scripts] +{{ project }} = "{{ module }}.__main__:main" + +[tool.setuptools.package-data] +{{ module }} = ["py.typed", "assets/**"] + +[tool.setuptools.data-files] +"share/man/man1" = ["sdist/{{ project }}.1"] +"share/bash-completion/completions" = ["sdist/{{ project }}"] +"share/zsh/site-functions" = ["sdist/_{{ project }}"] + +[tool.setuptools.dynamic.dependencies] +file = "requirements.txt" + +# begin: scripts/update-pyproject.toml.pl +[tool.setuptools.dynamic.optional-dependencies.colorize] +file = "requirements/colorize.txt" + +[tool.setuptools.dynamic.optional-dependencies.dev] +file = "requirements/dev.txt" + +[tool.setuptools.dynamic.optional-dependencies.misc] +file = "requirements/misc.txt" +# end: scripts/update-pyproject.toml.pl + +[tool.setuptools_scm] +write_to = "src/{{ module }}/_version.py" + +[tool.setuptools-generate] +write-to = "src/{{ module }}/_metainfo.py" + +[tool.setuptools-generate.metainfo-template] +file = "templates/metainfo.py.j2" + +[tool.mdformat] +number = true + +[tool.doq] +template_path = "templates" + +[tool.ruff] +line-length = 79 + +[tool.ruff.lint] +select = [ + # pycodestyle + "E", + # pyflakes + "F", + # pyupgrade + "UP", + # flake8-bugbear + "B", + # flake8-simplify + "SIM", + # isort + "I", +] +ignore = ["D205", "D400"] +preview = true + +[tool.ruff.format] +docstring-code-format = true +preview = true + +[tool.coverage.report] +exclude_lines = [ + "if TYPE_CHECKING:", + "if __name__ == .__main__.:", + "\\s*import tomli as tomllib", +] diff --git a/template/requirements.txt b/template/requirements.txt new file mode 100755 index 0000000..49b9cf9 --- /dev/null +++ b/template/requirements.txt @@ -0,0 +1,4 @@ +#!/usr/bin/env -S pip install -r + +lsp-tree-sitter +tree-sitter-{{ language }} diff --git a/template/requirements/colorize.txt b/template/requirements/colorize.txt new file mode 100755 index 0000000..b0dfd7e --- /dev/null +++ b/template/requirements/colorize.txt @@ -0,0 +1,3 @@ +#!/usr/bin/env -S pip install -r + +lsp-tree-sitter[colorize] diff --git a/template/requirements/dev.txt b/template/requirements/dev.txt new file mode 100755 index 0000000..e3a21f4 --- /dev/null +++ b/template/requirements/dev.txt @@ -0,0 +1,4 @@ +#!/usr/bin/env -S pip install -r +# For unit test and code coverage rate test. + +pytest-cov diff --git a/template/requirements/misc.txt b/template/requirements/misc.txt new file mode 100755 index 0000000..587d32d --- /dev/null +++ b/template/requirements/misc.txt @@ -0,0 +1,3 @@ +#!/usr/bin/env -S pip install -r + +lsp-tree-sitter[misc] diff --git a/template/src/{{ module }}/__init__.py b/template/src/{{ module }}/__init__.py new file mode 100644 index 0000000..c3c3a00 --- /dev/null +++ b/template/src/{{ module }}/__init__.py @@ -0,0 +1,14 @@ +r"""Provide ``__version__`` for +`importlib.metadata.version() `_. +""" + +from typing import Literal + +try: + from ._version import __version__, __version_tuple__ # type: ignore +except ImportError: # for setuptools-generate + __version__ = "rolling" + __version_tuple__ = (0, 0, 0, __version__, "") + +__all__ = ["__version__", "__version_tuple__"] +FILETYPE = Literal["{{ language }}"] diff --git a/template/src/{{ module }}/__main__.py b/template/src/{{ module }}/__main__.py new file mode 100644 index 0000000..b091ccf --- /dev/null +++ b/template/src/{{ module }}/__main__.py @@ -0,0 +1,117 @@ +r"""This module can be called by +`python -m `_. +""" + +from argparse import ArgumentParser, RawDescriptionHelpFormatter +from datetime import datetime + +from . import FILETYPE, __version__ +from . import __name__ as NAME + +try: + import shtab +except ImportError: + import _shtab as shtab + +NAME = NAME.replace("_", "-") +VERSION = rf"""{NAME} {__version__} +Copyright (C) {datetime.now().year} +Written by Wu Zhenyu +""" +EPILOG = """ +Report bugs to . +""" + + +def get_parser(): + r"""Get a parser for unit test.""" + parser = ArgumentParser( + epilog=EPILOG, + formatter_class=RawDescriptionHelpFormatter, + ) + shtab.add_argument_to(parser) + parser.add_argument("--version", version=VERSION, action="version") + parser.add_argument( + "--generate-schema", + choices=FILETYPE.__args__, # type: ignore + help="generate schema in an output format", + ) + parser.add_argument( + "--output-format", + choices=["json", "yaml", "toml"], + default="json", + help="output format: %(default)s", + ) + parser.add_argument( + "--indent", + type=int, + default=2, + help="generated json, yaml's indent, ignored by toml: %(default)s", + ) + parser.add_argument( + "--color", + choices=["auto", "always", "never"], + default="auto", + help="when to display color, default: %(default)s", + ) + parser.add_argument( + "--check", + nargs="*", + default={}, + help="check file's errors and warnings", + ).complete = shtab.FILE # type: ignore + parser.add_argument( + "--convert", + nargs="*", + default={}, + help="convert files to output format", + ).complete = shtab.FILE # type: ignore + return parser + + +def main() -> None: + r"""Parse arguments and provide shell completions.""" + args = get_parser().parse_args() + + if args.generate_schema or args.check or args.convert: + from lsp_tree_sitter.diagnose import check + from lsp_tree_sitter.utils import pprint + from tree_sitter_{{ language }} import parser + + from .finders import DIAGNOSTICS_FINDER_CLASSES + from .schema import {{ language | title }}Trie + + if args.generate_schema: + from .misc import get_schema + + kwargs = ( + {"indent": args.indent} if args.output_format != "toml" else {} + ) + pprint( + get_schema(args.generate_schema), + filetype=args.output_format, + **kwargs, + ) + for file in args.convert: + pprint( + {{ language | title }}Trie.from_file(file, parser.parse).to_json(), + filetype=args.output_format, + indent=args.indent, + ) + exit( + check( + args.check, + parser.parse, + DIAGNOSTICS_FINDER_CLASSES, + None, + args.color, + ) + ) + + from .server import {{ class }} + + {{ class }}(NAME, __version__).start_io() + + +if __name__ == "__main__": + main() diff --git a/template/src/{{ module }}/_shtab.py b/template/src/{{ module }}/_shtab.py new file mode 100644 index 0000000..8b15ce7 --- /dev/null +++ b/template/src/{{ module }}/_shtab.py @@ -0,0 +1,16 @@ +r"""Fake shtab +============== +""" + +from argparse import ArgumentParser +from typing import Any + +FILE = None +DIRECTORY = DIR = None + + +def add_argument_to(parser: ArgumentParser, *args: Any, **kwargs: Any): + from argparse import Action + + Action.complete = None # type: ignore + return parser diff --git a/template/src/{{ module }}/assets/json/{{ language }}.json b/template/src/{{ module }}/assets/json/{{ language }}.json new file mode 100644 index 0000000..08c66f9 --- /dev/null +++ b/template/src/{{ module }}/assets/json/{{ language }}.json @@ -0,0 +1,21 @@ +{ + "$id": "https://github.com/{{ user }}/{{ project }}/blob/main/src/termux_language_server/assets/json/{{ language }}.json", + "$schema": "http://json-schema.org/draft-07/schema#", + "$comment": "Don't edit this file directly! It is generated by `{{ project }} --generate-schema={{ language }}`.", + "type": "object", + "additionalProperties": false, + "properties": { + "set": { + "type": "object", + "description": "# Changing options", + "properties": { + }, + "additionalProperties": false + }, + "include": { + "type": "array", + "description": "# Including another config file", + "uniqueItems": true + } + } +} diff --git a/template/src/{{ module }}/assets/queries/import.scm b/template/src/{{ module }}/assets/queries/import.scm new file mode 100644 index 0000000..0a41813 --- /dev/null +++ b/template/src/{{ module }}/assets/queries/import.scm @@ -0,0 +1 @@ +(path) @path diff --git a/template/src/{{ module }}/finders.py b/template/src/{{ module }}/finders.py new file mode 100644 index 0000000..b2eb5bd --- /dev/null +++ b/template/src/{{ module }}/finders.py @@ -0,0 +1,49 @@ +r"""Finders +=========== +""" + +from dataclasses import dataclass + +from lsp_tree_sitter.finders import ErrorFinder, QueryFinder, SchemaFinder +from lsprotocol.types import DiagnosticSeverity + +from .schema import {{ language | title }}Trie +from .utils import get_query, get_schema + + +@dataclass(init=False) +class Import{{ language | title }}Finder(QueryFinder): + r"""Import{{ language | title }}Finder.""" + + def __init__( + self, + message: str = "\{\{uni.get_text()\}\}: error", + severity: DiagnosticSeverity = DiagnosticSeverity.Information, + ): + r"""Init. + + :param message: + :type message: str + :param severity: + :type severity: DiagnosticSeverity + """ + super().__init__(get_query("import"), message, severity) + + +@dataclass(init=False) +class {{ language | title }}Finder(SchemaFinder): + r"""{{ language | title }}finder.""" + + def __init__(self) -> None: + r"""Init. + + :rtype: None + """ + super().__init__(get_schema(), {{ language | title }}Trie) + + +DIAGNOSTICS_FINDER_CLASSES = [ + ErrorFinder, + {{ language | title }}Finder, +] +FORMAT_FINDER_CLASSES = [] diff --git a/template/src/{{ module }}/misc/__init__.py b/template/src/{{ module }}/misc/__init__.py new file mode 100644 index 0000000..0288964 --- /dev/null +++ b/template/src/{{ module }}/misc/__init__.py @@ -0,0 +1,19 @@ +r"""Misc +======== +""" + +from typing import Any + +from .. import FILETYPE + + +def get_schema(filetype: FILETYPE = "{{ language }}") -> dict[str, Any]: + r"""Get schema. + + :param filetype: + :type filetype: FILETYPE + :rtype: dict[str, Any] + """ + from .{{ language }} import init_schema + + return init_schema()[filetype] diff --git a/template/src/{{ module }}/misc/{{ language }}.py b/template/src/{{ module }}/misc/{{ language }}.py new file mode 100644 index 0000000..f26f85c --- /dev/null +++ b/template/src/{{ module }}/misc/{{ language }}.py @@ -0,0 +1,32 @@ +r"""{{ language | title }} +========================== +""" + +from typing import Any + +from .._metainfo import SOURCE, project + + +def init_schema() -> dict[str, Any]: + r"""Init schema. + + :rtype: dict[str, Any] + """ + filetype = "{{ language }}" + schemas = { + filetype: { + "$id": ( + f"{SOURCE}/blob/main/" + f"src/termux_language_server/assets/json/{filetype}.json" + ), + "$schema": "http://json-schema.org/draft-07/schema#", + "$comment": ( + "Don't edit this file directly! It is generated by " + f"`{project} --generate-schema={filetype}`." + ), + "type": "object", + "additionalProperties": False, + "properties": {}, + } + } + return schemas diff --git a/template/src/{{ module }}/py.typed b/template/src/{{ module }}/py.typed new file mode 100644 index 0000000..e69de29 diff --git a/template/src/{{ module }}/schema.py b/template/src/{{ module }}/schema.py new file mode 100644 index 0000000..224f2eb --- /dev/null +++ b/template/src/{{ module }}/schema.py @@ -0,0 +1,132 @@ +r"""Schema +========== +""" + +from dataclasses import dataclass + +from lsp_tree_sitter import UNI +from lsp_tree_sitter.schema import Trie +from lsprotocol.types import Position, Range +from tree_sitter import Node + +DIRECTIVES = { + "set_directive", + "map_directive", + "unmap_directive", + "include_directive", +} + + +@dataclass +class {{ language | title }}Trie(Trie): + r"""{{ language | title }} Trie.""" + + value: dict[str, "Trie"] | list["Trie"] | str | int | float | bool | None + + @classmethod + def from_node(cls, node: Node, parent: "Trie | None") -> "Trie": + r"""From node. + + :param node: + :type node: Node + :param parent: + :type parent: Trie | None + :rtype: "Trie" + """ + if node.type == "set_directive": + node = node.children[2] + _type = node.type + if _type == "int": + convert = int + elif _type == "float": + convert = float + elif _type == "bool": + + def convert(x): + return x == "true" + else: + + def convert(x): + return x.strip("'\"") + + text = UNI.node2text(node) + if text != "": + text = convert(text) + return cls(UNI.node2range(node), parent, text) + if node.type == "map_directive": + trie = cls(UNI.node2range(node), parent, {}) + key: Node = node.children[1] + if key.type == "mode": + key: Node = key.next_sibling # type: ignore + function: Node = key.next_sibling # type: ignore + argument = function.next_sibling + + value: dict[str, Trie] = trie.value # type: ignore + value["key"] = cls(UNI.node2range(key), trie, UNI.node2text(key)) # type: ignore + value["function"] = cls( + UNI.node2range(function), trie, UNI.node2text(function) + ) # type: ignore + if argument := function.next_sibling: + value["argument"] = cls( + UNI.node2range(argument), trie, UNI.node2text(argument) + ) # type: ignore + return trie + if node.type == "unmap_directive": + key = node.children[1] + if key.type == "mode": + key = key.next_sibling # type: ignore + return cls(UNI.node2range(key), parent, UNI.node2text(key)) + if node.type == "file": + trie = cls(Range(Position(0, 0), Position(1, 0)), parent, {}) + for directive in DIRECTIVES: + _type = directive.split("_")[0] + for child in node.children: + if child.type not in DIRECTIVES: + continue + _type = child.type.split("_")[0] + value: dict[str, Trie] = trie.value # type: ignore + if _type not in value: + trie.value[_type] = cls( # type: ignore + UNI.node2range(child), + trie, + {} if _type != "include" else [], + ) + subtrie: Trie = trie.value[child.type.split("_")[0]] # type: ignore + value: dict[str, Trie] | list[Trie] = subtrie.value # type: ignore + if child.type == "set_directive": + value: dict[str, Trie] + value[UNI.node2text(child.children[1])] = cls.from_node( + child, subtrie + ) + elif child.type == "include_directive": + value += [ # type: ignore + cls( + UNI.node2range(child.children[1]), + subtrie, + UNI.node2text(child.children[1]), + ) + ] + else: + mode = "normal" + if child.children[1].type == "mode": + mode = ( + UNI.node2text(child.children[1]) + .lstrip("[") + .rstrip("]") + ) + if mode not in value: + value[mode] = cls( + Range(Position(0, 0), Position(1, 0)), + subtrie, + [], + ) + if child.type == "unmap_directive": + value[mode].value += [ # type: ignore + cls.from_node(child, value[mode]) + ] + else: + value[mode].value += [ + cls.from_node(child, value[mode]) + ] # type: ignore + return trie + raise NotImplementedError(node.type) diff --git a/template/src/{{ module }}/server.py b/template/src/{{ module }}/server.py new file mode 100644 index 0000000..6c50bf9 --- /dev/null +++ b/template/src/{{ module }}/server.py @@ -0,0 +1,224 @@ +r"""Server +========== +""" + +from typing import Any + +from lsp_tree_sitter.complete import ( + get_completion_list_by_enum, + get_completion_list_by_uri, +) +from lsp_tree_sitter.diagnose import get_diagnostics +from lsp_tree_sitter.finders import PositionFinder +from lsprotocol.types import ( + TEXT_DOCUMENT_COMPLETION, + TEXT_DOCUMENT_DID_CHANGE, + TEXT_DOCUMENT_DID_OPEN, + TEXT_DOCUMENT_DOCUMENT_LINK, + TEXT_DOCUMENT_FORMATTING, + TEXT_DOCUMENT_HOVER, + CompletionItem, + CompletionItemKind, + CompletionList, + CompletionParams, + DidChangeTextDocumentParams, + DocumentFormattingParams, + DocumentLink, + DocumentLinkParams, + Hover, + MarkupContent, + MarkupKind, + TextDocumentPositionParams, + TextEdit, +) +from pygls.server import LanguageServer +from tree_sitter_{{ language }} import parser + +from .finders import DIAGNOSTICS_FINDER_CLASSES, FORMAT_FINDER_CLASSES, Import{{ language | title }}Finder +from .utils import get_schema + + +class {{ class }}(LanguageServer): + r"""{{ language }} language server.""" + + def __init__(self, *args: Any) -> None: + r"""Init. + + :param args: + :type args: Any + :rtype: None + """ + super().__init__(*args) + self.trees = {} + + @self.feature(TEXT_DOCUMENT_DID_OPEN) + @self.feature(TEXT_DOCUMENT_DID_CHANGE) + def did_change(params: DidChangeTextDocumentParams) -> None: + r"""Did change. + + :param params: + :type params: DidChangeTextDocumentParams + :rtype: None + """ + document = self.workspace.get_document(params.text_document.uri) + self.trees[document.uri] = parser.parse(document.source.encode()) + diagnostics = get_diagnostics( + document.uri, + self.trees[document.uri], + DIAGNOSTICS_FINDER_CLASSES, + "{{ language }}", + ) + self.publish_diagnostics(params.text_document.uri, diagnostics) + + @self.feature(TEXT_DOCUMENT_FORMATTING) + def format(params: DocumentFormattingParams) -> list[TextEdit]: + r"""Format. + + :param params: + :type params: DocumentFormattingParams + :rtype: list[TextEdit] + """ + filetype = get_filetype(params.text_document.uri) + if filetype == "": + return [] + document = self.workspace.get_document(params.text_document.uri) + return get_text_edits( + document.uri, + self.trees[document.uri], + FORMAT_FINDER_CLASSES, + filetype, + ) + + @self.feature(TEXT_DOCUMENT_DOCUMENT_LINK) + def document_link(params: DocumentLinkParams) -> list[DocumentLink]: + r"""Get document links. + + :param params: + :type params: DocumentLinkParams + :rtype: list[DocumentLink] + """ + document = self.workspace.get_document(params.text_document.uri) + return Import{{ language | title }}Finder().get_document_links( + document.uri, self.trees[document.uri] + ) + + @self.feature(TEXT_DOCUMENT_HOVER) + def hover(params: TextDocumentPositionParams) -> Hover | None: + r"""Hover. + + :param params: + :type params: TextDocumentPositionParams + :rtype: Hover | None + """ + document = self.workspace.get_document(params.text_document.uri) + uni = PositionFinder(params.position, right_equal=True).find( + document.uri, self.trees[document.uri] + ) + if uni is None: + return None + text = uni.get_text() + result = None + if uni.node.range.start_point[1] == 0: + result = get_schema()["properties"].get(text) + elif uni.node.type == "option": + result = get_schema()["properties"]["set"]["properties"].get( + text + ) + if result is None: + return None + return Hover( + MarkupContent(MarkupKind.Markdown, result["description"]), + uni.get_range(), + ) + + @self.feature(TEXT_DOCUMENT_COMPLETION) + def completions(params: CompletionParams) -> CompletionList: + r"""Completions. + + :param params: + :type params: CompletionParams + :rtype: CompletionList + """ + document = self.workspace.get_document(params.text_document.uri) + uni = PositionFinder(params.position, right_equal=True).find( + document.uri, self.trees[document.uri] + ) + if uni is None: + return CompletionList(False, []) + text = uni.get_text() + if uni.node.range.start_point[1] == 0: + return CompletionList( + False, + [ + CompletionItem( + x, + kind=CompletionItemKind.Keyword, + documentation=MarkupContent( + MarkupKind.Markdown, property["description"] + ), + insert_text=x, + ) + for x, property in get_schema()["properties"].items() + if x.startswith(text) + ], + ) + elif uni.node.type == "option": + return CompletionList( + False, + [ + CompletionItem( + x, + kind=CompletionItemKind.Variable, + documentation=MarkupContent( + MarkupKind.Markdown, property["description"] + ), + insert_text=x, + ) + for x, property in get_schema()["properties"]["set"][ + "properties" + ].items() + if x.startswith(text) + ], + ) + elif uni.node.type == "string": + node = uni.node.prev_sibling + if node is None: + return CompletionList(False, []) + property = get_schema()["properties"]["set"]["properties"].get( + uni.node2text(node), {} + ) + enum = property.get("enum", {}) + if property.get("type", "") == "boolean": + enum = {"true", "false"} + return CompletionList( + False, + [ + CompletionItem( + x, + kind=CompletionItemKind.Constant, + insert_text=x, + ) + for x in enum + if x.startswith(text) + ], + ) + elif uni.node.type == "mode_name": + return get_completion_list_by_enum( + text, + {"enum": get_schema()["properties"]["map"]["properties"]}, + ) + # FIXME: find key node will get None + elif uni.node.type in {"key", "function", "argument"}: + return get_completion_list_by_enum( + text, + get_schema()["properties"]["map"]["properties"]["normal"][ + "items" + ]["properties"][uni.node.type], + ) + elif uni.node.type == "path": + return get_completion_list_by_uri( + text, + document.uri, + {"{{ language }}*": "{{ language }}", "**/{{ language }}*": "{{ language }}"}, + ) + return CompletionList(False, []) diff --git a/template/src/{{ module }}/utils.py b/template/src/{{ module }}/utils.py new file mode 100644 index 0000000..2f8d9c6 --- /dev/null +++ b/template/src/{{ module }}/utils.py @@ -0,0 +1,60 @@ +r"""Utils +========= +""" + +import json +import os +from typing import Any + +from tree_sitter.binding import Query + +from . import FILETYPE + +SCHEMAS = {} +QUERIES = {} + + +def get_query(name: str, filetype: FILETYPE = "{{ language }}") -> Query: + r"""Get query. + + :param name: + :type name: str + :param filetype: + :type filetype: FILETYPE + :rtype: Query + """ + if name not in QUERIES: + with open( + os.path.join( + os.path.join( + os.path.join(os.path.dirname(__file__), "assets"), + "queries", + ), + f"{name}{os.path.extsep}scm", + ) + ) as f: + text = f.read() + from tree_sitter_{{ language }} import language + + QUERIES[name] = language.query(text) + return QUERIES[name] + + +def get_schema(filetype: FILETYPE = "{{ language }}") -> dict[str, Any]: + r"""Get schema. + + :param filetype: + :type filetype: FILETYPE + :rtype: dict[str, Any] + """ + if filetype not in SCHEMAS: + file = os.path.join( + os.path.join( + os.path.join(os.path.dirname(__file__), "assets"), + "json", + ), + f"{filetype}.json", + ) + with open(file) as f: + SCHEMAS[filetype] = json.load(f) + return SCHEMAS[filetype] diff --git a/template/templates/class.txt b/template/templates/class.txt new file mode 100644 index 0000000..7430de2 --- /dev/null +++ b/template/templates/class.txt @@ -0,0 +1,2 @@ +r"""\{\{ name.replace("_", " ").strip().capitalize() \}\}.""" + diff --git a/template/templates/def.txt b/template/templates/def.txt new file mode 100644 index 0000000..986caa2 --- /dev/null +++ b/template/templates/def.txt @@ -0,0 +1,12 @@ +r"""\{\{ name.replace("_", " ").strip().capitalize() \}\}. + +\{\% for p in params -\%\} +:param \{\{ p.argument \}\}: +\{\% if p.annotation -\%\} +:type \{\{ p.argument \}\}: \{\{ p.annotation.strip('"') \}\} +\{\% endif -\%\} +\{\% endfor -\%\} +\{\% if return_type -\%\} +:rtype: \{\{ return_type \}\} +\{\% endif -\%\} +""" diff --git a/template/templates/metainfo.py.j2 b/template/templates/metainfo.py.j2 new file mode 100644 index 0000000..22def23 --- /dev/null +++ b/template/templates/metainfo.py.j2 @@ -0,0 +1,22 @@ +"""This file is generated by setuptools-generate. +The information comes from pyproject.toml. +It provide some metainfo for docs/conf.py to build documents and +help2man to build man pages. +""" + +# For docs/conf.py +project = "\{\{ data['project']['name'] \}\}" +author = """\{\% for author in data['project']['authors'] -\%\} +\{\{ author['name'] \}\} <\{\{ author['email'] \}\}> \{\% endfor -\%\} +""" +copyright = "\{\{ year \}\}" + +# For help2man +DESCRIPTION = "\{\{ data['project']['description'] \}\}" +EPILOG = "Report bugs to \{\{ data['project']['urls']['Bug Report'] \}\}" +# format __version__ by yourself +VERSION = """\{\{ data['project']['name'] \}\} {__version__} +Copyright (C) \{\{ year \}\} +Written by \{\% for author in data['project']['authors'] -\%\} +\{\{ author['name'] \}\} <\{\{ author['email'] \}\}> \{\% endfor \%\}""" +SOURCE = "\{\{ data['project']['urls']['Source'] \}\}" diff --git a/template/templates/noarg.txt b/template/templates/noarg.txt new file mode 100644 index 0000000..a1c3375 --- /dev/null +++ b/template/templates/noarg.txt @@ -0,0 +1 @@ +r"""\{\{ name.replace("_", " ").strip().capitalize() \}\}.""" diff --git a/template/tests/test_utils.py b/template/tests/test_utils.py new file mode 100644 index 0000000..2e8c17e --- /dev/null +++ b/template/tests/test_utils.py @@ -0,0 +1,25 @@ +r"""Test utils.""" + +import os + +from tree_sitter_{{ language }} import parser +from {{ module }}.finders import Import{{ language | title }}Finder +from {{ module }}.utils import get_schema + + +class Test: + r"""Test.""" + + @staticmethod + def test_get_schema() -> None: + r"""Test get schema. + + :rtype: None + """ + assert len( + get_schema() + .get("properties", {}) + .get("set", {}) + .get("description", "") + .splitlines() + )