├── .github ├── FUNDING.yml └── workflows │ └── main.yml ├── .gitignore ├── .gitlint ├── .pre-commit-config.yaml ├── .readthedocs.yaml ├── .yamllint.yaml ├── LICENSE ├── README.md ├── docs ├── api │ └── mutt-language-server.md ├── conf.py ├── index.md ├── requirements.txt └── resources │ ├── configure.md │ ├── install.md │ └── requirements.md ├── pyproject.toml ├── requirements.txt ├── requirements ├── colorize.txt ├── dev.txt └── misc.txt ├── src └── mutt_language_server │ ├── __init__.py │ ├── __main__.py │ ├── _shtab.py │ ├── assets │ ├── json │ │ └── neomuttrc.json │ └── queries │ │ └── import.scm │ ├── finders.py │ ├── misc │ └── __init__.py │ ├── py.typed │ ├── schema.py │ ├── server.py │ └── utils.py ├── templates ├── class.txt ├── def.txt ├── metainfo.py.j2 └── noarg.txt └── tests └── test_utils.py /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | --- 2 | custom: 3 | - "https://user-images.githubusercontent.com/32936898/199681341-1c5cfa61-4411-4b67-b268-7cd87c5867bb.png" 4 | - "https://user-images.githubusercontent.com/32936898/199681363-1094a0be-85ca-49cf-a410-19b3d7965120.png" 5 | - "https://user-images.githubusercontent.com/32936898/199681368-c34c2be7-e0d8-43ea-8c2c-d3e865da6aeb.png" 6 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | "on": 3 | push: 4 | paths-ignore: 5 | - "**.md" 6 | - docs/* 7 | pull_request: 8 | paths-ignore: 9 | - "**.md" 10 | - docs/* 11 | workflow_dispatch: 12 | 13 | # https://github.com/softprops/action-gh-release/issues/236 14 | permissions: 15 | contents: write 16 | 17 | env: 18 | PYTHONUTF8: "1" 19 | python-version: 3.x 20 | cache: pip 21 | 22 | jobs: 23 | test: 24 | strategy: 25 | fail-fast: false 26 | matrix: 27 | runs-on: 28 | - ubuntu-latest 29 | - macos-latest 30 | - windows-latest 31 | runs-on: ${{matrix.runs-on}} 32 | steps: 33 | - uses: actions/checkout@v3 34 | - uses: actions/setup-python@v4 35 | with: 36 | python-version: ${{env.python-version}} 37 | cache: ${{env.cache}} 38 | cache-dependency-path: |- 39 | requirements.txt 40 | requirements/dev.txt 41 | - name: Install dependencies 42 | run: | 43 | pip install -e '.[dev]' 44 | - name: Test 45 | run: | 46 | pytest --cov 47 | - uses: codecov/codecov-action@v3 48 | build: 49 | needs: test 50 | strategy: 51 | fail-fast: false 52 | matrix: 53 | runs-on: 54 | - ubuntu-latest 55 | - macos-latest 56 | - windows-latest 57 | runs-on: ${{matrix.runs-on}} 58 | steps: 59 | - uses: actions/checkout@v3 60 | - uses: actions/setup-python@v4 61 | with: 62 | python-version: ${{env.python-version}} 63 | cache: ${{env.cache}} 64 | cache-dependency-path: |- 65 | requirements.txt 66 | requirements/dev.txt 67 | - name: Install dependencies 68 | run: | 69 | pip install build 70 | - name: Build 71 | run: | 72 | pyproject-build 73 | - uses: pypa/gh-action-pypi-publish@release/v1 74 | if: runner.os == 'Linux' && startsWith(github.ref, 'refs/tags/') 75 | with: 76 | password: ${{secrets.PYPI_API_TOKEN}} 77 | - uses: actions/upload-artifact@v4 78 | if: runner.os == 'Linux' && ! startsWith(github.ref, 'refs/tags/') 79 | with: 80 | path: | 81 | dist/* 82 | - uses: softprops/action-gh-release@v1 83 | if: runner.os == 'Linux' && startsWith(github.ref, 'refs/tags/') 84 | with: 85 | # body_path: build/CHANGELOG.md 86 | files: | 87 | dist/* 88 | 89 | deploy-aur: 90 | needs: build 91 | runs-on: ubuntu-latest 92 | if: startsWith(github.ref, 'refs/tags/') 93 | steps: 94 | - uses: Freed-Wu/update-aur-package@v1.0.11 95 | with: 96 | package_name: mutt-language-server 97 | ssh_private_key: ${{secrets.AUR_SSH_PRIVATE_KEY}} 98 | 99 | deploy-nur: 100 | needs: build 101 | runs-on: ubuntu-latest 102 | if: startsWith(github.ref, 'refs/tags/') 103 | steps: 104 | - name: Trigger Workflow 105 | run: > 106 | curl -X POST -d '{"ref":"main"}' 107 | -H "Accept: application/vnd.github.v3+json" 108 | -H "Authorization: Bearer ${{ secrets.GH_TOKEN }}" 109 | https://api.github.com/repos/Freed-Wu/nur-packages/actions/workflows/version.yml/dispatches 110 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | _version.py 2 | _metainfo.py 3 | 4 | # create by https://github.com/iamcco/coc-gitignore (Sat Jun 17 2023 19:59:16 GMT+0800 (China Standard Time)) 5 | # pydev.gitignore: 6 | .pydevproject 7 | 8 | # create by https://github.com/iamcco/coc-gitignore (Sat Jun 17 2023 19:59:20 GMT+0800 (China Standard Time)) 9 | # Python.gitignore: 10 | # Byte-compiled / optimized / DLL files 11 | __pycache__/ 12 | *.py[cod] 13 | *$py.class 14 | 15 | # C extensions 16 | *.so 17 | 18 | # Distribution / packaging 19 | .Python 20 | build/ 21 | develop-eggs/ 22 | dist/ 23 | downloads/ 24 | eggs/ 25 | .eggs/ 26 | lib/ 27 | lib64/ 28 | parts/ 29 | sdist/ 30 | var/ 31 | wheels/ 32 | pip-wheel-metadata/ 33 | share/python-wheels/ 34 | *.egg-info/ 35 | .installed.cfg 36 | *.egg 37 | MANIFEST 38 | 39 | # PyInstaller 40 | # Usually these files are written by a python script from a template 41 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 42 | *.manifest 43 | *.spec 44 | 45 | # Installer logs 46 | pip-log.txt 47 | pip-delete-this-directory.txt 48 | 49 | # Unit test / coverage reports 50 | htmlcov/ 51 | .tox/ 52 | .nox/ 53 | .coverage 54 | .coverage.* 55 | .cache 56 | nosetests.xml 57 | coverage.xml 58 | *.cover 59 | .hypothesis/ 60 | .pytest_cache/ 61 | 62 | # Translations 63 | *.mo 64 | *.pot 65 | 66 | # Django stuff: 67 | *.log 68 | local_settings.py 69 | db.sqlite3 70 | db.sqlite3-journal 71 | 72 | # Flask stuff: 73 | instance/ 74 | .webassets-cache 75 | 76 | # Scrapy stuff: 77 | .scrapy 78 | 79 | # Sphinx documentation 80 | docs/_build/ 81 | 82 | # PyBuilder 83 | target/ 84 | 85 | # Jupyter Notebook 86 | .ipynb_checkpoints 87 | 88 | # IPython 89 | profile_default/ 90 | ipython_config.py 91 | 92 | # pyenv 93 | .python-version 94 | 95 | # pipenv 96 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 97 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 98 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 99 | # install all needed dependencies. 100 | #Pipfile.lock 101 | 102 | # celery beat schedule file 103 | celerybeat-schedule 104 | 105 | # SageMath parsed files 106 | *.sage.py 107 | 108 | # Environments 109 | .env 110 | .venv 111 | env/ 112 | venv/ 113 | ENV/ 114 | env.bak/ 115 | venv.bak/ 116 | 117 | # Spyder project settings 118 | .spyderproject 119 | .spyproject 120 | 121 | # Rope project settings 122 | .ropeproject 123 | 124 | # mkdocs documentation 125 | /site 126 | 127 | # mypy 128 | .mypy_cache/ 129 | .dmypy.json 130 | dmypy.json 131 | 132 | # Pyre type checker 133 | .pyre/ 134 | -------------------------------------------------------------------------------- /.gitlint: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env -S gitlint -C 2 | [ignore-by-title] 3 | regex=.* 4 | ignore=body-is-missing 5 | # ex: filetype=dosini 6 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | exclude: ^templates/|\.json$ 3 | 4 | repos: 5 | - repo: https://github.com/pre-commit/pre-commit-hooks 6 | rev: v5.0.0 7 | hooks: 8 | - id: check-added-large-files 9 | - id: fix-byte-order-marker 10 | - id: check-case-conflict 11 | - id: check-shebang-scripts-are-executable 12 | - id: check-merge-conflict 13 | - id: trailing-whitespace 14 | - id: mixed-line-ending 15 | - id: end-of-file-fixer 16 | - id: detect-private-key 17 | - id: check-symlinks 18 | - id: check-ast 19 | - id: debug-statements 20 | - id: requirements-txt-fixer 21 | - id: check-xml 22 | - id: check-yaml 23 | - id: check-toml 24 | - id: check-json 25 | - repo: https://github.com/Lucas-C/pre-commit-hooks 26 | rev: v1.5.5 27 | hooks: 28 | - id: remove-crlf 29 | - repo: https://github.com/codespell-project/codespell 30 | rev: v2.3.0 31 | hooks: 32 | - id: codespell 33 | additional_dependencies: 34 | - tomli 35 | - repo: https://github.com/jorisroovers/gitlint 36 | rev: v0.19.1 37 | hooks: 38 | - id: gitlint 39 | args: 40 | - --msg-filename 41 | - repo: https://github.com/editorconfig-checker/editorconfig-checker.python 42 | rev: 3.0.3 43 | hooks: 44 | - id: editorconfig-checker 45 | - repo: https://github.com/jumanjihouse/pre-commit-hooks 46 | rev: 3.0.0 47 | hooks: 48 | - id: check-mailmap 49 | - repo: https://github.com/rhysd/actionlint 50 | rev: v1.7.3 51 | hooks: 52 | - id: actionlint 53 | - repo: https://github.com/adrienverge/yamllint 54 | rev: v1.35.1 55 | hooks: 56 | - id: yamllint 57 | - repo: https://github.com/executablebooks/mdformat 58 | rev: 0.7.17 59 | hooks: 60 | - id: mdformat 61 | additional_dependencies: 62 | - mdformat-pyproject 63 | - mdformat-gfm 64 | - mdformat-myst 65 | - mdformat-toc 66 | - mdformat-deflist 67 | - mdformat-beautysh 68 | - mdformat-ruff 69 | - mdformat-config 70 | - mdformat-web 71 | - repo: https://github.com/DavidAnson/markdownlint-cli2 72 | rev: v0.14.0 73 | hooks: 74 | - id: markdownlint-cli2 75 | additional_dependencies: 76 | - markdown-it-texmath 77 | - repo: https://github.com/astral-sh/ruff-pre-commit 78 | rev: v0.6.9 79 | hooks: 80 | - id: ruff 81 | - id: ruff-format 82 | - repo: https://github.com/kumaraditya303/mirrors-pyright 83 | rev: v1.1.383 84 | hooks: 85 | - id: pyright 86 | 87 | ci: 88 | skip: 89 | - pyright 90 | -------------------------------------------------------------------------------- /.readthedocs.yaml: -------------------------------------------------------------------------------- 1 | # https://docs.readthedocs.io/en/stable/config-file/v2.html 2 | --- 3 | version: 2 4 | 5 | build: 6 | os: ubuntu-22.04 7 | tools: 8 | python: "3" 9 | 10 | formats: 11 | - htmlzip 12 | 13 | python: 14 | install: 15 | - requirements: docs/requirements.txt 16 | -------------------------------------------------------------------------------- /.yamllint.yaml: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env -S yamllint -c 2 | --- 3 | extends: default 4 | 5 | rules: 6 | comments: 7 | # https://github.com/prettier/prettier/issues/6780 8 | min-spaces-from-content: 1 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mutt-language-server 2 | 3 | [![readthedocs](https://shields.io/readthedocs/mutt-language-server)](https://mutt-language-server.readthedocs.io) 4 | [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/neomutt/mutt-language-server/main.svg)](https://results.pre-commit.ci/latest/github/neomutt/mutt-language-server/main) 5 | [![github/workflow](https://github.com/neomutt/mutt-language-server/actions/workflows/main.yml/badge.svg)](https://github.com/neomutt/mutt-language-server/actions) 6 | [![codecov](https://codecov.io/gh/neomutt/mutt-language-server/branch/main/graph/badge.svg)](https://codecov.io/gh/neomutt/mutt-language-server) 7 | [![DeepSource](https://deepsource.io/gh/neomutt/mutt-language-server.svg/?show_trend=true)](https://deepsource.io/gh/neomutt/mutt-language-server) 8 | 9 | [![github/downloads](https://shields.io/github/downloads/neomutt/mutt-language-server/total)](https://github.com/neomutt/mutt-language-server/releases) 10 | [![github/downloads/latest](https://shields.io/github/downloads/neomutt/mutt-language-server/latest/total)](https://github.com/neomutt/mutt-language-server/releases/latest) 11 | [![github/issues](https://shields.io/github/issues/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/issues) 12 | [![github/issues-closed](https://shields.io/github/issues-closed/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/issues?q=is%3Aissue+is%3Aclosed) 13 | [![github/issues-pr](https://shields.io/github/issues-pr/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/pulls) 14 | [![github/issues-pr-closed](https://shields.io/github/issues-pr-closed/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/pulls?q=is%3Apr+is%3Aclosed) 15 | [![github/discussions](https://shields.io/github/discussions/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/discussions) 16 | [![github/milestones](https://shields.io/github/milestones/all/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/milestones) 17 | [![github/forks](https://shields.io/github/forks/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/network/members) 18 | [![github/stars](https://shields.io/github/stars/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/stargazers) 19 | [![github/watchers](https://shields.io/github/watchers/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/watchers) 20 | [![github/contributors](https://shields.io/github/contributors/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/graphs/contributors) 21 | [![github/commit-activity](https://shields.io/github/commit-activity/w/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/graphs/commit-activity) 22 | [![github/last-commit](https://shields.io/github/last-commit/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/commits) 23 | [![github/release-date](https://shields.io/github/release-date/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/releases/latest) 24 | 25 | [![github/license](https://shields.io/github/license/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server/blob/main/LICENSE) 26 | [![github/languages](https://shields.io/github/languages/count/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server) 27 | [![github/languages/top](https://shields.io/github/languages/top/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server) 28 | [![github/directory-file-count](https://shields.io/github/directory-file-count/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server) 29 | [![github/code-size](https://shields.io/github/languages/code-size/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server) 30 | [![github/repo-size](https://shields.io/github/repo-size/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server) 31 | [![github/v](https://shields.io/github/v/release/neomutt/mutt-language-server)](https://github.com/neomutt/mutt-language-server) 32 | 33 | [![pypi/status](https://shields.io/pypi/status/mutt-language-server)](https://pypi.org/project/mutt-language-server/#description) 34 | [![pypi/v](https://shields.io/pypi/v/mutt-language-server)](https://pypi.org/project/mutt-language-server/#history) 35 | [![pypi/downloads](https://shields.io/pypi/dd/mutt-language-server)](https://pypi.org/project/mutt-language-server/#files) 36 | [![pypi/format](https://shields.io/pypi/format/mutt-language-server)](https://pypi.org/project/mutt-language-server/#files) 37 | [![pypi/implementation](https://shields.io/pypi/implementation/mutt-language-server)](https://pypi.org/project/mutt-language-server/#files) 38 | [![pypi/pyversions](https://shields.io/pypi/pyversions/mutt-language-server)](https://pypi.org/project/mutt-language-server/#files) 39 | 40 | A language server for (neo)mutt's muttrc. 41 | 42 | - [x] [Diagnostic](https://microsoft.github.io/language-server-protocol/specifications/specification-current#diagnostic) 43 | - [x] [Document Link](https://microsoft.github.io/language-server-protocol/specifications/specification-current#textDocument_documentLink) 44 | - [x] [Hover](https://microsoft.github.io/language-server-protocol/specifications/specification-current#textDocument_hover) 45 | - [x] [Completion](https://microsoft.github.io/language-server-protocol/specifications/specification-current#textDocument_completion) 46 | 47 | A screencast authored by @rbmarliere: 48 | 49 | [![asciicast](https://camo.githubusercontent.com/aa2be3ad710e855b3e6b7cd55f5261ac7582f1e69c8947f4619ba4c96f8cc506/68747470733a2f2f61736369696e656d612e6f72672f612f3631303634352e737667)](https://asciinema.org/a/610645) 50 | 51 | ![diagnostic](https://github.com/neomutt/mutt-language-server/assets/32936898/61c81c34-c5ae-4d66-82b2-2be5affb1162) 52 | 53 | ![document link](https://github.com/neomutt/mutt-language-server/assets/32936898/7db39120-401e-4be7-82c4-827609ab7f26) 54 | 55 | See 56 | [![readthedocs](https://shields.io/readthedocs/mutt-language-server)](https://mutt-language-server.readthedocs.io) 57 | to know more. 58 | 59 | ## How Does It Work 60 | 61 | See [here](https://github.com/neomutt/lsp-tree-sitter#usage). 62 | 63 | ## Related Projects 64 | 65 | - [neomutt.vim](https://github.com/neomutt/neomutt.vim): vim filetype plugin 66 | for neomuttrc 67 | -------------------------------------------------------------------------------- /docs/api/mutt-language-server.md: -------------------------------------------------------------------------------- 1 | # mutt-language-server 2 | 3 | ```{autofile} ../../src/*/*.py 4 | --- 5 | module: 6 | --- 7 | ``` 8 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | r"""Configure the Sphinx documentation builder. 2 | 3 | https://www.sphinx-doc.org/en/master/usage/configuration.html 4 | """ 5 | 6 | from mutt_language_server import __version__ as version # type: ignore 7 | from mutt_language_server._metainfo import ( # type: ignore 8 | author, 9 | copyright, 10 | project, 11 | ) 12 | 13 | __all__ = ["version", "author", "copyright", "project"] 14 | 15 | # -- Path setup -------------------------------------------------------------- 16 | 17 | # If extensions (or modules to document with autodoc) are in another directory, 18 | # add these directories to sys.path here. If the directory is relative to the 19 | # documentation root, use os.path.abspath to make it absolute, like shown here. 20 | 21 | # -- Project information ----------------------------------------------------- 22 | language = "en" 23 | locale_dirs = ["locale"] 24 | gettext_compact = False 25 | 26 | # -- General configuration --------------------------------------------------- 27 | 28 | # Add any Sphinx extension module names here, as strings. They can be 29 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 30 | # ones. 31 | extensions = [ 32 | "sphinx.ext.autodoc", 33 | "sphinx.ext.githubpages", 34 | "sphinx.ext.napoleon", 35 | "sphinx.ext.todo", 36 | "sphinx.ext.viewcode", 37 | "myst_parser", 38 | "sphinxcontrib.autofile", 39 | "sphinxcontrib.requirements_txt", 40 | ] 41 | 42 | myst_heading_anchors = 3 43 | myst_title_to_header = True 44 | todo_include_todos = True 45 | 46 | # Add any paths that contain templates here, relative to this directory. 47 | templates_path = ["_templates"] 48 | 49 | # List of patterns, relative to source directory, that match files and 50 | # directories to ignore when looking for source files. 51 | # This pattern also affects html_static_path and html_extra_path. 52 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] 53 | 54 | 55 | # -- Options for HTML output ------------------------------------------------- 56 | 57 | # The theme to use for HTML and HTML Help pages. See the documentation for 58 | # a list of builtin themes. 59 | # 60 | 61 | # Add any paths that contain custom static files (such as style sheets) here, 62 | # relative to this directory. They are copied after the builtin static files, 63 | # so a file named "default.css" will overwrite the builtin "default.css". 64 | # html_static_path = ["_static"] 65 | -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ```{toctree} 4 | --- 5 | hidden: 6 | glob: 7 | caption: resources 8 | --- 9 | resources/* 10 | ``` 11 | 12 | ```{toctree} 13 | --- 14 | hidden: 15 | glob: 16 | caption: API 17 | --- 18 | api/* 19 | ``` 20 | 21 | ```{toctree} 22 | --- 23 | hidden: 24 | caption: Index 25 | --- 26 | genindex 27 | modindex 28 | search 29 | ``` 30 | 31 | ```{include} ../README.md 32 | --- 33 | relative-docs: docs 34 | --- 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/requirements.txt: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env -S pip install -r 2 | 3 | -e . 4 | myst-parser 5 | sphinxcontrib-autofile 6 | sphinxcontrib-requirements-txt 7 | -------------------------------------------------------------------------------- /docs/resources/configure.md: -------------------------------------------------------------------------------- 1 | # Configure 2 | 3 | - For windows, change `~/.config` to `~/AppData/Local` 4 | - For macOS, change `~/.config` to `~/Library` 5 | 6 | ## (Neo)[Vim](https://www.vim.org) 7 | 8 | For vim: 9 | 10 | - Change `~/.config/nvim` to `~/.vim` 11 | - Change `init.vim` to `vimrc` 12 | 13 | ### [coc.nvim](https://github.com/neoclide/coc.nvim) 14 | 15 | `~/.config/nvim/coc-settings.json`: 16 | 17 | ```json 18 | { 19 | "languageserver": { 20 | "mutt": { 21 | "command": "mutt-language-server", 22 | "filetypes": [ 23 | "muttrc", 24 | "neomuttrc" 25 | ] 26 | } 27 | } 28 | } 29 | ``` 30 | 31 | ### [vim-lsp](https://github.com/prabirshrestha/vim-lsp) 32 | 33 | `~/.config/nvim/init.vim`: 34 | 35 | ```vim 36 | if executable('mutt-language-server') 37 | augroup lsp 38 | autocmd! 39 | autocmd User lsp_setup call lsp#register_server({ 40 | \ 'name': 'mutt', 41 | \ 'cmd': {server_info->['mutt-language-server']}, 42 | \ 'whitelist': ['muttrc', 'neomuttrc'], 43 | \ }) 44 | augroup END 45 | endif 46 | ``` 47 | 48 | ## [Neovim](https://neovim.io) 49 | 50 | `~/.config/nvim/init.lua`: 51 | 52 | ```lua 53 | vim.api.nvim_create_autocmd({ "BufEnter" }, { 54 | pattern = { "muttrc*", "neomuttrc" }, 55 | callback = function() 56 | vim.lsp.start({ 57 | name = "mutt", 58 | cmd = { "mutt-language-server" } 59 | }) 60 | end, 61 | }) 62 | ``` 63 | 64 | ## [Emacs](https://www.gnu.org/software/emacs) 65 | 66 | `~/.emacs.d/init.el`: 67 | 68 | ```lisp 69 | (make-lsp-client :new-connection 70 | (lsp-stdio-connection 71 | `(,(executable-find "mutt-language-server"))) 72 | :activation-fn (lsp-activate-on "muttrc" "neomuttrc") 73 | :server-id "mutt"))) 74 | ``` 75 | 76 | ## [Helix](https://helix-editor.com/) 77 | 78 | `~/.config/helix/languages.toml`: 79 | 80 | ```toml 81 | [[language]] 82 | name = "muttrc" 83 | language-servers = [ "mutt-language-server",] 84 | 85 | [[language]] 86 | name = "neomuttrc" 87 | language-servers = [ "mutt-language-server",] 88 | 89 | [language_server.mutt-language-server] 90 | command = "mutt-language-server" 91 | ``` 92 | 93 | ## [KaKoune](https://kakoune.org/) 94 | 95 | ### [kak-lsp](https://github.com/kak-lsp/kak-lsp) 96 | 97 | `~/.config/kak-lsp/kak-lsp.toml`: 98 | 99 | ```toml 100 | [language_server.mutt-language-server] 101 | filetypes = [ "muttrc", "neomuttrc",] 102 | command = "mutt-language-server" 103 | ``` 104 | 105 | ## [Sublime](https://www.sublimetext.com) 106 | 107 | `~/.config/sublime-text-3/Packages/Preferences.sublime-settings`: 108 | 109 | ```json 110 | { 111 | "clients": { 112 | "mutt": { 113 | "command": [ 114 | "mutt-language-server" 115 | ], 116 | "enabled": true, 117 | "selector": "source.muttrc" 118 | } 119 | } 120 | } 121 | ``` 122 | 123 | ## [Visual Studio Code](https://code.visualstudio.com/) 124 | 125 | [An official support of generic LSP client is pending](https://github.com/microsoft/vscode/issues/137885). 126 | 127 | ### [vscode-glspc](https://gitlab.com/ruilvo/vscode-glspc) 128 | 129 | `~/.config/Code/User/settings.json`: 130 | 131 | ```json 132 | { 133 | "glspc.serverPath": "mutt-language-server", 134 | "glspc.languageId": "muttrc" 135 | } 136 | ``` 137 | -------------------------------------------------------------------------------- /docs/resources/install.md: -------------------------------------------------------------------------------- 1 | # Install 2 | 3 | ## [AUR](https://aur.archlinux.org/packages/mutt-language-server) 4 | 5 | ```sh 6 | yay -S mutt-language-server 7 | ``` 8 | 9 | ## [NUR](https://nur.nix-community.org/repos/Freed-Wu) 10 | 11 | ```nix 12 | { config, pkgs, ... }: 13 | { 14 | nixpkgs.config.packageOverrides = pkgs: { 15 | nur = import 16 | ( 17 | builtins.fetchTarball 18 | "https://github.com/nix-community/NUR/archive/master.tar.gz" 19 | ) 20 | { 21 | inherit pkgs; 22 | }; 23 | }; 24 | environment.systemPackages = with pkgs; 25 | ( 26 | python3.withPackages ( 27 | p: with p; [ 28 | nur.repos.Freed-Wu.mutt-language-server 29 | ] 30 | ) 31 | ) 32 | } 33 | ``` 34 | 35 | ## [Nix](https://nixos.org) 36 | 37 | ```sh 38 | nix shell github:neomutt/mutt-language-server 39 | ``` 40 | 41 | Run without installation: 42 | 43 | ```sh 44 | nix run github:neomutt/mutt-language-server -- --help 45 | ``` 46 | 47 | ## [PYPI](https://pypi.org/project/mutt-language-server) 48 | 49 | ```sh 50 | pip install mutt-language-server 51 | ``` 52 | 53 | See [requirements](requirements) to know `extra_requires`. 54 | -------------------------------------------------------------------------------- /docs/resources/requirements.md: -------------------------------------------------------------------------------- 1 | # Requirements 2 | 3 | ```{requirements} ../../requirements.txt 4 | --- 5 | title: Mandatory Requirements 6 | --- 7 | ``` 8 | 9 | ```{requirements} ../../requirements/*.txt 10 | --- 11 | --- 12 | ``` 13 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools_scm[toml] >= 6.2", "setuptools-generate >= 0.0.6"] 3 | build-backend = "setuptools.build_meta" 4 | 5 | # https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html 6 | [project] 7 | name = "mutt-language-server" 8 | description = "mutt language server" 9 | readme = "README.md" 10 | # type_a | type_b 11 | requires-python = ">= 3.10" 12 | keywords = ["mutt", "language server"] 13 | classifiers = [ 14 | "Development Status :: 3 - Alpha", 15 | "Intended Audience :: Developers", 16 | "Topic :: Software Development :: Build Tools", 17 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 18 | "Operating System :: Microsoft :: Windows", 19 | "Operating System :: POSIX", 20 | "Operating System :: Unix", 21 | "Operating System :: MacOS", 22 | "Programming Language :: Python :: 3 :: Only", 23 | "Programming Language :: Python :: 3", 24 | "Programming Language :: Python :: 3.10", 25 | "Programming Language :: Python :: 3.11", 26 | "Programming Language :: Python :: 3.12", 27 | "Programming Language :: Python :: Implementation :: CPython", 28 | "Programming Language :: Python :: Implementation :: PyPy", 29 | ] 30 | dynamic = ["version", "dependencies", "optional-dependencies"] 31 | 32 | [[project.authors]] 33 | name = "Wu, Zhenyu" 34 | email = "wuzhenyu@ustc.edu" 35 | 36 | [project.license] 37 | text = "GPL v3" 38 | 39 | [project.urls] 40 | Homepage = "https://mutt-language-server.readthedocs.io" 41 | Download = "https://github.com/neomutt/mutt-language-server/releases" 42 | "Bug Report" = "https://github.com/neomutt/mutt-language-server/issues" 43 | Source = "https://github.com/neomutt/mutt-language-server" 44 | 45 | [project.scripts] 46 | mutt-language-server = "mutt_language_server.__main__:main" 47 | 48 | [tool.setuptools.package-data] 49 | mutt_language_server = ["py.typed", "assets/**"] 50 | 51 | [tool.setuptools.data-files] 52 | "share/man/man1" = ["sdist/mutt-language-server.1"] 53 | "share/bash-completion/completions" = ["sdist/mutt-language-server"] 54 | "share/zsh/site-functions" = ["sdist/_mutt-language-server"] 55 | 56 | [tool.setuptools.dynamic.dependencies] 57 | file = "requirements.txt" 58 | 59 | # begin: scripts/update-pyproject.toml.pl 60 | [tool.setuptools.dynamic.optional-dependencies.colorize] 61 | file = "requirements/colorize.txt" 62 | 63 | [tool.setuptools.dynamic.optional-dependencies.dev] 64 | file = "requirements/dev.txt" 65 | 66 | [tool.setuptools.dynamic.optional-dependencies.misc] 67 | file = "requirements/misc.txt" 68 | # end: scripts/update-pyproject.toml.pl 69 | 70 | [tool.setuptools_scm] 71 | write_to = "src/mutt_language_server/_version.py" 72 | 73 | [tool.setuptools-generate] 74 | write-to = "src/mutt_language_server/_metainfo.py" 75 | 76 | [tool.setuptools-generate.metainfo-template] 77 | file = "templates/metainfo.py.j2" 78 | 79 | [tool.mdformat] 80 | number = true 81 | 82 | [tool.doq] 83 | template_path = "templates" 84 | 85 | [tool.ruff] 86 | line-length = 79 87 | 88 | [tool.ruff.lint] 89 | select = [ 90 | # pycodestyle 91 | "E", 92 | # pyflakes 93 | "F", 94 | # pyupgrade 95 | "UP", 96 | # flake8-bugbear 97 | "B", 98 | # flake8-simplify 99 | "SIM", 100 | # isort 101 | "I", 102 | ] 103 | ignore = ["D205", "D400"] 104 | preview = true 105 | 106 | [tool.ruff.format] 107 | docstring-code-format = true 108 | preview = true 109 | 110 | [tool.coverage.report] 111 | exclude_lines = [ 112 | "if TYPE_CHECKING:", 113 | "if __name__ == .__main__.:", 114 | "\\s*import tomli as tomllib", 115 | ] 116 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env -S pip install -r 2 | 3 | lsp-tree-sitter 4 | tree-sitter-muttrc >= 0.0.4 5 | -------------------------------------------------------------------------------- /requirements/colorize.txt: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env -S pip install -r 2 | 3 | lsp-tree-sitter[colorize] 4 | -------------------------------------------------------------------------------- /requirements/dev.txt: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env -S pip install -r 2 | # For unit test and code coverage rate test. 3 | 4 | pytest-cov 5 | -------------------------------------------------------------------------------- /requirements/misc.txt: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env -S pip install -r 2 | 3 | lsp-tree-sitter[misc] 4 | -------------------------------------------------------------------------------- /src/mutt_language_server/__init__.py: -------------------------------------------------------------------------------- 1 | r"""Provide ``__version__`` for 2 | `importlib.metadata.version() `_. 3 | """ 4 | 5 | from typing import Literal 6 | 7 | try: 8 | from ._version import __version__, __version_tuple__ # type: ignore 9 | except ImportError: # for setuptools-generate 10 | __version__ = "rolling" 11 | __version_tuple__ = (0, 0, 0, __version__, "") 12 | 13 | __all__ = ["__version__", "__version_tuple__"] 14 | FILETYPE = Literal["neomuttrc"] 15 | -------------------------------------------------------------------------------- /src/mutt_language_server/__main__.py: -------------------------------------------------------------------------------- 1 | r"""This module can be called by 2 | `python -m `_. 3 | """ 4 | 5 | from argparse import ArgumentParser, RawDescriptionHelpFormatter 6 | from datetime import datetime 7 | 8 | from . import FILETYPE, __version__ 9 | from . import __name__ as NAME 10 | 11 | try: 12 | import shtab 13 | except ImportError: 14 | from . import _shtab as shtab 15 | 16 | NAME = NAME.replace("_", "-") 17 | VERSION = rf"""{NAME} {__version__} 18 | Copyright (C) {datetime.now().year} 19 | Written by Wu, Zhenyu 20 | """ 21 | EPILOG = """ 22 | Report bugs to . 23 | """ 24 | 25 | 26 | def get_parser() -> ArgumentParser: 27 | r"""Get a parser for unit test.""" 28 | parser = ArgumentParser( 29 | epilog=EPILOG, 30 | formatter_class=RawDescriptionHelpFormatter, 31 | ) 32 | shtab.add_argument_to(parser) 33 | parser.add_argument("--version", version=VERSION, action="version") 34 | parser.add_argument( 35 | "--generate-schema", 36 | choices=FILETYPE.__args__, # type: ignore 37 | help="generate schema in an output format", 38 | ) 39 | parser.add_argument( 40 | "--output-format", 41 | choices=["json", "yaml", "toml"], 42 | default="json", 43 | help="output format: %(default)s", 44 | ) 45 | parser.add_argument( 46 | "--indent", 47 | type=int, 48 | default=2, 49 | help="generated json, yaml's indent, ignored by toml: %(default)s", 50 | ) 51 | parser.add_argument( 52 | "--color", 53 | choices=["auto", "always", "never"], 54 | default="auto", 55 | help="when to display color, default: %(default)s", 56 | ) 57 | parser.add_argument( 58 | "--check", 59 | nargs="*", 60 | default={}, 61 | help="check file's errors and warnings", 62 | ).complete = shtab.FILE # type: ignore 63 | parser.add_argument( 64 | "--convert", 65 | nargs="*", 66 | default={}, 67 | help="convert files to output format", 68 | ).complete = shtab.FILE # type: ignore 69 | return parser 70 | 71 | 72 | def main() -> None: 73 | r"""Parse arguments and provide shell completions.""" 74 | args = get_parser().parse_args() 75 | 76 | if args.generate_schema or args.check or args.convert: 77 | from lsp_tree_sitter.diagnose import check 78 | from lsp_tree_sitter.utils import pprint 79 | 80 | from .finders import DIAGNOSTICS_FINDER_CLASSES 81 | from .schema import MuttTrie 82 | from .utils import parser 83 | 84 | if args.generate_schema: 85 | from .misc import get_schema 86 | 87 | kwargs = ( 88 | {"indent": args.indent} if args.output_format != "toml" else {} 89 | ) 90 | pprint( 91 | get_schema(args.generate_schema), 92 | filetype=args.output_format, 93 | **kwargs, 94 | ) 95 | for file in args.convert: 96 | pprint( 97 | MuttTrie.from_file(file, parser.parse).to_json(), 98 | filetype=args.output_format, 99 | indent=args.indent, 100 | ) 101 | exit( 102 | check( 103 | args.check, 104 | parser.parse, 105 | DIAGNOSTICS_FINDER_CLASSES, 106 | None, 107 | args.color, 108 | ) 109 | ) 110 | 111 | from .server import MuttLanguageServer 112 | 113 | MuttLanguageServer(NAME, __version__).start_io() 114 | 115 | 116 | if __name__ == "__main__": 117 | main() 118 | -------------------------------------------------------------------------------- /src/mutt_language_server/_shtab.py: -------------------------------------------------------------------------------- 1 | r"""Fake shtab 2 | ============== 3 | """ 4 | 5 | from argparse import ArgumentParser 6 | from typing import Any 7 | 8 | FILE = None 9 | DIRECTORY = DIR = None 10 | 11 | 12 | def add_argument_to(parser: ArgumentParser, *args: Any, **kwargs: Any): 13 | from argparse import Action 14 | 15 | Action.complete = None # type: ignore 16 | return parser 17 | -------------------------------------------------------------------------------- /src/mutt_language_server/assets/queries/import.scm: -------------------------------------------------------------------------------- 1 | (path) @path 2 | -------------------------------------------------------------------------------- /src/mutt_language_server/finders.py: -------------------------------------------------------------------------------- 1 | r"""Finders 2 | =========== 3 | """ 4 | 5 | from dataclasses import dataclass 6 | 7 | from lsp_tree_sitter.finders import ErrorFinder, QueryFinder, SchemaFinder 8 | from lsprotocol.types import DiagnosticSeverity 9 | 10 | from .schema import MuttTrie 11 | from .utils import get_query, get_schema 12 | 13 | 14 | @dataclass(init=False) 15 | class ImportMuttFinder(QueryFinder): 16 | r"""Import mutt finder.""" 17 | 18 | def __init__( 19 | self, 20 | message: str = "{{uni.get_text()}}: found", 21 | severity: DiagnosticSeverity = DiagnosticSeverity.Information, 22 | ): 23 | r"""Init. 24 | 25 | :param message: 26 | :type message: str 27 | :param severity: 28 | :type severity: DiagnosticSeverity 29 | """ 30 | query = get_query("import") 31 | super().__init__(query, message, severity) 32 | 33 | 34 | @dataclass(init=False) 35 | class MuttFinder(SchemaFinder): 36 | r"""Muttfinder.""" 37 | 38 | def __init__(self) -> None: 39 | r"""Init. 40 | 41 | :rtype: None 42 | """ 43 | self.validator = self.schema2validator(get_schema()) 44 | self.cls = MuttTrie 45 | 46 | 47 | DIAGNOSTICS_FINDER_CLASSES = [ 48 | ErrorFinder, 49 | MuttFinder, 50 | ] 51 | -------------------------------------------------------------------------------- /src/mutt_language_server/misc/__init__.py: -------------------------------------------------------------------------------- 1 | r"""Misc 2 | ======== 3 | """ 4 | 5 | import re 6 | from typing import Any 7 | 8 | from lsp_tree_sitter.misc import get_md_tokens 9 | 10 | from .. import FILETYPE 11 | from .._metainfo import SOURCE, project 12 | 13 | 14 | def get_schema(filetype: FILETYPE = "neomuttrc") -> dict[str, Any]: 15 | r"""Get schema. 16 | 17 | :rtype: dict[str, Any] 18 | """ 19 | filetype = "neomuttrc" 20 | schema = { 21 | "$id": ( 22 | f"{SOURCE}/blob/main/src/" 23 | f"termux_language_server/assets/json/{filetype}.json" 24 | ), 25 | "$schema": "http://json-schema.org/draft-07/schema#", 26 | "$comment": ( 27 | "Don't edit this file directly! It is generated by " 28 | f"`{project} --generate-schema={filetype}`." 29 | ), 30 | "type": "object", 31 | "properties": {}, 32 | } 33 | tokens = get_md_tokens("neomuttrc") 34 | indices = [] 35 | end_index = len(tokens) 36 | for i, token in enumerate(tokens): 37 | if token.content == "PATTERNS": 38 | end_index = i 39 | break 40 | if ( 41 | token.type == "code_block" 42 | and token.content.islower() 43 | or token.type == "inline" 44 | and token.content.startswith("**") 45 | and token.content.endswith("*") 46 | ): 47 | indices += [i] 48 | for i, index in enumerate(indices): 49 | keywords = [ 50 | line.split()[0].strip("*") 51 | for line in tokens[index].content.splitlines() 52 | ] 53 | for keyword in keywords: 54 | schema["properties"][keyword] = { 55 | "description": f"""```neomuttrc 56 | {tokens[index].content.strip()} 57 | ``` 58 | """ 59 | } 60 | index2 = end_index if len(indices) - 1 == i else indices[i + 1] 61 | for token in tokens[index + 1 : index2]: 62 | if token.content != "" and not token.content.startswith("