Skip to content

Commit

Permalink
Update doc gen tools
Browse files Browse the repository at this point in the history
  • Loading branch information
ota-meshi committed Feb 26, 2021
1 parent f2c5eb8 commit 67e8283
Show file tree
Hide file tree
Showing 26 changed files with 248 additions and 56 deletions.
5 changes: 5 additions & 0 deletions .env-cmdrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"version": {
"IN_VERSION_SCRIPT": "true"
}
}
10 changes: 8 additions & 2 deletions docs/rules/block-mapping-question-indicator-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/block-mapping-question-indicator-newline"
description: "enforce consistent line breaks after `?` indicator"
since: "v0.5.0"
---
# yml/block-mapping-question-indicator-newline

Expand Down Expand Up @@ -54,7 +55,12 @@ yml/block-mapping-question-indicator-newline:
- [yml/key-spacing](./key-spacing.md)
- [yml/block-sequence-hyphen-indicator-newline](./block-sequence-hyphen-indicator-newline.md)

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.5.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/block-mapping-question-indicator-newline.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/block-mapping-question-indicator-newline.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/block-mapping-question-indicator-newline.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/block-mapping-question-indicator-newline)
10 changes: 8 additions & 2 deletions docs/rules/block-mapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/block-mapping"
description: "require or disallow block style mappings."
since: "v0.1.0"
---
# yml/block-mapping

Expand Down Expand Up @@ -107,7 +108,12 @@ yml/block-mapping:

[yml/block-sequence]: ./block-sequence.md

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.1.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/block-mapping.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/block-mapping.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/block-mapping.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/block-mapping)
10 changes: 8 additions & 2 deletions docs/rules/block-sequence-hyphen-indicator-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/block-sequence-hyphen-indicator-newline"
description: "enforce consistent line breaks after `-` indicator"
since: "v0.5.0"
---
# yml/block-sequence-hyphen-indicator-newline

Expand Down Expand Up @@ -55,7 +56,12 @@ yml/block-sequence-hyphen-indicator-newline:
- [yml/key-spacing](./key-spacing.md)
- [yml/block-mapping-question-indicator-newline](./block-mapping-question-indicator-newline.md)

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.5.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/block-sequence-hyphen-indicator-newline.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/block-sequence-hyphen-indicator-newline.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/block-sequence-hyphen-indicator-newline.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/block-sequence-hyphen-indicator-newline)
10 changes: 8 additions & 2 deletions docs/rules/block-sequence.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/block-sequence"
description: "require or disallow block style sequences."
since: "v0.1.0"
---
# yml/block-sequence

Expand Down Expand Up @@ -117,7 +118,12 @@ d:

[yml/block-mapping]: ./block-mapping.md

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.1.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/block-sequence.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/block-sequence.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/block-sequence.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/block-sequence)
10 changes: 8 additions & 2 deletions docs/rules/flow-mapping-curly-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/flow-mapping-curly-newline"
description: "enforce consistent line breaks inside braces"
since: "v0.1.0"
---
# yml/flow-mapping-curly-newline

Expand Down Expand Up @@ -60,9 +61,14 @@ Same as [object-curly-newline] rule option. See [here](https://eslint.org/docs/r

[object-curly-newline]: https://eslint.org/docs/rules/object-curly-newline

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.1.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/flow-mapping-curly-newline.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/flow-mapping-curly-newline.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/flow-mapping-curly-newline.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/flow-mapping-curly-newline)

<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/object-curly-newline)</sup>
10 changes: 8 additions & 2 deletions docs/rules/flow-mapping-curly-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/flow-mapping-curly-spacing"
description: "enforce consistent spacing inside braces"
since: "v0.1.0"
---
# yml/flow-mapping-curly-spacing

Expand Down Expand Up @@ -49,9 +50,14 @@ Same as [object-curly-spacing] rule option. See [here](https://eslint.org/docs/r

[object-curly-spacing]: https://eslint.org/docs/rules/object-curly-spacing

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.1.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/flow-mapping-curly-spacing.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/flow-mapping-curly-spacing.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/flow-mapping-curly-spacing.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/flow-mapping-curly-spacing)

<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/object-curly-spacing)</sup>
10 changes: 8 additions & 2 deletions docs/rules/flow-sequence-bracket-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/flow-sequence-bracket-newline"
description: "enforce linebreaks after opening and before closing flow sequence brackets"
since: "v0.1.0"
---
# yml/flow-sequence-bracket-newline

Expand Down Expand Up @@ -60,9 +61,14 @@ Same as [array-bracket-newline] rule option. See [here](https://eslint.org/docs/

[array-bracket-newline]: https://eslint.org/docs/rules/array-bracket-newline

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.1.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/flow-sequence-bracket-newline.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/flow-sequence-bracket-newline.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/flow-sequence-bracket-newline.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/flow-sequence-bracket-newline)

<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/array-bracket-newline)</sup>
10 changes: 8 additions & 2 deletions docs/rules/flow-sequence-bracket-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/flow-sequence-bracket-spacing"
description: "enforce consistent spacing inside flow sequence brackets"
since: "v0.1.0"
---
# yml/flow-sequence-bracket-spacing

Expand Down Expand Up @@ -50,9 +51,14 @@ Same as [array-bracket-spacing] rule option. See [here](https://eslint.org/docs/

[array-bracket-spacing]: https://eslint.org/docs/rules/array-bracket-spacing

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.1.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/flow-sequence-bracket-spacing.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/flow-sequence-bracket-spacing.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/flow-sequence-bracket-spacing.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/flow-sequence-bracket-spacing)

<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/array-bracket-spacing)</sup>
10 changes: 8 additions & 2 deletions docs/rules/indent.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/indent"
description: "enforce consistent indentation"
since: "v0.1.0"
---
# yml/indent

Expand Down Expand Up @@ -57,7 +58,12 @@ Specify the number of indents.

[indent]: https://eslint.org/docs/rules/indent

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.1.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/indent.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/indent.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/indent.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/indent)
10 changes: 8 additions & 2 deletions docs/rules/key-name-casing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/key-name-casing"
description: "enforce naming convention to key names"
since: "v0.2.0"
---
# yml/key-name-casing

Expand Down Expand Up @@ -51,7 +52,12 @@ yml/key-name-casing:
- `"snake_case"` ... if `true`, allows snake_case naming. default `false`
- `"ignores"` ... you can specify the patterns to ignore in the array.

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.2.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/key-name-casing.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/key-name-casing.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/key-name-casing.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/key-name-casing)
10 changes: 8 additions & 2 deletions docs/rules/key-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/key-spacing"
description: "enforce consistent spacing between keys and values in mapping pairs"
since: "v0.3.0"
---
# yml/key-spacing

Expand Down Expand Up @@ -59,9 +60,14 @@ Same as [key-spacing] rule option. See [here](https://eslint.org/docs/rules/key-

[key-spacing]: https://eslint.org/docs/rules/key-spacing

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.3.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/key-spacing.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/key-spacing.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/key-spacing.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/key-spacing)

<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/key-spacing)</sup>
10 changes: 8 additions & 2 deletions docs/rules/no-empty-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/no-empty-document"
description: "disallow empty document"
since: "v0.6.0"
---
# yml/no-empty-document

Expand Down Expand Up @@ -45,7 +46,12 @@ Nothing.
[yml/no-empty-mapping-value]: ./no-empty-mapping-value.md
[yml/no-empty-sequence-entry]: ./no-empty-sequence-entry.md

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.6.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/no-empty-document.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/no-empty-document.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/no-empty-document.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/no-empty-document)
10 changes: 8 additions & 2 deletions docs/rules/no-empty-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/no-empty-key"
description: "disallow empty mapping keys"
since: "v0.3.0"
---
# yml/no-empty-key

Expand Down Expand Up @@ -44,7 +45,12 @@ Nothing.
[yml/no-empty-sequence-entry]: ./no-empty-sequence-entry.md
[yml/no-empty-document]: ./no-empty-document.md

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.3.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/no-empty-key.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/no-empty-key.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/no-empty-key.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/no-empty-key)
10 changes: 8 additions & 2 deletions docs/rules/no-empty-mapping-value.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/no-empty-mapping-value"
description: "disallow empty mapping values"
since: "v0.3.0"
---
# yml/no-empty-mapping-value

Expand Down Expand Up @@ -44,7 +45,12 @@ Nothing.
[yml/no-empty-sequence-entry]: ./no-empty-sequence-entry.md
[yml/no-empty-document]: ./no-empty-document.md

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.3.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/no-empty-mapping-value.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/no-empty-mapping-value.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/no-empty-mapping-value.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/no-empty-mapping-value)
10 changes: 8 additions & 2 deletions docs/rules/no-empty-sequence-entry.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/no-empty-sequence-entry"
description: "disallow empty sequence entries"
since: "v0.3.0"
---
# yml/no-empty-sequence-entry

Expand Down Expand Up @@ -44,7 +45,12 @@ Nothing.
[yml/no-empty-sequence-entry]: ./no-empty-sequence-entry.md
[yml/no-empty-document]: ./no-empty-document.md

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.3.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/no-empty-sequence-entry.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/no-empty-sequence-entry.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/no-empty-sequence-entry.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/no-empty-sequence-entry)
10 changes: 8 additions & 2 deletions docs/rules/no-irregular-whitespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pageClass: "rule-details"
sidebarDepth: 0
title: "yml/no-irregular-whitespace"
description: "disallow irregular whitespace"
since: "v0.1.0"
---
# yml/no-irregular-whitespace

Expand Down Expand Up @@ -98,9 +99,14 @@ yml/no-irregular-whitespace:

[no-irregular-whitespace]: https://eslint.org/docs/rules/no-irregular-whitespace

## Implementation
## :rocket: Version

This rule was introduced in eslint-plugin-yml v0.1.0

## :mag: Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/no-irregular-whitespace.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/no-irregular-whitespace.js)
- [Test source](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/tests/src/rules/no-irregular-whitespace.ts)
- [Test fixture sources](https://github.com/ota-meshi/eslint-plugin-yml/tree/master/tests/fixtures/rules/no-irregular-whitespace)

<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/no-irregular-whitespace)</sup>

0 comments on commit 67e8283

Please sign in to comment.