.vim/bundle/ale/doc/ale-json.txt

   1 ===============================================================================
   2 ALE JSON Integration                                         *ale-json-options*
   3
   4
   5 ===============================================================================
   6 biome                                                          *ale-json-biome*
   7
   8 Check the docs over at |ale-typescript-biome|.
   9
  10
  11 ===============================================================================
  12 clang-format                                             *ale-json-clangformat*
  13
  14 See |ale-c-clangformat| for information about the available options.
  15 Note that the C options are also used for JSON.
  16
  17
  18 ===============================================================================
  19 cspell                                                        *ale-json-cspell*
  20
  21 See |ale-cspell-options|
  22
  23
  24 ===============================================================================
  25 dprint                                                        *ale-json-dprint*
  26
  27 See |ale-dprint-options| and https://dprint.dev/plugins/json
  28
  29
  30 ===============================================================================
  31 eslint                                                        *ale-json-eslint*
  32
  33 The `eslint` linter for JSON uses the JavaScript options for `eslint`; see:
  34 |ale-javascript-eslint|.
  35
  36 You will need a JSON ESLint plugin installed for this to work.
  37
  38
  39 ===============================================================================
  40 fixjson                                                      *ale-json-fixjson*
  41
  42 fixjson is a JSON file fixer/formatter for humans using (relaxed) JSON5.
  43 It provides:
  44
  45 - Pretty-prints JSON input
  46 - Fixes various failures while humans writing JSON
  47   - Fixes trailing commas objects or arrays
  48   - Fixes missing commas for elements of objects or arrays
  49   - Adds quotes to keys in objects
  50   - Newlines in strings
  51   - Hex numbers
  52   - Fixes single quotes to double quotes
  53
  54 You can install it using npm:
  55 >
  56   $ npm install -g fixjson
  57 <
  58 ALE provides fixjson integration as a fixer. See |ale-fix|.
  59
  60 -------------------------------------------------------------------------------
  61 Options
  62                                           *ale-options.json_fixjson_executable*
  63                                                 *g:ale_json_fixjson_executable*
  64                                                 *b:ale_json_fixjson_executable*
  65 json_fixjson_executable
  66 g:ale_json_fixjson_executable
  67   Type: |String|
  68   Default: `'fixjson'`
  69
  70   The executable that will be run for fixjson.
  71
  72                                              *ale-options.json_fixjson_options*
  73                                                    *g:ale_json_fixjson_options*
  74                                                    *b:ale_json_fixjson_options*
  75 json_fixjson_options
  76 g:ale_json_fixjson_options
  77   Type: |String|
  78   Default: `''`
  79
  80   This variable can add extra options to the command executed for running
  81   fixjson.
  82
  83                                           *ale-options.json_fixjson_use_global*
  84                                                 *g:ale_json_fixjson_use_global*
  85                                                 *b:ale_json_fixjson_use_global*
  86 json_fixjson_use_global
  87 g:ale_json_fixjson_use_global
  88   Type: |Number|
  89   Default: `get(g:, 'ale_use_global_executables', 0)`
  90
  91   See |ale-integrations-local-executables|
  92
  93
  94 ===============================================================================
  95 pytool                                                        *ale-json-pytool*
  96
  97 Use python's json.tool module to reformat json.
  98
  99                                            *ale-options.json_pytool_executable*
 100                                                  *g:ale_json_pytool_executable*
 101                                                  *b:ale_json_pytool_executable*
 102 json_pytool_executable
 103 g:ale_json_pytool_executable
 104   Type: |String|
 105   Default: `'python'`
 106
 107   The python executable that run to use its json.tool module. This fixer
 108   requires python 3, which includes the json module.
 109
 110                                               *ale-options.json_pytool_options*
 111                                                     *g:ale_json_pytool_options*
 112                                                     *b:ale_json_pytool_options*
 113 json_pytool_options
 114 g:ale_json_pytool_options
 115   Type: |String|
 116   Default: `''`
 117
 118   These options are passed to the json.tool module. Example: >
 119     let g:ale_json_pytool_options = '--sort-keys --indent 2'
 120 <  See docs for all options:
 121     https://docs.python.org/3/library/json.html#module-json.tool
 122
 123                                            *ale-options.json_pytool_use_global*
 124                                                  *g:ale_json_pytool_use_global*
 125                                                  *b:ale_json_pytool_use_global*
 126 json_pytool_use_global
 127 g:ale_json_pytool_use_global
 128   Type: |Number|
 129   Default: `get(g:, 'ale_use_global_executables', 0)`
 130
 131   See |ale-integrations-local-executables|
 132
 133
 134 ===============================================================================
 135 jsonlint                                                    *ale-json-jsonlint*
 136
 137                                          *ale-options.json_jsonlint_executable*
 138                                                *g:ale_json_jsonlint_executable*
 139                                                *b:ale_json_jsonlint_executable*
 140 json_jsonlint_executable
 141 g:ale_json_jsonlint_executable
 142   Type: |String|
 143   Default: `'jsonlint'`
 144
 145   The executable that will be run for jsonlint.
 146
 147                                          *ale-options.json_jsonlint_use_global*
 148                                                *g:ale_json_jsonlint_use_global*
 149                                                *b:ale_json_jsonlint_use_global*
 150 json_jsonlint_use_global
 151 g:ale_json_jsonlint_use_global
 152   Type: |Number|
 153   Default: `get(g:, 'ale_use_global_executables', 0)`
 154
 155   See |ale-integrations-local-executables|
 156
 157
 158 ===============================================================================
 159 jq                                                                *ale-json-jq*
 160
 161                                                *ale-options.json_jq_executable*
 162                                                      *g:ale_json_jq_executable*
 163                                                      *b:ale_json_jq_executable*
 164 json_jq_executable
 165 g:ale_json_jq_executable
 166   Type: |String|
 167   Default: `'jq'`
 168
 169   This option can be changed to change the path for `jq`.
 170
 171
 172                                                   *ale-options.json_jq_options*
 173                                                         *g:ale_json_jq_options*
 174                                                         *b:ale_json_jq_options*
 175 json_jq_options
 176 g:ale_json_jq_options
 177   Type: |String|
 178   Default: `''`
 179
 180   This option can be changed to pass extra options to `jq`.
 181
 182                                                   *ale-options.json_jq_filters*
 183                                                         *g:ale_json_jq_filters*
 184                                                         *b:ale_json_jq_filters*
 185 json_jq_filters
 186 g:ale_json_jq_filters
 187   Type: |String|
 188   Default: `'.'`
 189
 190   This option can be changed to pass custom filters to `jq`.
 191
 192
 193 ===============================================================================
 194 prettier                                                    *ale-json-prettier*
 195
 196 See |ale-javascript-prettier| for information about the available options.
 197
 198
 199 ===============================================================================
 200 spectral                                                    *ale-json-spectral*
 201
 202 Website: https://github.com/stoplightio/spectral
 203
 204
 205 -------------------------------------------------------------------------------
 206 Installation
 207
 208 Install spectral either globally or locally: >
 209
 210   npm install @stoplight/spectral -g  # global
 211   npm install @stoplight/spectral     # local
 212 <
 213
 214 -------------------------------------------------------------------------------
 215 Options
 216
 217                                          *ale-options.json_spectral_executable*
 218                                                *g:ale_json_spectral_executable*
 219                                                *b:ale_json_spectral_executable*
 220 json_spectral_executable
 221 g:ale_json_spectral_executable
 222   Type: |String|
 223   Default: `'spectral'`
 224
 225   This variable can be set to change the path to spectral.
 226
 227                                          *ale-options.json_spectral_use_global*
 228                                                *g:ale_json_spectral_use_global*
 229                                                *b:ale_json_spectral_use_global*
 230 json_spectral_use_global
 231 g:ale_json_spectral_use_global
 232   Type: |String|
 233   Default: `get(g:, 'ale_use_global_executables', 0)`
 234
 235   See |ale-integrations-local-executables|
 236
 237
 238 ===============================================================================
 239 vscodejson                                                    *ale-json-vscode*
 240
 241 Website: https://github.com/hrsh7th/vscode-langservers-extracted
 242
 243 -------------------------------------------------------------------------------
 244 Installation
 245
 246 Install VSCode json language server either globally or locally: >
 247
 248   npm install -g vscode-langservers-extracted
 249 <
 250
 251 ===============================================================================
 252   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: