@alexlit/lint-kit 112.3.2 → 112.3.4

package/packages/config-markdownlint/node_modules/markdownlint/doc/md036.md

@@ -1,45 +0,0 @@
-# `MD036` - Emphasis used instead of a heading
-
-Tags: `emphasis`, `headings`
-
-Aliases: `no-emphasis-as-heading`
-
-Parameters:
-
-- `punctuation`: Punctuation characters (`string`, default `.,;:!?。，；：！？`)
-
-This check looks for instances where emphasized (i.e. bold or italic) text is
-used to separate sections, where a heading should be used instead:
-
-```markdown
-**My document**
-
-Lorem ipsum dolor sit amet...
-
-_Another section_
-
-Consectetur adipiscing elit, sed do eiusmod.
-```
-
-To fix this, use Markdown headings instead of emphasized text to denote
-sections:
-
-```markdown
-# My document
-
-Lorem ipsum dolor sit amet...
-
-## Another section
-
-Consectetur adipiscing elit, sed do eiusmod.
-```
-
-Note: This rule looks for single-line paragraphs that consist entirely
-of emphasized text. It won't fire on emphasis used within regular text,
-multi-line emphasized paragraphs, or paragraphs ending in punctuation
-(normal or full-width). Similarly to rule MD026, you can configure what
-characters are recognized as punctuation.
-
-Rationale: Using emphasis instead of a heading prevents tools from inferring
-the structure of a document. More information:
-<https://cirosantilli.com/markdown-style-guide#emphasis-vs-headers>.

package/packages/config-markdownlint/node_modules/markdownlint/doc/md037.md

@@ -1,37 +0,0 @@
-# `MD037` - Spaces inside emphasis markers
-
-Tags: `emphasis`, `whitespace`
-
-Aliases: `no-space-in-emphasis`
-
-Fixable: Some violations can be fixed by tooling
-
-This rule is triggered when emphasis markers (bold, italic) are used, but they
-have spaces between the markers and the text:
-
-```markdown
-Here is some ** bold ** text.
-
-Here is some * italic * text.
-
-Here is some more __ bold __ text.
-
-Here is some more _ italic _ text.
-```
-
-To fix this, remove the spaces around the emphasis markers:
-
-```markdown
-Here is some **bold** text.
-
-Here is some *italic* text.
-
-Here is some more __bold__ text.
-
-Here is some more _italic_ text.
-```
-
-Rationale: Emphasis is only parsed as such when the asterisks/underscores
-aren't surrounded by spaces. This rule attempts to detect where
-they were surrounded by spaces, but it appears that emphasized text was
-intended by the author.

package/packages/config-markdownlint/node_modules/markdownlint/doc/md038.md

@@ -1,40 +0,0 @@
-# `MD038` - Spaces inside code span elements
-
-Tags: `code`, `whitespace`
-
-Aliases: `no-space-in-code`
-
-Fixable: Some violations can be fixed by tooling
-
-This rule is triggered for code span elements that have spaces adjacent to the
-backticks:
-
-```markdown
-`some text `
-
-` some text`
-```
-
-To fix this, remove any spaces adjacent to the backticks:
-
-```markdown
-`some text`
-```
-
-Note: A single leading and trailing space is allowed by the specification and
-automatically trimmed (in order to allow for code spans that embed backticks):
-
-```markdown
-`` `backticks` ``
-```
-
-Note: A single leading or trailing space is allowed if used to separate code
-span markers from an embedded backtick (though the space is not trimmed):
-
-```markdown
-`` ` embedded backtick``
-```
-
-Rationale: Violations of this rule are usually unintentional and may lead to
-improperly-rendered content. If spaces beside backticks are intentional, this
-rule can be disabled for that line or file.

package/packages/config-markdownlint/node_modules/markdownlint/doc/md039.md

@@ -1,21 +0,0 @@
-# `MD039` - Spaces inside link text
-
-Tags: `links`, `whitespace`
-
-Aliases: `no-space-in-links`
-
-Fixable: Some violations can be fixed by tooling
-
-This rule is triggered on links that have spaces surrounding the link text:
-
-```markdown
-[ a link ](https://www.example.com/)
-```
-
-To fix this, remove the spaces surrounding the link text:
-
-```markdown
-[a link](https://www.example.com/)
-```
-
-Rationale: Consistent formatting makes it easier to understand a document.

package/packages/config-markdownlint/node_modules/markdownlint/doc/md040.md

@@ -1,52 +0,0 @@
-# `MD040` - Fenced code blocks should have a language specified
-
-Tags: `code`, `language`
-
-Aliases: `fenced-code-language`
-
-Parameters:
-
-- `allowed_languages`: List of languages (`string[]`, default `[]`)
-- `language_only`: Require language only (`boolean`, default `false`)
-
-This rule is triggered when fenced code blocks are used, but a language isn't
-specified:
-
-````markdown
-```
-#!/bin/bash
-echo Hello world
-```
-````
-
-To fix this, add a language specifier to the code block:
-
-````markdown
-```bash
-#!/bin/bash
-echo Hello world
-```
-````
-
-To display a code block without syntax highlighting, use:
-
-````markdown
-```text
-Plain text in a code block
-```
-````
-
-You can configure the `allowed_languages` parameter to specify a list of
-languages code blocks could use. Languages are case sensitive. The default value
-is `[]` which means any language specifier is valid.
-
-You can prevent extra data from being present in the info string of fenced code
-blocks. To do so, set the `language_only` parameter to `true`.
-
-<!-- markdownlint-disable-next-line no-space-in-code -->
-Info strings with leading/trailing whitespace (ex: `js `) or other content (ex:
-`ruby startline=3`) will trigger this rule.
-
-Rationale: Specifying a language improves content rendering by using the
-correct syntax highlighting for code. More information:
-<https://cirosantilli.com/markdown-style-guide#option-code-fenced>.

package/packages/config-markdownlint/node_modules/markdownlint/doc/md041.md

@@ -1,49 +0,0 @@
-# `MD041` - First line in a file should be a top-level heading
-
-Tags: `headings`
-
-Aliases: `first-line-h1`, `first-line-heading`
-
-Parameters:
-
-- `front_matter_title`: RegExp for matching title in front matter (`string`,
-  default `^\s*title\s*[:=]`)
-- `level`: Heading level (`integer`, default `1`)
-
-This rule is intended to ensure documents have a title and is triggered when
-the first line in the file isn't a top-level (h1) heading:
-
-```markdown
-This is a file without a heading
-```
-
-To fix this, add a top-level heading to the beginning of the file:
-
-```markdown
-# File with heading
-
-This is a file with a top-level heading
-```
-
-Because it is common for projects on GitHub to use an image for the heading of
-`README.md` and that is not well-supported by Markdown, HTML headings are also
-permitted by this rule. For example:
-
-```markdown
-<h1 align="center"><img src="https://placekitten.com/300/150"/></h1>
-
-This is a file with a top-level HTML heading
-```
-
-Note: The `level` parameter can be used to change the top-level (ex: to h2) in
-cases where an h1 is added externally.
-
-If [YAML](https://en.wikipedia.org/wiki/YAML) front matter is present and
-contains a `title` property (commonly used with blog posts), this rule will not
-report a violation. To use a different property name in the front matter,
-specify the text of a regular expression via the `front_matter_title` parameter.
-To disable the use of front matter by this rule, specify `""` for
-`front_matter_title`.
-
-Rationale: The top-level heading often acts as the title of a document. More
-information: <https://cirosantilli.com/markdown-style-guide#top-level-header>.

package/packages/config-markdownlint/node_modules/markdownlint/doc/md042.md

@@ -1,32 +0,0 @@
-# `MD042` - No empty links
-
-Tags: `links`
-
-Aliases: `no-empty-links`
-
-This rule is triggered when an empty link is encountered:
-
-```markdown
-[an empty link]()
-```
-
-To fix the violation, provide a destination for the link:
-
-```markdown
-[a valid link](https://example.com/)
-```
-
-Empty fragments will trigger this rule:
-
-```markdown
-[an empty fragment](#)
-```
-
-But non-empty fragments will not:
-
-```markdown
-[a valid fragment](#fragment)
-```
-
-Rationale: Empty links do not lead anywhere and therefore don't function as
-links.

package/packages/config-markdownlint/node_modules/markdownlint/doc/md043.md

@@ -1,69 +0,0 @@
-# `MD043` - Required heading structure
-
-Tags: `headings`
-
-Aliases: `required-headings`
-
-Parameters:
-
-- `headings`: List of headings (`string[]`, default `[]`)
-- `match_case`: Match case of headings (`boolean`, default `false`)
-
-This rule is triggered when the headings in a file do not match the array of
-headings passed to the rule. It can be used to enforce a standard heading
-structure for a set of files.
-
-To require exactly the following structure:
-
-```markdown
-# Head
-## Item
-### Detail
-```
-
-Set the `headings` parameter to:
-
-```json
-[
-    "# Head",
-    "## Item",
-    "### Detail"
-]
-```
-
-To allow optional headings as with the following structure:
-
-```markdown
-# Head
-## Item
-### Detail (optional)
-## Foot
-### Notes (optional)
-```
-
-Use the special value `"*"` meaning "zero or more unspecified headings" or the
-special value `"+"` meaning "one or more unspecified headings" and set the
-`headings` parameter to:
-
-```json
-[
-    "# Head",
-    "## Item",
-    "*",
-    "## Foot",
-    "*"
-]
-```
-
-When an error is detected, this rule outputs the line number of the first
-problematic heading (otherwise, it outputs the last line number of the file).
-
-Note that while the `headings` parameter uses the "## Text" ATX heading style
-for simplicity, a file may use any supported heading style.
-
-By default, the case of headings in the document is not required to match that
-of `headings`. To require that case match exactly, set the `match_case`
-parameter to `true`.
-
-Rationale: Projects may wish to enforce a consistent document structure across
-a set of similar content.

package/packages/config-markdownlint/node_modules/markdownlint/doc/md044.md

@@ -1,35 +0,0 @@
-# `MD044` - Proper names should have the correct capitalization
-
-Tags: `spelling`
-
-Aliases: `proper-names`
-
-Parameters:
-
-- `code_blocks`: Include code blocks (`boolean`, default `true`)
-- `html_elements`: Include HTML elements (`boolean`, default `true`)
-- `names`: List of proper names (`string[]`, default `[]`)
-
-Fixable: Some violations can be fixed by tooling
-
-This rule is triggered when any of the strings in the `names` array do not have
-the specified capitalization. It can be used to enforce a standard letter case
-for the names of projects and products.
-
-For example, the language "JavaScript" is usually written with both the 'J' and
-'S' capitalized - though sometimes the 's' or 'j' appear in lower-case. To
-enforce the proper capitalization, specify the desired letter case in the
-`names` array:
-
-```json
-[
-    "JavaScript"
-]
-```
-
-Set the `code_blocks` parameter to `false` to disable this rule for code blocks
-and spans. Set the `html_elements` parameter to `false` to disable this rule
-for HTML elements and attributes (such as when using a proper name as part of
-a path for `a`/`href` or `img`/`src`).
-
-Rationale: Incorrect capitalization of proper names is usually a mistake.

package/packages/config-markdownlint/node_modules/markdownlint/doc/md045.md

@@ -1,40 +0,0 @@
-# `MD045` - Images should have alternate text (alt text)
-
-Tags: `accessibility`, `images`
-
-Aliases: `no-alt-text`
-
-This rule is triggered when an image is missing alternate text (alt text)
-information.
-
-Alternate text is commonly specified inline as:
-
-```markdown
-![Alternate text](image.jpg)
-```
-
-Or with reference syntax as:
-
-```markdown
-![Alternate text][ref]
-
-...
-
-[ref]: image.jpg "Optional title"
-```
-
-Or with HTML as:
-
-```html
-<img src="image.jpg" alt="Alternate text" />
-```
-
-Guidance for writing alternate text is available from the [W3C][w3c],
-[Wikipedia][wikipedia], and [other locations][phase2technology].
-
-Rationale: Alternate text is important for accessibility and describes the
-content of an image for people who may not be able to see it.
-
-[phase2technology]: https://www.phase2technology.com/blog/no-more-excuses
-[w3c]: https://www.w3.org/WAI/alt/
-[wikipedia]: https://en.wikipedia.org/wiki/Alt_attribute

package/packages/config-markdownlint/node_modules/markdownlint/doc/md046.md

@@ -1,40 +0,0 @@
-# `MD046` - Code block style
-
-Tags: `code`
-
-Aliases: `code-block-style`
-
-Parameters:
-
-- `style`: Block style (`string`, default `consistent`, values `consistent` /
-  `fenced` / `indented`)
-
-This rule is triggered when unwanted or different code block styles are used in
-the same document.
-
-In the default configuration this rule reports a violation for the following
-document:
-
-<!-- markdownlint-disable code-block-style -->
-
-    Some text.
-
-        # Indented code
-
-    More text.
-
-    ```ruby
-    # Fenced code
-    ```
-
-    More text.
-
-<!-- markdownlint-restore -->
-
-To fix violations of this rule, use a consistent style (either indenting or code
-fences).
-
-The specified style can be specific (`fenced`, `indented`) or simply require
-that usage be consistent within the document (`consistent`).
-
-Rationale: Consistent formatting makes it easier to understand a document.

package/packages/config-markdownlint/node_modules/markdownlint/doc/md047.md

@@ -1,34 +0,0 @@
-# `MD047` - Files should end with a single newline character
-
-Tags: `blank_lines`
-
-Aliases: `single-trailing-newline`
-
-Fixable: Some violations can be fixed by tooling
-
-This rule is triggered when there is not a single newline character at the end
-of a file.
-
-An example that triggers the rule:
-
-```markdown
-# Heading
-
-This file ends without a newline.[EOF]
-```
-
-To fix the violation, add a newline character to the end of the file:
-
-```markdown
-# Heading
-
-This file ends with a newline.
-[EOF]
-```
-
-Rationale: Some programs have trouble with files that do not end with a newline.
-
-More information: [What's the point in adding a new line to the end of a
-file?][stack-exchange]
-
-[stack-exchange]: https://unix.stackexchange.com/questions/18743/whats-the-point-in-adding-a-new-line-to-the-end-of-a-file

package/packages/config-markdownlint/node_modules/markdownlint/doc/md048.md

@@ -1,41 +0,0 @@
-# `MD048` - Code fence style
-
-Tags: `code`
-
-Aliases: `code-fence-style`
-
-Parameters:
-
-- `style`: Code fence style (`string`, default `consistent`, values `backtick`
-  / `consistent` / `tilde`)
-
-This rule is triggered when the symbols used in the document for fenced code
-blocks do not match the configured code fence style:
-
-````markdown
-```ruby
-# Fenced code
-```
-
-~~~ruby
-# Fenced code
-~~~
-````
-
-To fix this issue, use the configured code fence style throughout the
-document:
-
-````markdown
-```ruby
-# Fenced code
-```
-
-```ruby
-# Fenced code
-```
-````
-
-The configured list style can be a specific symbol to use (backtick, tilde), or
-can require that usage be consistent within the document.
-
-Rationale: Consistent formatting makes it easier to understand a document.

package/packages/config-markdownlint/node_modules/markdownlint/doc/md049.md

@@ -1,35 +0,0 @@
-# `MD049` - Emphasis style
-
-Tags: `emphasis`
-
-Aliases: `emphasis-style`
-
-Parameters:
-
-- `style`: Emphasis style (`string`, default `consistent`, values `asterisk` /
-  `consistent` / `underscore`)
-
-Fixable: Some violations can be fixed by tooling
-
-This rule is triggered when the symbols used in the document for emphasis do not
-match the configured emphasis style:
-
-```markdown
-*Text*
-_Text_
-```
-
-To fix this issue, use the configured emphasis style throughout the document:
-
-```markdown
-*Text*
-*Text*
-```
-
-The configured emphasis style can be a specific symbol to use ("asterisk",
-"underscore"), or can require that usage be consistent within the document.
-
-Note: Emphasis within a word is restricted to "asterisk" in order to avoid
-unwanted emphasis for words containing internal underscores like_this_one.
-
-Rationale: Consistent formatting makes it easier to understand a document.

package/packages/config-markdownlint/node_modules/markdownlint/doc/md050.md

@@ -1,35 +0,0 @@
-# `MD050` - Strong style
-
-Tags: `emphasis`
-
-Aliases: `strong-style`
-
-Parameters:
-
-- `style`: Strong style (`string`, default `consistent`, values `asterisk` /
-  `consistent` / `underscore`)
-
-Fixable: Some violations can be fixed by tooling
-
-This rule is triggered when the symbols used in the document for strong do not
-match the configured strong style:
-
-```markdown
-**Text**
-__Text__
-```
-
-To fix this issue, use the configured strong style throughout the document:
-
-```markdown
-**Text**
-**Text**
-```
-
-The configured strong style can be a specific symbol to use ("asterisk",
-"underscore"), or can require that usage be consistent within the document.
-
-Note: Emphasis within a word is restricted to "asterisk" in order to avoid
-unwanted emphasis for words containing internal underscores like_this_one.
-
-Rationale: Consistent formatting makes it easier to understand a document.