]> git.madduck.net Git - etc/vim.git/blobdiff - .vim/bundle/ale/doc/ale-json.txt

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge commit '76265755a1add77121c8f9dabb3e9bb70fe9a972' as '.vim/bundle/ale'
[etc/vim.git] / .vim / bundle / ale / doc / ale-json.txt
diff --git a/.vim/bundle/ale/doc/ale-json.txt b/.vim/bundle/ale/doc/ale-json.txt
new file mode 100644 (file)
index 0000000..1f72f83
--- /dev/null
@@ -0,0 +1,252 @@
+===============================================================================
+ALE JSON Integration                                         *ale-json-options*
+
+
+===============================================================================
+biome                                                          *ale-json-biome*
+
+Check the docs over at |ale-typescript-biome|.
+
+
+===============================================================================
+clang-format                                             *ale-json-clangformat*
+
+See |ale-c-clangformat| for information about the available options.
+Note that the C options are also used for JSON.
+
+
+===============================================================================
+cspell                                                        *ale-json-cspell*
+
+See |ale-cspell-options|
+
+
+===============================================================================
+dprint                                                        *ale-json-dprint*
+
+See |ale-dprint-options| and https://dprint.dev/plugins/json
+
+
+===============================================================================
+eslint                                                        *ale-json-eslint*
+
+The `eslint` linter for JSON uses the JavaScript options for `eslint`; see:
+|ale-javascript-eslint|.
+
+You will need a JSON ESLint plugin installed for this to work.
+
+
+===============================================================================
+fixjson                                                      *ale-json-fixjson*
+
+fixjson is a JSON file fixer/formatter for humans using (relaxed) JSON5.
+It provides:
+
+- Pretty-prints JSON input
+- Fixes various failures while humans writing JSON
+  - Fixes trailing commas objects or arrays
+  - Fixes missing commas for elements of objects or arrays
+  - Adds quotes to keys in objects
+  - Newlines in strings
+  - Hex numbers
+  - Fixes single quotes to double quotes
+
+You can install it using npm:
+>
+  $ npm install -g fixjson
+<
+ALE provides fixjson integration as a fixer. See |ale-fix|.
+
+-------------------------------------------------------------------------------
+Options
+                                          *ale-options.json_fixjson_executable*
+                                                *g:ale_json_fixjson_executable*
+                                                *b:ale_json_fixjson_executable*
+json_fixjson_executable
+g:ale_json_fixjson_executable
+  Type: |String|
+  Default: `'fixjson'`
+
+  The executable that will be run for fixjson.
+
+                                             *ale-options.json_fixjson_options*
+                                                   *g:ale_json_fixjson_options*
+                                                   *b:ale_json_fixjson_options*
+json_fixjson_options
+g:ale_json_fixjson_options
+  Type: |String|
+  Default: `''`
+
+  This variable can add extra options to the command executed for running
+  fixjson.
+
+                                          *ale-options.json_fixjson_use_global*
+                                                *g:ale_json_fixjson_use_global*
+                                                *b:ale_json_fixjson_use_global*
+json_fixjson_use_global
+g:ale_json_fixjson_use_global
+  Type: |Number|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  See |ale-integrations-local-executables|
+
+
+===============================================================================
+pytool                                                        *ale-json-pytool*
+
+Use python's json.tool module to reformat json.
+
+                                           *ale-options.json_pytool_executable*
+                                                 *g:ale_json_pytool_executable*
+                                                 *b:ale_json_pytool_executable*
+json_pytool_executable
+g:ale_json_pytool_executable
+  Type: |String|
+  Default: `'python'`
+
+  The python executable that run to use its json.tool module. This fixer
+  requires python 3, which includes the json module.
+
+                                              *ale-options.json_pytool_options*
+                                                    *g:ale_json_pytool_options*
+                                                    *b:ale_json_pytool_options*
+json_pytool_options
+g:ale_json_pytool_options
+  Type: |String|
+  Default: `''`
+
+  These options are passed to the json.tool module. Example: >
+    let g:ale_json_pytool_options = '--sort-keys --indent 2'
+<  See docs for all options:
+    https://docs.python.org/3/library/json.html#module-json.tool
+
+                                           *ale-options.json_pytool_use_global*
+                                                 *g:ale_json_pytool_use_global*
+                                                 *b:ale_json_pytool_use_global*
+json_pytool_use_global
+g:ale_json_pytool_use_global
+  Type: |Number|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  See |ale-integrations-local-executables|
+
+
+===============================================================================
+jsonlint                                                    *ale-json-jsonlint*
+
+                                         *ale-options.json_jsonlint_executable*
+                                               *g:ale_json_jsonlint_executable*
+                                               *b:ale_json_jsonlint_executable*
+json_jsonlint_executable
+g:ale_json_jsonlint_executable
+  Type: |String|
+  Default: `'jsonlint'`
+
+  The executable that will be run for jsonlint.
+
+                                         *ale-options.json_jsonlint_use_global*
+                                               *g:ale_json_jsonlint_use_global*
+                                               *b:ale_json_jsonlint_use_global*
+json_jsonlint_use_global
+g:ale_json_jsonlint_use_global
+  Type: |Number|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  See |ale-integrations-local-executables|
+
+
+===============================================================================
+jq                                                                *ale-json-jq*
+
+                                               *ale-options.json_jq_executable*
+                                                     *g:ale_json_jq_executable*
+                                                     *b:ale_json_jq_executable*
+json_jq_executable
+g:ale_json_jq_executable
+  Type: |String|
+  Default: `'jq'`
+
+  This option can be changed to change the path for `jq`.
+
+
+                                                  *ale-options.json_jq_options*
+                                                        *g:ale_json_jq_options*
+                                                        *b:ale_json_jq_options*
+json_jq_options
+g:ale_json_jq_options
+  Type: |String|
+  Default: `''`
+
+  This option can be changed to pass extra options to `jq`.
+
+                                                  *ale-options.json_jq_filters*
+                                                        *g:ale_json_jq_filters*
+                                                        *b:ale_json_jq_filters*
+json_jq_filters
+g:ale_json_jq_filters
+  Type: |String|
+  Default: `'.'`
+
+  This option can be changed to pass custom filters to `jq`.
+
+
+===============================================================================
+prettier                                                    *ale-json-prettier*
+
+See |ale-javascript-prettier| for information about the available options.
+
+
+===============================================================================
+spectral                                                    *ale-json-spectral*
+
+Website: https://github.com/stoplightio/spectral
+
+
+-------------------------------------------------------------------------------
+Installation
+
+Install spectral either globally or locally: >
+
+  npm install @stoplight/spectral -g  # global
+  npm install @stoplight/spectral     # local
+<
+
+-------------------------------------------------------------------------------
+Options
+
+                                         *ale-options.json_spectral_executable*
+                                               *g:ale_json_spectral_executable*
+                                               *b:ale_json_spectral_executable*
+json_spectral_executable
+g:ale_json_spectral_executable
+  Type: |String|
+  Default: `'spectral'`
+
+  This variable can be set to change the path to spectral.
+
+                                         *ale-options.json_spectral_use_global*
+                                               *g:ale_json_spectral_use_global*
+                                               *b:ale_json_spectral_use_global*
+json_spectral_use_global
+g:ale_json_spectral_use_global
+  Type: |String|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  See |ale-integrations-local-executables|
+
+
+===============================================================================
+vscodejson                                                    *ale-json-vscode*
+
+Website: https://github.com/hrsh7th/vscode-langservers-extracted
+
+-------------------------------------------------------------------------------
+Installation
+
+Install VSCode json language server either globally or locally: >
+
+  npm install -g vscode-langservers-extracted
+<
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: