Skip to content

Commit 3ce66bc

Browse files
mochaaPgithub-actions[bot]
authored andcommitted
chore: Auto generate docs
1 parent 4e54e67 commit 3ce66bc

File tree

5 files changed

+30
-40
lines changed

5 files changed

+30
-40
lines changed

doc/BUILTINS.md

Lines changed: 18 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -473,12 +473,10 @@ local sources = {
473473
- Checkstyle only offers a jar file as download. It is recommended to put an executable wrapper script in
474474
your path.
475475
Example wrapper script:
476-
477476
```bash
478477
#!/usr/bin/env bash
479478
java -jar path/to/checkstyle.jar "$@"
480479
```
481-
482480
- Checkstyle needs a mandatory `-c` argument. Use `extra_args` to add yours. `extra_args` can also be a
483481
function to build more sophisticated logic.
484482

@@ -503,16 +501,14 @@ local sources = { null_ls.builtins.diagnostics.clazy }
503501

504502
- `clazy` needs a compilation database (`compile_commands.json`) to work. By default `clazy` will search for a compilation database in all parent folders of the input file.
505503
- If the compilation database is not in a parent folder, the `-p` option can be used to point to the corresponding folder (e.g. the projects build directory):
506-
507504
```lua
508505
local sources = {
509506
null_ls.builtins.diagnostics.clazy.with({
510507
extra_args = { "-p=$ROOT/build" },
511508
}),
512509
}
513510
```
514-
515-
- Alternatively, `compile_commands.json` can be linked into the project's root directory. For more information see <https://clang.llvm.org/docs/HowToSetupToolingForLLVM.html>
511+
- Alternatively, `compile_commands.json` can be linked into the project's root directory. For more information see https://clang.llvm.org/docs/HowToSetupToolingForLLVM.html
516512
- `clazy` will be run only when files are saved to disk, so that `compile_commands.json` can be used.
517513

518514
### [clj_kondo](https://github.com/clj-kondo/clj-kondo)
@@ -890,6 +886,23 @@ local sources = { null_ls.builtins.diagnostics.ktlint }
890886
- Command: `ktlint`
891887
- Args: `{ "--relative", "--reporter=json", "--log-level=none", "**/*.kt", "**/*.kts" }`
892888

889+
### [kube_linter](https://github.com/stackrox/kube-linter)
890+
891+
KubeLinter is a static analysis tool that checks Kubernetes YAML files and Helm charts to ensure the applications represented in them adhere to best practices.
892+
893+
#### Usage
894+
895+
```lua
896+
local sources = { null_ls.builtins.diagnostics.kube_linter }
897+
```
898+
899+
#### Defaults
900+
901+
- Filetypes: `{ "helm", "yaml" }`
902+
- Method: `diagnostics`
903+
- Command: `kube-linter`
904+
- Args: `{ "lint", "--format", "json", "$ROOT" }`
905+
893906
### [ltrs](https://github.com/jeertmans/languagetool-rust)
894907

895908
LanguageTool-Rust (LTRS) is both an executable and a Rust library that aims to provide correct and safe bindings for the LanguageTool API.
@@ -1169,12 +1182,10 @@ local sources = {
11691182
- PMD only offers parameterized wrapper scripts as download. It is recommended to put an executable wrapper
11701183
script in your path.
11711184
Example wrapper script:
1172-
11731185
```bash
11741186
#!/usr/bin/env bash
11751187
path/to/pmd/bin/run.sh pmd "$@"
11761188
```
1177-
11781189
- PMD needs a mandatory `--rulesets`/`-rulesets`/`-R` argument. Use `extra_args` to add yours. `extra_args`
11791190
can also be a function to build more sophisticated logic.
11801191

@@ -2099,35 +2110,27 @@ local sources = { null_ls.builtins.formatting.blackd }
20992110
##### `hostname` (string)
21002111

21012112
Address to bind the server to. Defaults to localhost.
2102-
21032113
##### `port` (string)
21042114

21052115
Port to listen on. Defaults to 45484.
2106-
21072116
##### `line_length` (number)
21082117

21092118
Set how many characters per line to allow. Defaults to 88.
2110-
21112119
##### `skip_source_first_line` (boolean)
21122120

21132121
If set to true, the first line of the source code will be ignored. Defaults to false.
2114-
21152122
##### `skip_string_normalization` (boolean)
21162123

21172124
If set to true, no string normalization will be performed. Defaults to false.
2118-
21192125
##### `skip_magic_trailing_comma` (boolean)
21202126

21212127
If set to true, trailing commas will not be used as a reason to split lines. Defaults to false.
2122-
21232128
##### `preview` (boolean)
21242129

21252130
If set to true, experimental and potentially disruptive style changes will be used. Defaults to false.
2126-
21272131
##### `fast` (boolean)
21282132

21292133
If set to true, Black will not perform an AST safety check after formatting. Defaults to false.
2130-
21312134
##### `python_variant` (string)
21322135

21332136
If set to pyi, Black will format all input files like typing stubs regardless of the file extension. Otherwise, its value must correspond to a Python version or a set of comma-separated Python versions, optionally prefixed with py. (e.g. py3.5,py3.6). Defaults to empty string.
@@ -2978,7 +2981,6 @@ local sources = { null_ls.builtins.formatting.isortd }
29782981
##### `hostname` (string)
29792982

29802983
Address that the isortd server listens on. Defaults to localhost.
2981-
29822984
##### `port` (string)
29832985

29842986
Port that the isortd server listens on. Defaults to 47393.
@@ -3017,24 +3019,6 @@ local sources = { null_ls.builtins.formatting.just }
30173019
- Command: `just`
30183020
- Args: `{ "--fmt", "--unstable", "-f", "$FILENAME" }`
30193021

3020-
### [kube-linter](https://github.com/stackrox/kube-linter)
3021-
3022-
KubeLinter is a static analysis tool that checks Kubernetes YAML files and Helm charts to ensure
3023-
the applications represented in them adhere to best practices.
3024-
3025-
#### Usage
3026-
3027-
```lua
3028-
local sources = { null_ls.builtins.diagnostics.kube_linter }
3029-
```
3030-
3031-
#### Defaults
3032-
3033-
- Filetypes: `{ "helm", "yaml" }`
3034-
- Method: `diagnostics`
3035-
- Command: `kube-linter`
3036-
- Args: `{ "lint", "--format", "json" "$ROOT" }`
3037-
30383022
### [ktlint](https://ktlint.github.io/)
30393023

30403024
An anti-bikeshedding Kotlin linter with built-in formatter.

doc/builtins.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,12 @@
232232
"kotlin"
233233
]
234234
},
235+
"kube_linter": {
236+
"filetypes": [
237+
"helm",
238+
"yaml"
239+
]
240+
},
235241
"ltrs": {
236242
"filetypes": [
237243
"text",

doc/null-ls.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*null-ls.txt* Last change: 2025 July 23
1+
*null-ls.txt* Last change: 2025 July 25
22

33
==============================================================================
44
Table of Contents *null-ls-table-of-contents*

lua/null-ls/builtins/_meta/diagnostics.lua

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,12 @@ return {
9494
haml_lint = {
9595
filetypes = { "haml" }
9696
},
97-
kube_linter = {
98-
filetypes = { "helm", "yaml" }
99-
},
10097
ktlint = {
10198
filetypes = { "kotlin" }
10299
},
100+
kube_linter = {
101+
filetypes = { "helm", "yaml" }
102+
},
103103
ltrs = {
104104
filetypes = { "text", "markdown", "markdown" }
105105
},

lua/null-ls/builtins/_meta/filetype_map.lua

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ return {
208208
formatting = { "atlas_fmt", "hclfmt", "packer", "terragrunt_fmt" }
209209
},
210210
helm = {
211-
diagnostics = { "trivy", "kube_linter" },
211+
diagnostics = { "kube_linter", "trivy" }
212212
},
213213
html = {
214214
diagnostics = { "markuplint", "tidy" },
@@ -497,7 +497,7 @@ return {
497497
formatting = { "tidy", "xmllint" }
498498
},
499499
yaml = {
500-
diagnostics = { "actionlint", "cfn_lint", "spectral", "vacuum", "yamllint", "kube_linter" },
500+
diagnostics = { "actionlint", "cfn_lint", "kube_linter", "spectral", "vacuum", "yamllint" },
501501
formatting = { "prettier", "prettierd", "yamlfix", "yamlfmt" }
502502
},
503503
["yaml.ansible"] = {

0 commit comments

Comments
 (0)