Add support for various debian source files (debian/{tests/control,control,copyright,watch,upstream/metadata}) (#5107)

* Add debian-lsp support for autopkgtest files

Add Language Server Protocol support for debian/tests/control files
using debian-lsp (https://github.com/jelmer/debian-lsp).

Vim detects these files as filetype 'autopkgtest' by default.

* Add debian-lsp support for debcontrol files

Add Language Server Protocol support for debian/control files using
debian-lsp (https://github.com/jelmer/debian-lsp).

debian-lsp provides diagnostics, completions, and code actions for
Debian package control files.

* Add debian-lsp support for debcopyright files

Add Language Server Protocol support for debian/copyright files using
debian-lsp (https://github.com/jelmer/debian-lsp).

* Add debian-lsp support for debchangelog files

Add Language Server Protocol support for debian/changelog files using
debian-lsp (https://github.com/jelmer/debian-lsp).

* Add debian-lsp support for debsources files

Add Language Server Protocol support for debian/source/format files
using debian-lsp (https://github.com/jelmer/debian-lsp).

* Add debian-lsp support for debupstream files

Add Language Server Protocol support for debian/upstream/metadata
files using debian-lsp (https://github.com/jelmer/debian-lsp).

Note: Vim does not detect debian/upstream/metadata files by default.
Users need to add filetype detection to their vimrc:

  autocmd BufNewFile,BufRead */debian/upstream/metadata setfiletype debupstream

* Add debian-lsp support for debwatch files

Add Language Server Protocol support for debian/watch files using
debian-lsp (https://github.com/jelmer/debian-lsp).

Note: Vim does not detect debian/watch files by default. Users need to
add filetype detection to their vimrc:

  autocmd BufNewFile,BufRead */debian/watch setfiletype debwatch

* Add debian-lsp to supported tools documentation

Update supported-tools.md, ale-supported-languages-and-tools.txt,
and ale.txt table of contents to include the new Debian filetype
linters (autopkgtest, debchangelog, debcontrol, debcopyright,
debsources, debupstream, debwatch).
This commit is contained in:
Jelmer Vernooij
2026-06-21 11:09:16 +09:00
committed by GitHub
parent 178fe11356
commit 44ff0049a7
31 changed files with 689 additions and 0 deletions
+43
View File
@@ -0,0 +1,43 @@
===============================================================================
ALE Autopkgtest Integration *ale-autopkgtest-options*
===============================================================================
debian-lsp *ale-autopkgtest-debian-lsp*
Website: https://github.com/jelmer/debian-lsp
debian-lsp is a Language Server Protocol implementation for Debian packaging
files. It supports debian/control, debian/copyright, debian/changelog,
debian/watch, debian/tests/control, debian/upstream/metadata, and
debian/source/format files with features including diagnostics, completions,
and code actions.
Installation
-------------------------------------------------------------------------------
debian-lsp can be installed via cargo: >
cargo install debian-lsp
<
Or from Debian repositories (if available): >
apt install debian-lsp
<
-------------------------------------------------------------------------------
Options
*ale-options.autopkgtest_debian_lsp_executable*
*g:ale_autopkgtest_debian_lsp_executable*
*b:ale_autopkgtest_debian_lsp_executable*
autopkgtest_debian_lsp_executable
g:ale_autopkgtest_debian_lsp_executable
Type: |String|
Default: `'debian-lsp'`
This variable can be set to change the path to debian-lsp.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+42
View File
@@ -0,0 +1,42 @@
===============================================================================
ALE Debian Changelog Integration *ale-debchangelog-options*
===============================================================================
debian-lsp *ale-debchangelog-debian-lsp*
Website: https://github.com/jelmer/debian-lsp
debian-lsp is a Language Server Protocol implementation for Debian packaging
files. It supports debian/control, debian/copyright, debian/changelog, and
debian/source/format files with features including diagnostics, completions,
and code actions.
Installation
-------------------------------------------------------------------------------
debian-lsp can be installed via cargo: >
cargo install debian-lsp
<
Or from Debian repositories (if available): >
apt install debian-lsp
<
-------------------------------------------------------------------------------
Options
*ale-options.debchangelog_debian_lsp_executable*
*g:ale_debchangelog_debian_lsp_executable*
*b:ale_debchangelog_debian_lsp_executable*
debchangelog_debian_lsp_executable
g:ale_debchangelog_debian_lsp_executable
Type: |String|
Default: `'debian-lsp'`
This variable can be set to change the path to debian-lsp.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+42
View File
@@ -0,0 +1,42 @@
===============================================================================
ALE Debian Control Integration *ale-debcontrol-options*
===============================================================================
debian-lsp *ale-debcontrol-debian-lsp*
Website: https://github.com/jelmer/debian-lsp
debian-lsp is a Language Server Protocol implementation for Debian packaging
files. It supports debian/control, debian/copyright, debian/changelog, and
debian/source/format files with features including diagnostics, completions,
and code actions.
Installation
-------------------------------------------------------------------------------
debian-lsp can be installed via cargo: >
cargo install debian-lsp
<
Or from Debian repositories (if available): >
apt install debian-lsp
<
-------------------------------------------------------------------------------
Options
*ale-options.debcontrol_debian_lsp_executable*
*g:ale_debcontrol_debian_lsp_executable*
*b:ale_debcontrol_debian_lsp_executable*
debcontrol_debian_lsp_executable
g:ale_debcontrol_debian_lsp_executable
Type: |String|
Default: `'debian-lsp'`
This variable can be set to change the path to debian-lsp.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+42
View File
@@ -0,0 +1,42 @@
===============================================================================
ALE Debian Copyright Integration *ale-debcopyright-options*
===============================================================================
debian-lsp *ale-debcopyright-debian-lsp*
Website: https://github.com/jelmer/debian-lsp
debian-lsp is a Language Server Protocol implementation for Debian packaging
files. It supports debian/control, debian/copyright, debian/changelog, and
debian/source/format files with features including diagnostics, completions,
and code actions.
Installation
-------------------------------------------------------------------------------
debian-lsp can be installed via cargo: >
cargo install debian-lsp
<
Or from Debian repositories (if available): >
apt install debian-lsp
<
-------------------------------------------------------------------------------
Options
*ale-options.debcopyright_debian_lsp_executable*
*g:ale_debcopyright_debian_lsp_executable*
*b:ale_debcopyright_debian_lsp_executable*
debcopyright_debian_lsp_executable
g:ale_debcopyright_debian_lsp_executable
Type: |String|
Default: `'debian-lsp'`
This variable can be set to change the path to debian-lsp.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+42
View File
@@ -0,0 +1,42 @@
===============================================================================
ALE Debian Sources Integration *ale-debsources-options*
===============================================================================
debian-lsp *ale-debsources-debian-lsp*
Website: https://github.com/jelmer/debian-lsp
debian-lsp is a Language Server Protocol implementation for Debian packaging
files. It supports debian/control, debian/copyright, debian/changelog, and
debian/source/format files with features including diagnostics, completions,
and code actions.
Installation
-------------------------------------------------------------------------------
debian-lsp can be installed via cargo: >
cargo install debian-lsp
<
Or from Debian repositories (if available): >
apt install debian-lsp
<
-------------------------------------------------------------------------------
Options
*ale-options.debsources_debian_lsp_executable*
*g:ale_debsources_debian_lsp_executable*
*b:ale_debsources_debian_lsp_executable*
debsources_debian_lsp_executable
g:ale_debsources_debian_lsp_executable
Type: |String|
Default: `'debian-lsp'`
This variable can be set to change the path to debian-lsp.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+52
View File
@@ -0,0 +1,52 @@
===============================================================================
ALE Debian Upstream Metadata Integration *ale-debupstream-options*
===============================================================================
debian-lsp *ale-debupstream-debian-lsp*
Website: https://github.com/jelmer/debian-lsp
debian-lsp is a Language Server Protocol implementation for Debian packaging
files. It supports debian/control, debian/copyright, debian/changelog,
debian/watch, debian/tests/control, debian/upstream/metadata, and
debian/source/format files with features including diagnostics, completions,
and code actions.
Installation
-------------------------------------------------------------------------------
debian-lsp can be installed via cargo: >
cargo install debian-lsp
<
Or from Debian repositories (if available): >
apt install debian-lsp
<
Filetype Detection
-------------------------------------------------------------------------------
Vim does not detect debian/upstream/metadata files by default. To enable
detection, add the following to your vimrc: >
autocmd BufNewFile,BufRead */debian/upstream/metadata setfiletype debupstream
<
-------------------------------------------------------------------------------
Options
*ale-options.debupstream_debian_lsp_executable*
*g:ale_debupstream_debian_lsp_executable*
*b:ale_debupstream_debian_lsp_executable*
debupstream_debian_lsp_executable
g:ale_debupstream_debian_lsp_executable
Type: |String|
Default: `'debian-lsp'`
This variable can be set to change the path to debian-lsp.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+51
View File
@@ -0,0 +1,51 @@
===============================================================================
ALE Debian Watch Integration *ale-debwatch-options*
===============================================================================
debian-lsp *ale-debwatch-debian-lsp*
Website: https://github.com/jelmer/debian-lsp
debian-lsp is a Language Server Protocol implementation for Debian packaging
files. It supports debian/control, debian/copyright, debian/changelog,
debian/watch, and debian/source/format files with features including
diagnostics, completions, and code actions.
Installation
-------------------------------------------------------------------------------
debian-lsp can be installed via cargo: >
cargo install debian-lsp
<
Or from Debian repositories (if available): >
apt install debian-lsp
<
Filetype Detection
-------------------------------------------------------------------------------
Vim does not detect debian/watch files by default. To enable detection, add
the following to your vimrc: >
autocmd BufNewFile,BufRead */debian/watch setfiletype debwatch
<
-------------------------------------------------------------------------------
Options
*ale-options.debwatch_debian_lsp_executable*
*g:ale_debwatch_debian_lsp_executable*
*b:ale_debwatch_debian_lsp_executable*
debwatch_debian_lsp_executable
g:ale_debwatch_debian_lsp_executable
Type: |String|
Default: `'debian-lsp'`
This variable can be set to change the path to debian-lsp.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+14
View File
@@ -41,6 +41,8 @@ Notes:
* Astro
* `eslint`
* `prettier`
* Autopkgtest (filetype autopkgtest)
* `debian-lsp`
* AVRA
* `avra`
* Awk
@@ -163,6 +165,18 @@ Notes:
* `dart-format`!!
* `dartfmt`!!
* `language_server`
* Debian Changelog (filetype debchangelog)
* `debian-lsp`
* Debian Control (filetype debcontrol)
* `debian-lsp`
* Debian Copyright (filetype debcopyright)
* `debian-lsp`
* Debian Sources (filetype debsources)
* `debian-lsp`
* Debian Upstream Metadata (filetype debupstream)
* `debian-lsp`
* Debian Watch (filetype debwatch)
* `debian-lsp`
* desktop
* `desktop-file-validate`
* Dhall
+14
View File
@@ -3436,6 +3436,8 @@ documented in additional help files.
astro...................................|ale-astro-options|
eslint................................|ale-astro-eslint|
prettier..............................|ale-astro-prettier|
autopkgtest.............................|ale-autopkgtest-options|
debian-lsp............................|ale-autopkgtest-debian-lsp|
avra....................................|ale-avra-options|
avra..................................|ale-avra-avra|
awk.....................................|ale-awk-options|
@@ -3530,6 +3532,18 @@ documented in additional help files.
dart-analyze..........................|ale-dart-analyze|
dart-format...........................|ale-dart-format|
dartfmt...............................|ale-dart-dartfmt|
debian changelog........................|ale-debchangelog-options|
debian-lsp............................|ale-debchangelog-debian-lsp|
debian control..........................|ale-debcontrol-options|
debian-lsp............................|ale-debcontrol-debian-lsp|
debian copyright........................|ale-debcopyright-options|
debian-lsp............................|ale-debcopyright-debian-lsp|
debian sources..........................|ale-debsources-options|
debian-lsp............................|ale-debsources-debian-lsp|
debian upstream metadata................|ale-debupstream-options|
debian-lsp............................|ale-debupstream-debian-lsp|
debian watch............................|ale-debwatch-options|
debian-lsp............................|ale-debwatch-debian-lsp|
desktop.................................|ale-desktop-options|
desktop-file-validate.................|ale-desktop-desktop-file-validate|
dhall...................................|ale-dhall-options|