cspell.schema.json

enum: legacy universal

type: string

$ref: #/definitions/CacheFormat

default: legacy

description:
Format of the cache file.
- `legacy` - use absolute paths in the cache file
- `universal` - use a sharable format.

$ref: #/definitions/FSPathResolvable

description:
Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which it is defined.

A prefix of `${cwd}` is replaced with the current working directory.

$ref: #/definitions/CacheStrategy

default: metadata

description: Strategy to use for detecting changed files, default: metadata

description: Store the results of processed files in order to only operate on the changed ones.

type: boolean

type: object

description:
The Strategy to use to detect if a file has changed.
- `metadata` - uses the file system timestamp and size to detect changes (fastest).
- `content` - uses a hash of the file content to check file changes (slower - more accurate).

enum: metadata content

description:
This is a set of characters that can include `-` or `|`
- `-` - indicates a range of characters: `a-c` => `abc`
- `|` - is a group separator, indicating that the characters on either side    are not related.

$ref: #/definitions/CharacterSet

description: the cost to insert / delete / replace / swap the characters in a group

type: number

description: The penalty cost to apply if the accent is used. This is used to discourage

required: characters cost

description: A description to describe the purpose of the map.

description: The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.

description:
The set of substrings to map, these are generally single character strings.

Multiple sets can be defined by using a `|` to separate them.

Example: `"eéê|aåá"` contains two different sets.

To add a multi-character substring use `()`.

Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`.

- To match the beginning of a word, use `^`: `"(^I)""`.
- To match the end of a word, use `$`: `"(e$)(ing$)"`.

description:
Add a penalty to the final cost. This is used to discourage certain suggestions.

Example: ```yaml # Match adding/removing `-` to the end of a word. map: "$(-$)" replace: 50 penalty: 100 ```

This makes adding a `-` to the end of a word more expensive.

Think of it as taking the toll way for speed but getting the bill later.

description: The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.

description: The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.

required: insDel map

required: map replace

required: map swap

$ref: #/definitions/FsDictionaryPath

description: A File System Path to a dictionary file.

description: Specifies the scope of a dictionary.

enum: user workspace folder

description: Only for legacy dictionary definitions.

description: Optional description.

$ref: #/definitions/DictionaryPath

deprecationMessage: Use `path` instead.

description: Path to the file, only for legacy dictionary definitions.

$ref: #/definitions/DictionaryId

description:
This is the name of a dictionary.

Name Format:
- Must contain at least 1 number or letter.
- Spaces are allowed.
- Leading and trailing space will be removed.
- Names ARE case-sensitive.
- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.

description:
Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.

Note: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.

$ref: #/definitions/ReplaceMap

description: Replacement pairs.

$ref: #/definitions/DictionaryFileTypes

default: S

description: Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C is the slowest to load due to the need to split each line based upon code splitting rules.

description: Use Compounds.

required: file name

description: Used to provide extra data related to the dictionary

description: Optional description.

$ref: #/definitions/DictionaryInformation

description: Path to the file.

description: Replacement pairs.

description: Use Compounds.

required: name path

description: For Defining Custom dictionaries. They are generally scoped to a `user`, `workspace`, or `folder`. When `addWords` is true, indicates that the spell checker can add words to the file. Note: only plain text files with one word per line are supported at this moment.

description: When `true`, let's the spell checker know that words can be added to this dictionary.

description: Optional description.

$ref: #/definitions/CustomDictionaryPath

description: Path to custom dictionary text file.

description: Replacement pairs.

$ref: #/definitions/CustomDictionaryScope

type: array

description: Defines the scope for when words will be added to the dictionary. Scope values: `user`, `workspace`, `folder`.

description: Use Compounds.

required: addWords name path

description: Inline Dictionary Definitions

description: Optional description.

description:
List of words to always be considered incorrect. Words found in `flagWords` override `words`.

Format of `flagWords`
- single word entry - `word`
- with suggestions - `word:suggestion` or `word->suggestion, suggestions`

Example: ```ts "flagWords": [   "color: colour",   "incase: in case, encase",   "canot->cannot",   "cancelled->canceled" ] ```

description: List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.

description: Replacement pairs.

description:
A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.

Format of `suggestWords`
- Single suggestion (possible auto fix)     - `word: suggestion`     - `word->suggestion`
- Multiple suggestions (not auto fixable)    - `word: first, second, third`    - `word->first, second, third`

description: Use Compounds.

description: List of words to be considered correct.

required: flagWords name

description: Optional description.

description: Replacement pairs.

description: Use Compounds.

description: List of words to be considered correct.

description: Optional description.

description: Replacement pairs.

description: Use Compounds.

description: List of words to be considered correct.

description: Optional description.

description: Path to the file.

description: Replacement pairs.

description: Use Compounds.

description:
Use by dictionary authors to help improve the quality of suggestions given from the dictionary.

Added with `v5.16.0`.

description:
The accent characters.

Default: `"\u0300-\u0341"`

description: A collection of patterns to test against the suggested words. If the word matches the pattern, then the penalty is applied.

description: The alphabet to use.

description: Define edit costs.

description: Used by dictionary authors

description:
An optional set of characters that can possibly be removed from a word before checking it.

This is useful in languages like Arabic where Harakat accents are optional.

Note: All matching characters are removed or none. Partial removal is not supported.

description: The locale of the dictionary. Example: `nl,nl-be`

description: Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.

description:
This a negative reference to a named dictionary.

It is used to exclude or include a dictionary by name.

The reference starts with 1 or more `!`.
- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.
- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.    Overrides `!<dictionary_name>`.
- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.    Overrides `!!<dictionary_name>`.

description: This a reference to a named dictionary. It is expected to match the name of a dictionary.

description:
Reference to a dictionary by name. One of:
-  {@link  DictionaryRef }
-  {@link  DictionaryNegRef }

description: The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.

description: This is the base cost for making an edit.

description: The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.

description: The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.

description: This is the cost for characters not in the alphabet.

description:
A File System Path.

Special Properties:
- `${cwd}` prefix - will be replaced with the current working directory.
- Relative paths are relative to the configuration file.

description: Features are behaviors or settings that can be explicitly configured.

description: Enable/disable using weighted suggestions.

description: A File System Path. Relative paths are relative to the configuration file.

description: These are glob expressions.

description:
Selected Hunspell AFF content. The content must be UTF-8

Sections:
- TRY
- MAP
- REP
- KEY
- ICONV
- OCONV

Example: ```hunspell # Comment TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ` MAP aàâäAÀÂÄ MAP eéèêëEÉÈÊË MAP iîïyIÎÏY MAP oôöOÔÖ MAP (IJ)(Ĳ) ```

description: The costs to apply when using the hunspell settings

description:
The cost to convert between convert pairs.

The value should be slightly higher than the mapCost.

description:
The cost of replacing or swapping any adjacent keyboard characters.

This should be slightly cheaper than `tryCharCost`.

description:
mapSet replacement cost is the cost to substitute one character with another from the same set.

Map characters are considered very similar to each other and are often the cause of simple mistakes.

description: The cost to substitute pairs found in the replace settings.

description: The cost of inserting / deleting / or swapping any `tryChars` Defaults to `baseCosts`

description: This can be 'typescript,cpp,json,literal haskell', etc.

description: This can be '*', 'typescript', 'cpp', 'json', etc.

description: True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.

description:
Determines if words must match case and accent rules.

- `false` - Case is ignored and accents can be missing on the entire word.   Incorrect accents or partially missing accents will be marked as incorrect.
- `true` - Case and accents are enforced.

description: Optional description of configuration.

description:
Optional list of dictionaries to use. Each entry should match the name of the dictionary.

To remove a dictionary from the list, add `!` before the name.

For example, `!typescript` will turn off the dictionary with the name `typescript`.

See the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.

description:
Define additional available dictionaries.

For example, you can use the following to add a custom dictionary:

```json "dictionaryDefinitions": [   { "name": "custom-words", "path": "./custom-words.txt"} ], "dictionaries": ["custom-words"] ```

description: Is the spell checker enabled.

description: Optional identifier.

description:
List of regular expression patterns or pattern names to exclude from spell checking.

Example: `["href"]` - to exclude html href pattern.

Regular expressions use JavaScript regular expression syntax.

Example: to ignore ALL-CAPS words

JSON ```json "ignoreRegExpList": ["/\\b[A-Z]+\\b/g"] ```

YAML ```yaml ignoreRegExpList:   - >-    /\b[A-Z]+\b/g ```

By default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.

While you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).

description:
List of regular expression patterns or defined pattern names to match for spell checking.

If this property is defined, only text matching the included patterns will be checked.

While you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).

description: The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages.

description: Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales.

description: Optional name of configuration.

description:
Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries are considered correct, but will not be used when making spell correction suggestions.

Note: if a word is suggested by another dictionary, but found in one of these dictionaries, it will be removed from the set of possible suggestions.

description:
Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.

For example:

```javascript "ignoreRegExpList": ["comments"], "patterns": [   {     "name": "comment-single-line",     "pattern": "/#.*/g"   },   {     "name": "comment-multi-line",     "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g"   },   // You can also combine multiple named patterns into one single named pattern   {     "name": "comments",     "pattern": ["comment-single-line", "comment-multi-line"]   } ] ```

description: List of words to be considered correct.

description: This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc.

description: Optional description of configuration.

markdownDescription:
Enable / Disable checking file types (languageIds).
These are in additional to the file types specified by `cSpell.enabledLanguageIds`.
To disable a language, prefix with `!` as in `!json`,

Example:
```
jsonc       // enable checking for jsonc
!json       // disable checking for json
kotlin      // enable checking for kotlin
```

title: File Types to Check

description: Is the spell checker enabled.

description: languageIds for the files to spell check.

description: Glob pattern or patterns to match against.

description: Optional identifier.

description: Sets the locale.

description: Sets the programming language id to match file type.

description:
Additional settings for individual languages.

See [Language Settings](https://cspell.org/configuration/language-settings/) for more details.

description: By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` will prevent ALL default configuration from being loaded.

description: The maximum number of times the same word can be flagged as an error in a file.

description: The maximum number of problems to report in a file.

description: The minimum length of a word before checking it against a dictionary.

description: Optional name of configuration.

description: Number of suggestions to make.

description: The PnP files to search for. Note: `.mjs` files are not currently supported.

description:
The maximum number of changes allowed on a word to be considered a suggestions.

For example, appending an `s` onto `example` -> `examples` is considered 1 change.

Range: between 1 and 5.

description: The maximum amount of time in milliseconds to generate suggestions for a word.

description:
Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.

When true, the spell checker will search up the directory structure for the existence of a PnP file and load it.

description: List of words to be considered correct.

description: Id of the Adjustment, i.e. `short-compound`

description: The amount of penalty to apply.

description: RegExp pattern to match

description: This matches the name in a pattern definition.

description: A PatternRef is a Pattern or PatternId.

enum: Base64 Base64MultiLine Base64SingleLine CStyleComment CStyleHexValue CSSHexValue CommitHash CommitHashLink Email EscapeCharacters HexValues href PhpHereDoc PublicKey RsaCert SshRsa SHA HashStrings SpellCheckerDisable SpellCheckerDisableBlock SpellCheckerDisableLine SpellCheckerDisableNext SpellCheckerIgnoreInDocSetting string UnicodeRef Urls UUID Everything

description: Description of the pattern.

description: Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. It is possible to redefine one of the predefined patterns to override its value.

description: RegExp pattern or array of RegExp patterns.

description: A list of pattern names or regular expressions.

description: The module or path to the the reporter to load.

description: Options to send to the reporter. These are defined by the reporter.

title: name

title: name

title: options

description:
Declare a reporter to use.

`default` - is a special name for the default cli reporter.

Examples:
- `"default"` - to use the default reporter
- `"@cspell/cspell-json-reporter"` - use the cspell JSON reporter.
- `["@cspell/cspell-json-reporter", { "outFile": "out.json" }]`

description: Simple Glob string, the root will be globRoot.

description:
A WeightedMapDef enables setting weights for edits between related characters and substrings.

Multiple groups can be defined using a `|`. A multi-character substring is defined using `()`.

For example, in some languages, some letters sound alike.

```yaml   map: 'sc(sh)(sch)(ss)|t(tt)' # two groups.   replace: 50    # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`. ```

The following could be used to make inserting, removing, or replacing vowels cheaper. ```yaml   map: 'aeiouy'   insDel: 50     # Make it is cheaper to insert or delete a vowel.   replace: 45    # It is even cheaper to replace one with another. ```

Note: the default edit distance is 100.

description: Configuration File Version.

description: Legacy Configuration File Versions.

description: Url to JSON Schema

description: Define cache settings.

description: Optional description of configuration.

title: File Types to Check

description:
Enable scanning files and directories beginning with `.` (period).

By default, CSpell does not scan `hidden` files.

description: Is the spell checker enabled.

description: Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)

description: Configure CSpell features.

description:
Glob patterns of files to be checked.

Glob patterns are relative to the `globRoot` of the configuration file that defines them.

description: Tells the spell checker to searching for `.gitignore` files when it reaches a matching root.

description:
The root to use for glob patterns found in this configuration. Default: location of the configuration file.   For compatibility reasons, config files with version 0.1, the glob root will   default to be `${cwd}`.

Use `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file. Defining globRoot, does not impact imported configurations.

Special Values:
- `${cwd}` - will be replaced with the current working directory.
- `.` - will be the location of the containing configuration file.

description: Optional identifier.

description:
Glob patterns of files to be ignored.

Glob patterns are relative to the `globRoot` of the configuration file that defines them.

description:
Allows this configuration to inherit configuration for one or more other files.

See [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details.

description:
Current active spelling language. This specifies the language locale to use in choosing the general dictionary.

For example:

- "en-GB" for British English.
- "en,nl" to enable both English and Dutch.

description: Forces the spell checker to assume a give language id. Used mainly as an Override.

description: Optional name of configuration.

description: Prevents searching for local configuration when checking individual documents.

description: Number of suggestions to make.

description:
Overrides are used to apply settings for specific files in your project.

For example:

```javascript "overrides": [   // Force `*.hrr` and `*.crr` files to be treated as `cpp` files:   {     "filename": "**/{*.hrr,*.crr}",     "languageId": "cpp"   },   // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately):   {     "language": "nl",     "filename": "**/dutch/**/*.txt"   } ] ```

description: Indicate that the configuration file should not be modified. This is used to prevent tools like the VS Code Spell Checker from modifying the file to add words and other configuration.

description:
Define which reports to use. `default` - is a special name for the default cli reporter.

Examples:
- `["default"]` - to use the default reporter
- `["@cspell/cspell-json-reporter"]` - use the cspell JSON reporter.
- `[["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]`
- `[ "default", ["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]` - Use both the default reporter and the cspell-json-reporter.

description: Show status.

description: Delay in ms after a document has changed before checking it for spelling errors.

description: Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.

description: Words to add to global dictionary -- should only be in the user config file.

description: Verify that the in-document directives are correct.

description:
Configuration format version of the settings file.

This controls how the settings in the configuration file behave.

description: List of words to be considered correct.


ts-force-config.json

description:
If using `sfdx-cli` auth, this is the only property needed to authenticate.
Otherwise, supply additional oAuth parameters

description: The Target SObject API name

description: The generated class property name

required: apiName propName

description: Object used to configure advanced settings on SObject generation

description: The Target SObject API name

description: Defaulted to true.  If set to false, names will NOT be auto-converted to standard javascript conventions

description:
The generated class name.  If not set, it will be automatically
converted to standard javascript Class convention

description:
*Overrides Global Setting*
The path to generate files to.
   If the destination is a folder, it will generate one file per object.
   If the destination is a `.ts` file, a single file will be generated.
   If not set, class output will be logged to `stdout`

description: List of field mappings to override the auto-conversion

$ref: #/definitions/FieldMapping

description:
*Overrides Global Setting*
Make picklist fields strongly typed to generated enums. `generatePicklists` must also be `true`
  `ALL`: for all picklist fields, regardless of salesforce enforcement
  `RESTRICTED`: only on fields where the values are restricted on Salesforce

$ref: #/definitions/AuthConfig

description:
Authentication Method.  Choose one of three:
- You can either username/password oAuth configuration
- sfdx configuration (`username` only)
- `accessToken` & `instanceUrl`
See readme for examples.

description: Flag to generate enums for picklist fields.  Defaulted to false

description: The SObjects to generate classes for.  Can either be a string or an `SObjectConfig` object

$ref: #/definitions/SObjectConfig


clang-format.json

description:
The .clang-format file is a YAML file defining formatting styles used by clang-format.

 see https://clang.llvm.org/docs/ClangFormatStyleOptions.html

$comment: yaml marker for multiple documents in one single yaml file

$comment: clang-format ignores cases. For the sake of consistency, use one of following enums

description: The style used for all options not specifically set in the configuration.

enum: Chromium Google LLVM Mozilla WebKit Microsoft GNU InheritParentConfig chromium google llvm mozilla webkit microsoft gnu inheritparentconfig

description:
clang-format 3.3

 The extra indent or outdent of access modifiers, e.g. public:.

type: integer

description:
clang-format 3.8

 This applies to round brackets (parentheses), angle brackets and square brackets.

enum: Align DontAlign AlwaysBreak BlockIndent

description:
clang-format 13

 if not None, when using initialization for an array of structs aligns the fields into columns.

 NOTE: In clang-format 15 this option only applied to arrays with equal number of columns per row.

enum: None Left Right

description:
clang-format 9

 Style of aligning consecutive macros.

enum: None Consecutive AcrossEmptyLines AcrossComments AcrossEmptyLinesAndComments

description:
clang-format 15

 Alignment options.

description: Whether aligning is enabled.

description: Whether to align across empty lines.

description: Whether to align across comments.

description:
clang-format 3.8

 Style of aligning consecutive assignments.

description:
clang-format 15

 Alignment options.

description: Whether aligning is enabled.

description: Whether to align across empty lines.

description: Whether to align across comments.

description: Whether compound assignments like += are aligned along with =.

description: Whether short assignment operators are left-padded to the same length as long ones in order to put all assignment operators to the right of the left hand side.

description:
clang-format 11

 Style of aligning consecutive bit fields.

description:
clang-format 15

 Alignment options.

description: Whether aligning is enabled.

description: Whether to align across empty lines.

description: Whether to align across comments.

description:
clang-format 3.8

 Style of aligning consecutive declarations.

description:
clang-format 15

 Alignment options.

description: Whether aligning is enabled.

description: Whether to align across empty lines.

description: Whether to align across comments.

description:
clang-format 5

 Options for aligning backslashes in escaped newlines.

enum: Left Right DontAlign

description:
clang-format 3.5

 If true, horizontally align operands of binary and ternary expressions.

enum: Align DontAlign AlignAfterOperator

description:
clang-format 3.7

 Control of trailing comments.

 NOTE: In clang-format 16 this option is not a bool but can be set to the options. Conventional bool options still can be parsed as before.

description:
clang-format 16

 Alignment options.

description: Specifies the way to align trailing comments.

enum: Leave Always Never

description: How many empty lines to apply alignment.

description:
clang-format 9

 If a function call or braced initializer list doesn't fit on a line, allow putting all arguments onto the next line, even if BinPackArguments is false.

description:
clang-format 9

 This option is deprecated in clang-format 15. See NextLine of PackConstructorInitializers.

 If a constructor definition with a member initializer list doesn't fit on a single line, allow putting all member initializers onto the next line, if `ConstructorInitializerAllOnOneLineOrOnePerLine` is true. Note that this parameter has no effect if `ConstructorInitializerAllOnOneLineOrOnePerLine` is false.

description:
clang-format 3.3

 If the function declaration doesn't fit on a line, allow putting all parameters of a function declaration onto the next line even if BinPackParameters is false.

description:
clang-format 11

 Allow short enums on a single line.

description:
clang-format 3.5

 Dependent on the value, while (true) { continue; } can be put on a single line.

enum: Never Empty Always

description:
clang-format 3.6

 If true, short case labels will be contracted to a single line.

description:
clang-format 3.5

 Dependent on the value, int f() { return 0; } can be put on a single line.

enum: All None Inline Empty InlineOnly

description:
clang-format 9

 Dependent on the value, auto lambda []() { return 0; } can be put on a single line.

enum: None Empty Inline All

description:
clang-format 9

 If true, if (a) return; can be put on a single line.

enum: AllIfsAndElse Never WithoutElse OnlyFirstIf

description:
clang-format 3.7

 If true, while (true) continue; can be put on a single line.

description:
clang-format 3.7

 This option is deprecated and is retained for backwards compatibility.

 The function definition return type breaking style to use. This option is deprecated and is retained for backwards compatibility

enum: None All TopLevel

description:
clang-format 3.8

 The function declaration return type breaking style to use.

enum: None All TopLevel AllDefinitions TopLevelDefinitions

description:
clang-format 3.4

 If true, always break before multiline string literals.

description:
clang-format 7

 The template declaration breaking style to use.

enum: Yes No MultiLine

description:
clang-format 12

 A vector of strings that should be interpreted as attributes/qualifiers instead of identifiers. This can be useful for language extensions or static analyzer annotations.

description:
clang-format 3.7

 If false, a function call's arguments will either be all on the same line or will have one line each.

description:
clang-format 3.7

 If false, a function declaration's or function definition's parameters will either all be on the same line or will have one line each.

description:
clang-format 12

 The BitFieldColonSpacingStyle to use for bitfields.

enum: Both None Before After

description:
clang-format 3.8

 Control of individual brace wrapping cases.If BreakBeforeBraces is set to BS_Custom, use this to specify how each individual brace case should be handled. Otherwise, this is ignored.

description: Wrap case labels.

description: Wrap class definitions.

description: Wrap control statements (if/for/while/switch/...).

enum: Never MultiLine Always

description: Wrap enum definitions.

description: Wrap function definitions.

description: Wrap namespace definitions.

description: Wrap ObjC definitions (interfaces, implementations…). @autoreleasepool and @synchronized blocks are wrapped according to AfterControlStatement flag.

description: Wrap struct definitions.

description: Wrap union definitions.

description: Wrap extern blocks.

description: Wrap before catch.

description: Wrap before else.

description: Wrap lambda block.

description: Wrap before while.

description: Indent the wrapped braces themselves.

description: If false, empty function body can be put on a single line. This option is used only if the opening brace of the function has already been wrapped, i.e. the AfterFunction brace wrapping mode is set, and the function could/should not be put on a single line (as per AllowShortFunctionsOnASingleLine and constructor formatting options).

description: If false, empty record (e.g. class, struct or union) body can be put on a single line. This option is used only if the opening brace of the record has already been wrapped, i.e. the AfterClass (for classes) brace wrapping mode is set.

description: If false, empty namespace body can be put on a single line. This option is used only if the opening brace of the namespace has already been wrapped, i.e. the AfterNamespace brace wrapping mode is set.

description:
clang-format 16

 Break after a group of C++11 attributes before a function declaration/definition name.

enum: Always Leave Never

description:
clang-format 3.8

 Break after each annotation on a field in Java files.

description:
clang-format 16

 If true, clang-format will always break after a Json array [ otherwise it will scan until the closing ] to determine if it should add newlines between elements (prettier compatible).

description:
clang-format 16

 The inline ASM colon style to use..

enum: Never OnlyMultiline Always

description:
clang-format 3.6

 The way to wrap binary operators.

enum: None NonAssignment All

description:
clang-format 3.7

 The brace breaking style to use.

enum: Attach Linux Mozilla Stroustrup Allman Whitesmiths GNU WebKit Custom

description:
clang-format 12

 The concept declaration style to use.

enum: Never Allowed Always

description:
clnag-format 5

 If true, in the class inheritance expression clang-format will break before : and , if there is multiple inheritance.

description:
clang-format 3.7

 If true, ternary operators will be placed after line breaks.

description:
clang-format 5

 The constructor initializers style to use.

enum: BeforeColon BeforeComma AfterColon

description:
clang-format 7

 The inheritance list style to use.

enum: BeforeColon BeforeComma AfterColon AfterComma

description:
clang-format 3.9

 Allow breaking string literals when formatting.

description:
clang-format 3.8

 Always break constructor initializers before commas and align the commas with the colon.

description:
clang-format 3.7

 The column limit.

description:
clang-format 3.7

 A regular expression that describes comments with special meaning, which should not be split into lines or otherwise changed.

description:
clang-format 5

 If true, consecutive namespace declarations will be on the same line. If false, each namespace is declared on a new line.

description:
clang-format 3.7

 This option is deprecated. See CurrentLine of PackConstructorInitializers.

description:
clang-format 3.7

 The number of characters to use for indentation of constructor initializer lists as well as inheritance lists.

description:
clang-format 3.7

 Indent width for line continuations.

description:
clang-format 3.4

 If true, format braced lists as best suited for C++11 braced lists.

description:
clang-format 10

 Analyze the formatted file for the most used line ending (
 or
). UseCRLF is only used as a fallback if none can be derived.

 This option is deprecated in clang-format 16. See DeriveLF and DeriveCRLF of LineEnding.

description:
clang-format 3.7

 If true, analyze the formatted file for the most common alignment of & and *. Pointer and reference alignment styles are going to be updated according to the preferences found in the file. PointerAlignment is then used only as fallback.

description:
clang-format 3.7

 Disables formatting completely.

description:
clang-format 13

 Defines when to put an empty line after access modifiers. EmptyLineBeforeAccessModifier configuration handles the number of empty lines between two access modifiers.

description:
clang-format 12

 Defines in which cases to put empty line before access modifiers.

description:
clang-format 3.7

 If true, clang-format detects whether function calls and definitions are formatted with one parameter per line.

description:
clang-format 5

 If true, clang-format adds missing namespace end comments for short namespaces and fixes invalid existing ones. This doesn't affect short namespaces, which are controlled by "ShortNamespaceLines".

description:
clang-format 3.7

 A vector of macros that should be interpreted as foreach loops instead of as function calls.

description:
clang-format 13

 A vector of macros that should be interpreted as conditionals instead of as function calls.

description:
clang-format 7

 Dependent on the value, multiple #include blocks can be sorted as one and divided based on category.

description:
clang-format 7

 Regular expressions denoting the different #include categories used for ordering #includes. If none of the regular expressions match, INT_MAX is assigned as category.The main header for a source file automatically gets category 0. so that it is generally kept at the beginning of the #includes (https://llvm.org/docs/CodingStandards.html#include-style). However, you can also assign negative priorities if you have certain headers that always need to be first.
 There is a third and optional field SortPriority which can used while IncludeBlocks = IBS_Regroup to define the priority in which #includes should be ordered. The value of Priority defines the order of #include blocks and also allows the grouping of #includes of different priority. SortPriority is set to the value of Priority as default if it is not assigned.

description:
clang-format 7

 Specify a regular expression of suffixes that are allowed in the file-to-main-include mapping.
When guessing whether a #include is the "main" include (to assign category 0, see above), use this regex of allowed suffixes to the header stem. A partial match is done, so that: - "" means "arbitrary suffix" - "$" means "no suffix"
For example, if configured to "(_test)?$", then a header a.h would be seen as the "main" include in both a.cc and a_test.cc.

description:
clang-format 7

 Specify a regular expression for files being formatted that are allowed to be considered "main" in the file-to-main-include mapping.
By default, clang-format considers files as "main" only when they end with: .c, .cc, .cpp, .c++, .cxx, .m or .mm extensions. For these files a guessing of "main" include takes place (to assign category 0, see above). This config option allows for additional suffixes and extensions for files to be considered as "main".
By default, clang-format considers files as "main" only when they end with: .c, .cc, .cpp, .c++, .cxx, .m or .mm extensions. For these files a guessing of "main" include takes place (to assign category 0, see above). This config option allows for additional suffixes and extensions for files to be considered as "main".

description:
clang-format 13

 Specify whether access modifiers should have their own indentation level.
When false, access modifiers are indented (or outdented) relative to the record members, respecting the AccessModifierOffset. Record members are indented one level below the record. When true, access modifiers get their own indentation level. As a consequence, record members are always indented 2 levels below the record, regardless of the access modifier presence. Value of the AccessModifierOffset is ignored.

description:
clang-format 11

 Indent case label blocks one level from the case label.
When false, the block following the case label uses the same indentation level as for the case label, treating the case label the same as an if-statement. When true, the block gets indented as a scope block.

description:
clang-format 3.3

 Indent case labels one level from the switch statement.
When false, use the same indentation level as for the switch statement. Switch statement body is always indented one level more than case labels (except the first block following the case label, which itself indents the code - unless IndentCaseBlocks is enabled).

description:
clang-format 11

 IndentExternBlockStyle is the type of indenting of extern blocks.

description:
clang-format 10

 Indent goto labels.
When false, goto labels are flushed left.

description:
clang-format 6

 The preprocessor directive indenting style to use.

description:
clang-format 15

 Indent the requires clause in a template. This only applies when RequiresClausePosition is OwnLine, or WithFollowing.

description:
clang-format 12-14

 Indent the requires clause in a template. This only applies when RequiresClausePosition is OwnLine, or WithFollowing. In clang-format 12, 13 and 14 it was named IndentRequires.

description:
clang-format 3.7

 The number of columns to use for indentation.

description:
clang-format 3.7

 Indent if a function definition or declaration is wrapped after the type.

description:
clang-fomrat 15
 Insert braces after control statements (if, else, for, do, and while) in C++ unless the control statements are inside macro definitions or the braces would enclose preprocessor directives.

 Warning: Setting this option to true could lead to incorrect code formatting due to clang-format's lack of complete semantic information. As such, extra care should be taken to review code changes made by this option.

description:
clang-fomrat 16
 Insert a newline at end of file if missing.

description:
clang-fromat 11

 If set to TCS_Wrapped will insert trailing commas in container literals (arrays and objects) that wrap across multiple lines. It is currently only available for JavaScript and disabled by default TCS_None. InsertTrailingCommas cannot be used together with BinPackArguments as inserting the comma disables bin-packing.

description:
clang-format 16

 Format integer literal separators (' for C++ and _ for C#, Java, and JavaScript).

 Separator format of integer literals of different bases. If negative, remove separators. If 0, leave the literal as is. If positive, insert separators between digits starting from the rightmost digit.

 You can also specify a minimum number of digits (BinaryMinDigits, DecimalMinDigits, and HexMinDigits) the integer literal must have in order for the separators to be inserted.

description: Format separators in binary literals.

description: Format separators in binary literals with a minimum number of digits.

description: Format separators in decimal literals.

description: Format separators in decimal literals with a minimum number of digits.

description: Format separators in hexadecimal literals

description: Format separators in hexadecimal literals with a minimum number of digits.

description:
clang-format 8

 The JavaScriptQuoteStyle to use for JavaScript strings.

description:
clang-fromat 3.9

 The JavaScriptQuoteStyle to use for JavaScript strings.

description:
clang-format 3.9

 Whether to wrap JavaScript import/export statements.

description:
clang-format 3.7

 If true, the empty line at the start of blocks is kept.

description:
clang-format 13

 The indentation style of lambda bodies. Signature (the default) causes the lambda body to be indented one additional level relative to the indentation level of the signature. OuterScope forces the lambda body to be indented one additional level relative to the parent scope containing the lambda signature. For callback-heavy code, it may improve readability to have the signature indented two levels and to use OuterScope. The KJ style guide requires OuterScope. KJ style guide

description:
clang-format 3.5

 Language, this format style is targeted at.

enum: None Cpp ObjC CSharp Java JavaScript Json Proto TableGen TextProto Verilog

description:
clang-format 16

 Line ending style (\n or \r\n) to use.

description:
clang-format 3.7

 A regular expression matching macros that start a block.

description:
clang-format 3.7

 A regular expression matching macros that end a block.

description:
clang-format 3.7

 The maximum number of consecutive empty lines to keep.

description:
clnag-format 3.7

 The indentation used for namespaces.

description:
clnag-format 9

 A vector of macros which are used to open namespace blocks.

description:
clang-format 7

 Controls bin-packing Objective-C protocol conformance list items into as few lines as possible when they go over ColumnLimit.If Auto (the default), delegates to the value in BinPackParameters. If that is true, bin-packs Objective-C protocol conformance list items into as few lines as possible whenever they go over ColumnLimit.
If Always, always bin-packs Objective-C protocol conformance list items into as few lines as possible whenever they go over ColumnLimit.
If Never, lays out Objective-C protocol conformance list items onto individual lines whenever they go over ColumnLimit.

description:
clang-format 3.7

 The number of characters to use for indentation of ObjC blocks.

description:
clang-format 11

 Break parameters list into lines when there is nested block parameters in a function call.

description:
clang-format 3.7

 Add a space after @property in Objective-C, i.e. use @property (readonly) instead of @property(readonly).

description:
clang-format 3.7

 Add a space in front of an Objective-C protocol list, i.e. use Foo <Protocol> instead of Foo<Protocol>.

description:
clang-format 13

 The number of columns to use for indentation of preprocessor statements. When set to -1 (default) IndentWidth is used also for preprocessor statements.

description:
clang-format 14

 The pack constructor initializers style to use.

description:
clang-format 5

 The penalty for breaking around an assignment operator.

description:
clang-format 3.7

 The penalty for breaking a function call after call(.

description:
clang-format 3.7

 The penalty for each line break introduced inside a comment.

description:
clang-format 3.7

 The penalty for breaking before the first <<.

description:
clang-format 14

 The penalty for breaking after (.

description:
clang-format 3.7

 The penalty for each line break introduced inside a string literal.

description:
clang-format 7

 The penalty for breaking after template declaration.

description:
clang-format 3.7

 The penalty for each character outside of the column limit.

description:
clang-format 12

 Penalty for each character of whitespace indentation (counted relative to leading non-whitespace column).

description:
clang-format 3.7

 Penalty for putting the return type of a function onto its own line.

description:
clang-format 3.7

 Pointer and reference alignment style.

description:
clang-format 14

 Different ways to arrange specifiers and qualifiers (e.g. const/volatile).

 Warning:Setting QualifierAlignment to something other than Leave, COULD lead to incorrect code formatting due to incorrect decisions made due to clang-formats lack of complete semantic information.

 As such extra care should be taken to review code changes made by the use of this option.

description:
clang-format 14

 The order in which the qualifiers appear. Order is an array that can contain any of the following.

 Note: it MUST contain 'type'. Items to the left of 'type' will be placed to the left of the type and aligned in the order supplied. Items to the right of 'type' will be placed to the right of the type and aligned in the order supplied.

enum: const inline static constexpr volatile restrict type

description:
clang-format 6

 Defines hints for detecting supported languages code blocks in raw strings.

EnclosingFunctions: EqualsProto EquivToProto PARSE_PARTIAL_TEXT_PROTO PARSE_TEST_PROTO PARSE_TEXT_PROTO ParseTextOrDie ParseTextProtoOrDie ParseTestProto ParsePartialTestProto

description:
clang-format 13

 Reference alignment style (overrides PointerAlignment for references).

description:
clang-format 4

 If true, clang-format will attempt to re-flow comments. That is it will touch a comment and reflow long comments into new lines, trying to obey the ColumnLimit.

description:
clang-format 16

 Remove semicolons after the closing brace of a non-empty function.

 Warning: Setting this option to true could lead to incorrect code formatting due to clang-format's lack of complete semantic information. As such, extra care should be taken to review code changes made by this option.

description:
clang-format 14

 Remove optional braces of control statements (if, else, for, and while) in C++ according to the LLVM coding style.

 Warning: This option will be renamed and expanded to support other styles.

 Setting this option to true could lead to incorrect code formatting due to clang-format's lack of complete semantic information. As such, extra care should be taken to review code changes made by this option.

description:
clang-format 15

 The position of the requires clause.

enum: OwnLine WithPreceding WithFollowing SingleLine

description:
clang-format 16

 The indentation used for requires expression bodies.

description:
clang-format 14

 Specifies the use of empty lines to separate definition blocks, including classes, structs, enums, and functions.

description:
clang-format 13

 The maximal number of unwrapped lines that a short namespace spans. Defaults to 1.

description:
clang-format 4

 Controls if and how clang-format will sort #includes. If Never, includes are never sorted. If CaseInsensitive, includes are sorted in an ASCIIbetical or case insensitive fashion. If CaseSensitive, includes are sorted in an alphabetical or case sensitive fashion.

description:
clang-format 12

 When sorting Java imports, by default static imports are placed before non-static imports. If JavaStaticImportAfterImport is After, static imports are placed after non-static imports.

description:
clang-format 5

 If true, clang-format will sort using declarations.

description:
clang-format 16

 Controls if and how clang-format will sort using declarations.

description:
clang-format 3.5

 If true, a space is inserted after C style casts.

description:
clang-format 9

 If true, a space is inserted after the logical not operator (!).

description:
clang-format 4

 If true, a space will be inserted after the 'template' keyword.

description:
clang-format 12

 Defines in which cases to put a space before or after pointer qualifiers

description:
clang-format 3.7

 If false, spaces will be removed before assignment operators.

description:
clang-format 12

 If false, spaces will be removed before case colon.

description:
clang-format 7

 If true, a space will be inserted before a C++11 braced list used to initialize an object (after the preceding identifier or type).

description:
clang-format 7

 If false, spaces will be removed before constructor initializer colon.

description:
clang-format 7

 If false, spaces will be removed before inheritance colon.

description:
clang-format 3.5

 Defines in which cases to put a space before opening parentheses.

enum: ControlStatements Never ControlStatementsExceptControlMacros NonEmptyParentheses Always Custom

description:
clang-format 14

 Control of individual space before parentheses.

 If SpaceBeforeParens is set to Custom, use this to specify how each individual space before parentheses case should be handled. Otherwise, this is ignored.

description: If true, put space betwee control statement keywords (for/if/while…) and opening parentheses.

description: If true, put space between foreach macros and opening parentheses.

description: If true, put a space between function declaration name and opening parentheses.

description: If true, put a space between function definition name and opening parentheses.

description: If true, put space between if macros and opening parentheses.

description: If true, put a space between operator overloading and opening parentheses.

description: If true, put space between requires keyword in a requires clause and opening parentheses, if there is one.

description: If true, put space between requires keyword in a requires expression and opening parentheses.

description: If true, put a space before opening parentheses only if the parentheses are not empty.

description:
clang-format 7

 If false, spaces will be removed before range-based for loop colon.

description:
clang-format 10

 If true, spaces will be before [. Lambdas will not be affected. Only the first [ will get a space added.

description:
clang-format 10

 If true, spaces will be inserted into {}.

description:
clang-format 3.7

 If true, spaces may be inserted into ().

description:
clang-format 3.7

 The number of spaces before trailing line comments (// - comments).

This does not affect trailing block comments (/* - comments) as those commonly have different usage patterns and a number of special cases.

description:
clang-format 3.4

 The SpacesInAnglesStyle to use for template argument lists.

description:
clang-format 3.7

 If true, spaces may be inserted into C style casts.

description:
clang-format 10

 If true, spaces will be inserted around if/for/switch/while conditions.

description:
clang-format 3.7

 If true, spaces are inserted inside container literals (e.g. ObjC and Javascript array and dict literals).

description:
clang-format 13

 How many spaces are allowed at the start of a line comment. To disable the maximum set it to -1, apart from that the maximum takes precedence over the minimum.

 In clang-format 16, his option has only effect if ReflowComments is set to true.

description:
clang-format 3.7

 If true, spaces will be inserted after ( and before ).

description:
clang-format 3.7

 If true, spaces will be inserted after [ and before ]. Lambdas without arguments or unspecified size array declarations will not be affected.

description:
clang-format 3.7

 Parse and format C++ constructs compatible with this standard.

description:
clang-format 12

 Macros which are ignored in front of a statement, as if they were an attribute. So that they are not parsed as identifier, for example for Qts emit.

description:
clnag-format 8

 A vector of macros that should be interpreted as complete statements.

 Typical macros are expressions, and require a semi-colon to be added; sometimes this is not the case, and this allows to make clang-format aware of such cases.

description:
clang-format 3.7

 The number of columns used for tab stops.

description:
clang-format 9

 A vector of macros that should be interpreted as type declarations instead of as function calls.

For example: OpenSSL STACK_OF, BSD LIST_ENTRY.

description:
clang-format 10

 Use
 instead of
 for line breaks. Also used as fallback if DeriveLineEnding is true.

 This option is deprecated in clang-format 16. See LF and CRLF of LineEnding.

description:
clang-format 3.7

 The way to use tab characters in the resulting file.

enum: Never ForIndentation ForContinuationAndIndentation AlignWithSpaces Always

description:
clang-format 11

 A vector of macros which are whitespace-sensitive and should not be touched.

 For example: BOOST_PP_STRINGIZE

title: .clang-format config


json-patch.json

description: A JSON Pointer path.

required: value op path

$ref: #/definitions/path

description: The operation to perform.

enum: add replace test

description: The value to add, replace or test.

required: op path

description: The operation to perform.

required: from op path

description: The operation to perform.

enum: move copy

description: A JSON Pointer path pointing to the location to move/copy from.

title: JSON schema for JSONPatch files


golangci-lint.json

enum: appendAssign appendCombine argOrder assignOp badCall badCond badLock badRegexp badSorting boolExprSimplify builtinShadow builtinShadowDecl captLocal caseOrder codegenComment commentedOutCode commentedOutImport commentFormatting defaultCaseOrder deferUnlambda deferInLoop deprecatedComment docStub dupArg dupBranchBody dupCase dupImport dupSubExpr dynamicFmtString elseif emptyDecl emptyFallthrough emptyStringTest equalFold evalOrder exitAfterDefer exposedSyncMutex externalErrorReassign filepathJoin flagDeref flagName hexLiteral httpNoBody hugeParam ifElseChain importShadow indexAlloc initClause ioutilDeprecated mapKey methodExprCall nestingReduce newDeref nilValReturn octalLiteral offBy1 paramTypeCombine preferDecodeRune preferFilepathJoin preferFprint preferStringWriter preferWriteByte ptrToRefParam rangeExprCopy rangeValCopy redundantSprint regexpMust regexpPattern regexpSimplify returnAfterHttpError ruleguard singleCaseSwitch sliceClear sloppyLen sloppyReassign sloppyTypeAssert sortSlice sprintfQuotedString sqlQuery stringConcatSimplify stringsCompare stringXbytes suspiciousSorting switchTrue syncMapLoadAndDelete timeCmpSimplify timeExprSimplify tooManyResultsChecker truncateCmp typeAssertChain typeDefFirst typeSwitchVar typeUnparen uncheckedInlineErr underef unlabelStmt unlambda unnamedResult unnecessaryBlock unnecessaryDefer unslice valSwap weakCond whyNoLint wrapperFunc yodaStyleExpr

enum: diagnostic style performance experimental opinionated security

enum: asmdecl assign atomic atomicalign bools buildtag cgocall composites copylocks deepequalerrors errorsas fieldalignment findcall framepointer httpresponse ifaceassert loopclosure lostcancel nilfunc nilness printf reflectvaluecompare shadow shift sigchanyzer sortslice stdmethods stringintconv structtag testinggoroutine tests unmarshal unreachable unsafeptr unusedresult unusedwrite

description: Linters usable.

$comment: anyOf with enum is used to allow auto completion of non-custom linters

enum: asasalint asciicheck bidichk bodyclose containedctx contextcheck cyclop deadcode decorder depguard dogsled dupl dupword durationcheck errcheck errchkjson errname errorlint execinquery exhaustive exhaustivestruct exhaustruct exportloopref forbidigo forcetypeassert funlen gci ginkgolinter gocheckcompilerdirectives gochecknoglobals gochecknoinits gocognit goconst gocritic gocyclo godot godox goerr113 gofmt gofumpt goheader goimports golint gomnd gomoddirectives gomodguard goprintffuncname gosec gosimple gosmopolitan govet grouper ifshort importas ineffassign interfacebloat interfacer ireturn lll loggercheck maintidx makezero maligned mirror misspell musttag nakedret nestif nilerr nilnil nlreturn noctx nolintlint nonamedreturns nosnakecase nosprintfhostport paralleltest prealloc predeclared promlinter reassign revive rowserrcheck scopelint sqlclosecheck staticcheck structcheck stylecheck tagalign tagliatelle tenv testableexamples testpackage thelper tparallel typecheck unconvert unparam unused usestdlibvars varcheck varnamelen wastedassign whitespace wrapcheck wsl zerologlint

$comment: This is here only to allow `additionalProperties: false`.

$ref: #/definitions/linters

description: Options for analysis running,

description: Number of concurrent runners. Defaults to the number of available CPU cores.

description: Timeout for the analysis.

description: Exit code when at least one issue was found.

description: Enable inclusion of test files.

description: List of build tags to pass to all linters.

description: Which directories to skip: issues from them won't be reported.

description:
You can use regexp here. The regexp is applied on the full path.
"/" will be replaced by current OS file path separator to properly work on Windows.

description: Enable skipping of directories "vendor", "third_party", "testdata", "examples", "Godeps", and "builtin".

description: Which files to skip: they will be analyzed, but issues from them will not be reported.

description:
You can use regexp here. There is no need to include all autogenerated files, we confidently recognize them. If that is not the case, please let us know.
"/" will be replaced by current OS file path separator to properly work on Windows.

description:
Option to pass to "go list -mod={option}".
See "go help modules" for more information.

enum: mod readonly vendor

description: Allow multiple parallel golangci-lint instances running. If disabled, golangci-lint acquires file lock on start.

description: Targeted Go version.

description: Output configuration options.

description: Output format to use.

description: Print lines of code with issue.

description: Print linter name in the end of issue text.

description: Make issues output unique by line.

description: Add a prefix to the output file references.

description: All available settings of specific linters.

description: Keywords for detecting duplicate words. If this list is not empty, only the words defined in this list will be detected.

examples: the and a

description: To specify a set of function names to exclude.

description: To enable/disable the asasalint builtin exclusions of function names.

description: Ignore *_test.go files.

description: Disallow: LEFT-TO-RIGHT-EMBEDDING

description: Disallow: RIGHT-TO-LEFT-EMBEDDING

description: Disallow: POP-DIRECTIONAL-FORMATTING

description: Disallow: LEFT-TO-RIGHT-OVERRIDE

description: Disallow: RIGHT-TO-LEFT-OVERRIDE

description: Disallow: LEFT-TO-RIGHT-ISOLATE

description: Disallow: RIGHT-TO-LEFT-ISOLATE

description: Disallow: FIRST-STRONG-ISOLATE

description: Disallow: POP-DIRECTIONAL-ISOLATE

description: Should the linter execute on test files as well

description: Max complexity the function can have

description: Max average complexity in package

default: type const var func

enum: type const var func

description: Order of declarations is not checked

description: Allow init func to be anywhere in file

description: Multiple global type, const and var declarations are allowed

description: Rules to apply.

description: Name of a rule.

description: List of file globs that will match this list of settings to compare against.

description: List of allowed packages.

description: Packages that are not allowed where the value is a suggestion.

description: Description

description: Package

description: Check assignments with too many blank identifiers.

description: Tokens count to trigger issue.

description: Report about not checking errors in type assertions, i.e.: `a := b.(MyStruct)`

description: Report about assignment of errors to blank identifier

description: DEPRECATED: use `exclude-functions` instead. Comma-separated list of pairs of the form "pkg:regex".

description: DEPRECATED: use `exclude-functions` instead. Path to a file containing a list of functions to exclude from checking.

description: List of functions to exclude from checking, where each entry is a single function to exclude

description: To disable the errcheck built-in exclude list

description: Issue on struct that doesn't have exported fields.

description: Check whether fmt.Errorf uses the %w verb for formatting errors

description: Permit more than 1 %w verb, valid per Go 1.20

description: Check for plain type assertions and type switches.

description: Check for plain error comparisons

description: Program elements to check for exhaustiveness.

examples: switch map

description: Check switch statements in generated files

description: Only run exhaustive check on switches with "//exhaustive:enforce" comment.

description: Only run exhaustive check on map literals with "//exhaustive:enforce" comment.

description: Presence of `default` case in switch statements satisfies exhaustiveness, even if all enum members are not listed.

description: Enum members matching `regex` do not have to be listed in switch statements to satisfy exhaustiveness

description: Enum types matching the supplied regex do not have to be listed in switch statements to satisfy exhaustiveness.

description: Consider enums only in package scopes, not in inner scopes.

description: Suppress the wrong length assertion warning.

description: Suppress the wrong nil assertion warning.

description: Suppress the wrong error assertion warning.

description: Suppress the wrong comparison assertion warning.

description: Suppress the function all in async assertion warning.

description: Don't trigger warnings for HaveLen(0).

description: Struct Patterns is list of expressions to match struct packages (written using `path` matching syntax)

description: List of regular expressions to match struct packages and names.

description: List of regular expressions to exclude struct packages and names from check.

description: Exclude code in godoc examples.

description: Instead of matching the literal source code, use type information to replace expressions with strings that contain the package name and (for methods and fields) the type name.

description: List of identifiers to forbid (written using `regexp`)

description: Pattern

description: Package

description: Message

description: Limit lines number per function.

description: Limit statements number per function

description: DEPRECATED: use 'sections' and 'prefix(github.com/org/project)' instead.

description: Section configuration to compare against.

description: Skip generated files.

description: Enable custom order of sections.

description: Minimal code complexity to report (we recommend 10-20).

description: Look for existing constants matching the values

description: Minimum length of string constant.

description: Minimum occurrences count to trigger.

description: Ignore test files.

description: Ignore when constant is not used as function argument

description: Search also for duplicated numbers.

description: Minimum value, only works with `numbers`

description: Maximum value, only works with `numbers`

description: Which checks should be enabled. By default, a list of stable checks is used. To see it, run `GL_DEBUG=gocritic golangci-lint run`.

description: Which checks should be disabled.

description: Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.

description: Disable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.

description: Settings passed to gocritic. Properties must be valid and enabled check names.

description: Minimum code complexity to report (we recommend 10-20).

description: Comments to be checked.

description: List of regexps for excluding particular comment lines from check.

description: Check that each sentence ends with a period.

description: Check that each sentence starts with a capital letter.

description: DEPRECATED: Check all top-level comments, not only declarations.

description: Report any comments starting with one of theses keywords. This is useful for TODO or FIXME comments that might be left in the code accidentally and should be resolved before merging.

description: Simplify code.

description: Apply the rewrite rules to the source before reformatting.

description: The maximum number of methods allowed for an interface.

description: Choose whether or not to use the extra rules that are disabled by default.

description: Select the Go version to target.

description: Module path which contains the source code being formatted.

description: Constants to use in the template.

description: Value for the constant.

description: Regular expressions to use in your template.

description: Template to put on top of every file.

examples:
{{ MY COMPANY }}
SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at:

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

description: Path to the file containing the template source.

description: Put imports beginning with prefix after 3rd-party packages. It is a comma-separated list of prefixes.

description: Minimum confidence for issues.

description: Comma-separated list of file patterns to exclude from the analysis.

description: Comma-separated list of function patterns to exclude from the analysis.

description: Comma-separated list of numbers to exclude from the analysis.

description: The list of enabled checks.

enum: argument case condition operation return assign

description: List of file patterns to exclude from analysis.

description: Comma-separated list of function patterns to exclude from the analysis.

description: List of numbers to exclude from analysis.

description: The list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.

description: List of allowed modules.

description: List of allowed module domains.

description: List of blocked modules.

description: Recommended modules that should be used instead.

description: Reason why the recommended module should be used.

description: List of blocked module version constraints.

description: Version constraint.

description: Reason why the version constraint exists.

description: Raise lint issues if loading local path with replace directive

description: Targeted Go version

description: To select a subset of rules to run

description: To specify a set of rules to explicitly exclude

description: Exclude generated files

description: Filter out the issues with a lower severity than the given value

description: Filter out the issues with a lower confidence than the given value

description: To specify the configuration of rules

description: Concurrency value

description: Allow and ignore `time.Local` usages.

description: List of fully qualified names in the `full/pkg/path.name` form, to act as "i18n escape hatches".

description: Ignore test files.

description: List of Unicode scripts to watch for any usage in string literals.

description: Report shadowed variables.

description:
Settings per analyzer. Map of analyzer name to specific settings.
Run `go tool vet help` to find out more.

description: Run `go tool vet help <analyzer>` to see all settings.

description: Enable analyzers by name.

description: Disable analyzers by name.

description: Enable all analyzers.

description: Disable all analyzers.

description: maximum length of variable declaration measured in numbers of lines, after which the linter won't suggest using short syntax. Has precedence over max-decl-chars

description: maximum length of variable declaration measured in number of characters, after which the linter won't suggest using short syntax.

description: Do not allow unaliased imports of aliased packages.

description: Do not allow non-required aliases.

description: List of aliases

description: Package path e.g. knative.dev/serving/pkg/apis/autoscaling/v1alpha1

description: Package alias e.g. autoscalingv1alpha1

description: Use either `reject` or `allow` properties for interfaces matching.

description: Width of "\t" in spaces.

description: Maximum allowed line length, lines longer will be reported.

description: Maintainability index https://docs.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning?view=vs-2022

description: Minimum accatpable maintainability index level (see https://docs.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning?view=vs-2022)

description: Allow only slices initialized with a length of zero.

description: Allow check for the github.com/go-kit/log library.

description: Allow check for the k8s.io/klog/v2 library.

description: Allow check for the github.com/go-logr/logr library.

description: Allow check for the "sugar logger" from go.uber.org/zap library.

description: Require all logging keys to be inlined constant strings.

description: Require printf-like format specifier (%s, %d for example) not present.

description: List of custom rules to check against, where each rule is a single logger pattern, useful for wrapped loggers.

description: Whether to print struct with more effective memory layout.

description: Correct spellings using locale preferences for US or UK. Default is to use a neutral variety of English.

description: List of words to ignore.

description: Report if a function has more lines of code than this value and it has naked returns.

description: Minimum complexity of "if" statements to report.

description: Order of return types to check.

description: set block size that is still ok

description: Enable to ensure that nolint directives are all used.

description: Exclude these linters from requiring an explanation.

description: Enable to require an explanation of nonzero length after each nolint directive.

description: Enable to require nolint directives to mention the specific linter being suppressed.

description: Report named error if it is assigned inside defer.

description: Ignore missing calls to `t.Parallel()` and only report incorrect uses of it.

description:
We do not recommend using this linter before doing performance profiling.
For most programs usage of `prealloc` will be premature optimization.

description: Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.

description: Report preallocation suggestions on range loops.

description: Report preallocation suggestions on for loops.

description: Comma-separated list of predeclared identifiers to not report on.

description: Include method names and field names (i.e., qualified names) in checks.

enum: Help MetricUnits Counter HistogramSummaryReserved MetricTypeInName ReservedChars CamelCase UnitAbbreviations

title: The rule name

description: Targeted Go version

description: Targeted Go version

description: By default, ST1001 forbids all uses of dot imports in non-test packages. This setting allows setting a whitelist of import paths that can be dot-imported anywhere.

description: ST1013 recommends using constants from the net/http package instead of hard-coding numeric HTTP status codes. This setting specifies a list of numeric status codes that this check does not complain about.

description: ST1003 check, among other things, for the correct capitalization of initialisms. The set of known initialisms can be configured with this option.

default: ACL API ASCII CPU CSS DNS EOF GUID HTML HTTP HTTPS ID IP JSON QPS RAM RPC SLA SMTP SQL SSH TCP TLS TTL UDP UI GID UID UUID URI URL UTF8 VM XML XMPP XSRF XSS SIP RTP AMQP DB TS

description: Align and sort can be used together or separately.

description: Whether enable tags sort.

description: Specify the order of tags, the other tags will be sorted by name.

examples: json yaml yml toml mapstructure binding validate

description: Use the struct field name to check the name of the struct tag.

enum: camel pascal kebab snake goCamel goPascal goKebab goSnake upper upperSnake lower header

description: The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.

description: Files with names matching this regular expression are skipped.

description: List of packages that don't end with _test that tests are allowed to be in.

description: Check if `t.Helper()` begins helper function.

description: Check if *testing.T is first param of helper function.

description: Check if *testing.T param has t name.

description: Check if `b.Helper()` begins helper function.

description: Check if *testing.B is first param of helper function.

description: Check if *testing.B param has b name.

description: Check if `tb.Helper()` begins helper function.

description: Check if *testing.TB is first param of helper function.

description: Check if *testing.TB param has tb name.

description: Check if `f.Helper()` begins helper function.

description: Check if *testing.F is first param of helper function.

description: Check if *testing.F param has f name.

description:
Inspect exported functions. Set to true if no external program/library imports your code.

WARNING: if you enable this setting, unparam will report a lot of false-positives in text editors:
if it's called for subdir of a project it can't find external interfaces. All text editor integrations
with golangci-lint call it on a directory with the changed file.

description: Suggest the use of http.MethodXX.

description: Suggest the use of http.StatusXX.

description: Suggest the use of time.Weekday.String().

description: Suggest the use of time.Month.String().

description: Suggest the use of time.Layout.

description: Suggest the use of crypto.Hash.String().

description: Suggest the use of rpc.DefaultXXPath.

description: Suggest the use of os.DevNull.

description: Suggest the use of sql.LevelXX.String().

description: Suggest the use of tls.SignatureScheme.String().

description: Suggest the use of constant.Kind.String().

description: Suggest the use of syslog.Priority.

description: Check usage of exported variables

description: Variables used in at most this N-many lines will be ignored.

description: The minimum length of a variable's name that is considered `long`.

description: Check method receiver names.

description: Check named return values.

description: Check type parameters.

description: Ignore `ok` variables that hold the bool return value of a type assertion

description: Ignore `ok` variables that hold the bool return value of a map index.

description: Ignore `ok` variables that hold the bool return value of a channel receive.

description: Optional list of variable names that should be ignored completely.

description: Optional list of variable declarations that should be ignored completely.

examples:
c echo.Context
t testing.T
f *foo.Bar
const C

description: Enforces newlines (or comments) after every multi-line if statement

description: Enforces newlines (or comments) after every multi-line function signature

description: An array of strings which specify substrings of signatures to ignore.

default: .Errorf( errors.New( errors.Unwrap( .Wrap( .Wrapf( .WithMessage( .WithMessagef( .WithStack(

description: An array of strings which specify regular expressions of signatures to ignore.

description: An array of glob patterns which, if any match the package of the function returning the error, will skip wrapcheck analysis for this error.

description: An array of glob patterns which, if matched to an underlying interface name, will ignore unwrapped errors returned from a function whose call is defined on the given interface.

description: Controls if you may cuddle assignments and anything without needing an empty line between them.

description: Allow calls and assignments to be cuddled as long as the lines have any matching variables, fields or types.

description: Allow declarations (var) to be cuddled.

description: Allow multiline assignments to be cuddled.

description: Allow leading comments to be separated with empty lines.

description: Allow trailing comments in ending of blocks.

description: Force newlines in end of case at this limit (0 = never).

description: A list of call idents that everything can be cuddled with.

description: AllowCuddleWithRHS is a list of right hand side variables that is allowed to be cuddled with anything.

description: When force-err-cuddling is enabled this is a list of names used for error variables to check for in the conditional.

description: Causes an error when an If statement that checks an error variable doesn't cuddle with the assignment of that variable.

description: Causes an error if a short declaration (:=) cuddles with anything other than another short declaration.

description: If true, append is only allowed to be cuddled if appending value is matching variables, fields or types on line above.

description:
The custom section can be used to define linter plugins to be loaded at runtime. See README of golangci-lint for more information.
Each custom linter should have a unique name.

description: The path to the plugin *.so. Can be absolute or local.

description: The description of the linter, for documentation purposes only.

description: Intended to point to the repo location of the linter, for documentation purposes only.

description: List of enabled linters.

description: List of disabled linters.

description: Whether to enable all linters. You can re-disable them with `disable` explicitly.

description: Whether to disable all linters. You can re-enable them with `enable` explicitly.

description: Allow to use different presets of linters

enum: bugs comment complexity error format import metalinter module performance sql style test unused

description: Enable run of fast linters.

description:
List of regular expressions of issue texts to exclude.
But independently from this option we use default exclude patterns. Their usage can be controlled through `exclude-use-default`.

description: Exclude configuration per-path, per-linter, per-text and per-source

description: Independently from option `exclude` we use default exclude patterns. This behavior can be disabled by this option.

description: If set to true, exclude and exclude-rules regular expressions become case sensitive.

description: The list of ids of default excludes to include or disable.

description: Maximum issues count per one linter. Set to 0 to disable.

description: Maximum count of issues with the same text. Set to 0 to disable.

description: Show only new issues: if there are unstaged changes or untracked files, only those changes are analyzed, else only changes in HEAD~ are analyzed.

description: Show only new issues created after this git revision.

description: Show only new issues created in git patch with this file path.

description: Set the default severity for issues. If severity rules are defined and the issues do not match or no severity is provided to the rule this will be the default severity applied. Severities should match the supported severity names of the selected out format.

description: If set to true, severity-rules regular expressions become case sensitive.

description:
When a list of severity rules are provided, severity information will be added to lint issues. Severity rules have the same filtering capability as exclude rules except you are allowed to specify one matcher per severity rule.
Only affects out formats that support setting severity information.


enum: linear mph

enum: Enabled Disabled

enum: Enabled Disabled DisabledIfAnyMatch

const: dokodemo-door

const: http

const: shadowsocks

const: socks

const: vless

const: vmess

const: trojan

enum: none srtp utp wechat-video dtls wireguard

const: burst

const: default

const: blackhole

const: freedom

const: dns

const: loopback

enum: AsIs AlwaysIP IPIfNonMatch IPOnDemand

const: random

const: leastping

const: leastload

description: weight settings

description: RTT baselines for selecting, int64 values of time.Duration

description: expected nodes count to select

description: max acceptable rtt, filter away high delay nodes. defalut 0

description: acceptable failure rate

description: DNSConfig is a JSON serializable object for dns.Config.

description: HealthCheckSettings holds settings for health Checker

description: health check settings

description:
Port of this Point server.
Deprecated: Port exists for historical compatibility
and should not be used.

description:
Deprecated: InboundConfig exists for historical compatibility
and should not be used.

description:
Deprecated: OutboundConfig exists for historical compatibility
and should not be used.

description:
Deprecated: InboundDetours exists for historical compatibility
and should not be used.

description:
Deprecated: OutboundDetours exists for historical compatibility
and should not be used.

description: TrojanClientConfig is configuration of trojan servers

description: TrojanInboundFallback is fallback configuration

description: TrojanServerConfig is Inbound configuration

description: TrojanServerTarget is configuration of a single trojan server

description: TrojanUserConfig is user configuration

description: ID of the account, in the form of a UUID, e.g., "66ad4540-b58c-4ad2-9926-ea63445a9b57".

description: Flow settings.

description: Encryption settings. Only applies to client side, and only accepts "none" for now.

description: JSON schema for V2Ray jsonv4 configuration format: https://github.com/v2fly/v2ray-core


ide.host.json

description: Determines if the user entered values should be persisted for the next template invocation.

enum: none templateGroup shared

description: The id of the symbol from the template.json.

description: Overrides the name specified in the template.json

$ref: #/definitions/text

$ref: #/definitions/overrideInfo

description: Should be shown in the IDE. If not specified, defaults value is the value specified by defaultSymbolVisibility.

description: If the referenced symbol should be shown in the IDE.

description: Overrides the default value specified for the

description: Determines if the user entered value should be persisted and used the next time a template is selected. Default value is the value specified by defaultSymbolVisibility Used starting in Visual Studio 2022 17.3

$ref: #/definitions/persistenceScope

description: Specifies the name and description overrides for individual choice parameters

description: The tag to modify

enum: platform projectType

description: Tags to add

description: Tags to remove. * can be specified to remove all tags specified in template.json

description: The host identifier.

description: A version range specifying the unsupported host versions. This uses the nuget package format.

description: To require a particular host version specify the hostId and optionally version only. To require a particular SetupComponent or Extension, specify the ID and set the componentType appropriately. Version range is optional.

description: The id of the component

description: The host id that the component applies to

enum: setupComponent extension

description: A version range specifying the required version range. This uses the nuget package format.

description: Name of the template

description: Description of the template

description: The order of the template as shown in the New Project dialog

description: The relative file name of the icon to show in the New Project dialog

description: Determines if the checkbox for adding Docker support in the New Project dialog should be visible

description: The symbol in the template.json which when set, would cause the template to generate non-https ports and settings

description: Sets the default isVisible for a symbolInfo if not explictly specified. Controls if the parameter is displayed in the IDE. Defaults to false if not specified

description: The dafault value for a symbolInfo if not explictly specified. Determines if the user entered value should be persisted and used the next time a template is selected. Used starting in Visual Studio 2022 17.3

description: The dafault value for a symbolInfo if not explictly specified. Specifies the scope name of the persisted template option. To avoid conflicts with other templates, treat this like a namespace. Used starting in Visual Studio 2022 17.3

description: Controls display characteristics of symbols declared in template.json

$ref: #/definitions/symbolInfo

description: Modifigy the project and platform tags displayed in the IDE

$ref: #/definitions/tags

description: Unsuppored Hosts. This can be used to supress the template from being displayed in the new project dialog in Visual Studio.

$ref: #/definitions/unsupportedHost

description: Required components in order to display this template.

$ref: #/definitions/requiredComponent

title: JSON schema for IDE template host files


rtx.json

title: rtx

description: config file for rtx version manager (.rtx.toml)

description: path to .env file

description: PATH entries to add

description: a path to add to PATH

description: environment variables

description: dev tools to use

$ref: #/$defs/tool

description: plugins to use

description: url to plugin repository

description: custom shorthands for versions

description: plugin to set aliases for

description: version alias points to

$ref: #/$defs/settings

description: version of the tool to install

description: version of the tool to install

description: settings for rtx

description: what to do when a runtime is missing

enum: ignore prompt autoinstall warn error

description: should rtx parse legacy version files (e.g. .node-version)

description: tools that should not have their legacy version files parsed

description: tool name

description: should rtx keep downloaded files after installation

description: should rtx keep install files after installation even if the installation fails

description: how often to check for plugin updates

description: how often to check for plugin updates

description: set to true to ensure .tool-versions will be compatible with asdf

description: number of tools to install in parallel, default is 4

description: directly connect plugin scripts to stdin/stdout, implies --jobs=1

description: path to file containing shorthand mappings

description: disables built-in shorthands

description: tools that should not be used

description: tool name

description: config files with these prefixes will be trusted by default

description: a path to add to PATH

description: enable experimental features

description: log level

enum: error warn info debug trace

description: display installation output


markdownlint-config-schema.json

title: Markdownlint configuration schema

description: Default state for all rules

description: Path to configuration file to extend

description: JSON Schema URI (used by some editors)

description: MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time

description: MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading

type: boolean object

description: Heading level

description: MD003/heading-style/header-style - Heading style

description: Heading style

default: consistent

description: MD004/ul-style - Unordered list style

description: List style

enum: consistent asterisk plus dash sublist

description: MD005/list-indent - Inconsistent indentation for list items at the same level

description: MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line

description: MD007/ul-indent - Unordered list indentation

description: Spaces for indent

description: Whether to indent the first level of the list

description: Spaces for first level indent (when start_indented is set)

description: MD009/no-trailing-spaces - Trailing spaces

description: Spaces for line break

description: Allow spaces for empty lines in list items

description: Include unnecessary breaks

description: MD010/no-hard-tabs - Hard tabs

description: Include code blocks

description: Fenced code languages to ignore

description: Number of spaces for each hard tab

description: MD011/no-reversed-links - Reversed link syntax

description: MD012/no-multiple-blanks - Multiple consecutive blank lines

description: Consecutive blank lines

description: MD013/line-length - Line length

description: Number of characters

description: Number of characters for headings

description: Number of characters for code blocks

description: Include code blocks

description: Include tables

description: Include headings

description: Include headings

description: Strict length checking

description: Stern length checking

description: MD014/commands-show-output - Dollar signs used before commands without showing output

description: MD018/no-missing-space-atx - No space after hash on atx style heading

description: MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading

description: MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading

description: MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading

description: MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines

description: Blank lines above heading

type: integer array

description: Blank lines below heading

description: MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line

description: MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content

description: Only check sibling headings

description: Only check sibling headings

description: MD025/single-title/single-h1 - Multiple top-level headings in the same document

description: Heading level

description: RegExp for matching title in front matter

description: MD026/no-trailing-punctuation - Trailing punctuation in heading

description: Punctuation characters

description: MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol

description: MD028/no-blanks-blockquote - Blank line inside blockquote

description: MD029/ol-prefix - Ordered list item prefix

description: List style

enum: one ordered one_or_ordered zero

description: MD030/list-marker-space - Spaces after list markers

description: Spaces for single-line unordered list items

description: Spaces for single-line ordered list items

description: Spaces for multi-line unordered list items

description: Spaces for multi-line ordered list items

description: MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines

description: Include list items

description: MD032/blanks-around-lists - Lists should be surrounded by blank lines

description: MD033/no-inline-html - Inline HTML

description: Allowed elements

description: MD034/no-bare-urls - Bare URL used

description: MD035/hr-style - Horizontal rule style

description: Horizontal rule style

description: MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading

description: Punctuation characters

description: MD037/no-space-in-emphasis - Spaces inside emphasis markers

description: MD038/no-space-in-code - Spaces inside code span elements

description: MD039/no-space-in-links - Spaces inside link text

description: MD040/fenced-code-language - Fenced code blocks should have a language specified

description: List of languages

description: Require language only

description: MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading

description: Heading level

description: MD042/no-empty-links - No empty links

description: MD043/required-headings/required-headers - Required heading structure

description: List of headings

description: List of headings

description: Match case of headings

description: MD044/proper-names - Proper names should have the correct capitalization

description: List of proper names

description: Include code blocks

description: Include HTML elements

description: MD045/no-alt-text - Images should have alternate text (alt text)

description: MD046/code-block-style - Code block style

description: Block style

description: MD047/single-trailing-newline - Files should end with a single newline character

description: MD048/code-fence-style - Code fence style

description: Code fence style

description: MD049/emphasis-style - Emphasis style should be consistent

description: Emphasis style

description: MD050/strong-style - Strong style should be consistent

description: Strong style

description: MD051/link-fragments - Link fragments should be valid

description: MD052/reference-links-images - Reference links and images should use a label that is defined

description: MD053/link-image-reference-definitions - Link and image reference definitions should be needed

description: Ignored definitions

description: headings - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043

description: headers - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043

description: bullet - MD004, MD005, MD006, MD007, MD032

description: ul - MD004, MD005, MD006, MD007, MD030, MD032

description: indentation - MD005, MD006, MD007, MD027

description: whitespace - MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039

description: hard_tab - MD010

description: links - MD011, MD034, MD039, MD042, MD051, MD052, MD053

description: blank_lines - MD012, MD022, MD031, MD032, MD047

description: line_length - MD013

description: code - MD014, MD031, MD038, MD040, MD046, MD048

description: atx - MD018, MD019

description: spaces - MD018, MD019, MD020, MD021, MD023

description: atx_closed - MD020, MD021

description: blockquote - MD027, MD028

description: ol - MD029, MD030, MD032

description: html - MD033

description: url - MD034

description: hr - MD035

description: emphasis - MD036, MD037, MD049, MD050

description: language - MD040

description: spelling - MD044

description: accessibility - MD045

description: images - MD045, MD052, MD053