Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(website): add explicit frontmatter description to rule docs #5429

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -1,3 +1,7 @@
---
description: 'Require that member overloads be consecutive.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/adjacent-overload-signatures** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/array-type.md
@@ -1,3 +1,7 @@
---
description: 'Require using either `T[]` or `Array<T>` for arrays.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/array-type** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/await-thenable.md
@@ -1,3 +1,7 @@
---
description: 'Disallow awaiting a value that is not a Thenable.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/await-thenable** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/ban-ts-comment.md
@@ -1,3 +1,7 @@
---
description: 'Disallow `@ts-<directive>` comments or require descriptions after directive.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/ban-ts-comment** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/ban-tslint-comment.md
@@ -1,3 +1,7 @@
---
description: 'Disallow `// tslint:<rule-flag>` comments.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/ban-tslint-comment** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/ban-types.md
@@ -1,3 +1,7 @@
---
description: 'Disallow certain types.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/ban-types** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/brace-style.md
@@ -1,3 +1,7 @@
---
description: 'Enforce consistent brace style for blocks.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/brace-style** for documentation.
Expand Down
@@ -1,3 +1,7 @@
---
description: 'Enforce that literals on classes are exposed in a consistent style.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/class-literal-property-style** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/comma-dangle.md
@@ -1,3 +1,7 @@
---
description: 'Require or disallow trailing commas.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/comma-dangle** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/comma-spacing.md
@@ -1,3 +1,7 @@
---
description: 'Enforce consistent spacing before and after commas.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/comma-spacing** for documentation.
Expand Down
@@ -1,3 +1,7 @@
---
description: 'Enforce specifying generic type arguments on type annotation or constructor name of a constructor call.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/consistent-generic-constructors** for documentation.
Expand Down
@@ -1,3 +1,7 @@
---
description: 'Require or disallow the `Record` type.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/consistent-indexed-object-style** for documentation.
Expand Down
@@ -1,3 +1,7 @@
---
description: 'Enforce consistent usage of type assertions.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/consistent-type-assertions** for documentation.
Expand Down
@@ -1,3 +1,7 @@
---
description: 'Enforce type definitions to consistently use either `interface` or `type`.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/consistent-type-definitions** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/consistent-type-exports.md
@@ -1,3 +1,7 @@
---
description: 'Enforce consistent usage of type exports.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/consistent-type-exports** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/consistent-type-imports.md
@@ -1,3 +1,7 @@
---
description: 'Enforce consistent usage of type imports.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/consistent-type-imports** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/default-param-last.md
@@ -1,3 +1,7 @@
---
description: 'Enforce default parameters to be last.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/default-param-last** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/dot-notation.md
@@ -1,3 +1,7 @@
---
description: 'Enforce dot notation whenever possible.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/dot-notation** for documentation.
Expand Down
@@ -1,3 +1,7 @@
---
description: 'Require explicit return types on functions and class methods.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/explicit-function-return-type** for documentation.
Expand Down
@@ -1,3 +1,7 @@
---
description: 'Require explicit accessibility modifiers on class properties and methods.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/explicit-member-accessibility** for documentation.
Expand Down
@@ -1,3 +1,7 @@
---
description: "Require explicit return and argument types on exported functions' and classes' public class methods."
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/explicit-module-boundary-types** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/func-call-spacing.md
@@ -1,3 +1,7 @@
---
description: 'Require or disallow spacing between function identifiers and their invocations.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/func-call-spacing** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/indent.md
@@ -1,3 +1,7 @@
---
description: 'Enforce consistent indentation.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/indent** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/init-declarations.md
@@ -1,3 +1,7 @@
---
description: 'Require or disallow initialization in variable declarations.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/init-declarations** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/keyword-spacing.md
@@ -1,3 +1,7 @@
---
description: 'Enforce consistent spacing before and after keywords.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/keyword-spacing** for documentation.
Expand Down
@@ -1,3 +1,7 @@
---
description: 'Require or disallow an empty line between class members.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/lines-between-class-members** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/member-delimiter-style.md
@@ -1,3 +1,7 @@
---
description: 'Require a specific member delimiter style for interfaces and type literals.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/member-delimiter-style** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/member-ordering.md
@@ -1,3 +1,7 @@
---
description: 'Require a consistent member declaration order.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/member-ordering** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/method-signature-style.md
@@ -1,3 +1,7 @@
---
description: 'Enforce using a particular method signature syntax.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/method-signature-style** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/naming-convention.md
@@ -1,3 +1,7 @@
---
description: 'Enforce naming conventions for everything across a codebase.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/naming-convention** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-array-constructor.md
@@ -1,3 +1,7 @@
---
description: 'Disallow generic `Array` constructors.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-array-constructor** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-base-to-string.md
@@ -1,3 +1,7 @@
---
description: 'Require `.toString()` to only be called on objects which provide useful information when stringified.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-base-to-string** for documentation.
Expand Down
@@ -1,3 +1,7 @@
---
description: 'Disallow non-null assertion in locations that may be confusing.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-confusing-non-null-assertion** for documentation.
Expand Down
@@ -1,3 +1,7 @@
---
description: 'Require expressions of type void to appear in statement position.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-confusing-void-expression** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-dupe-class-members.md
@@ -1,3 +1,7 @@
---
description: 'Disallow duplicate class members.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-dupe-class-members** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-duplicate-enum-values.md
@@ -1,3 +1,7 @@
---
description: 'Disallow duplicate enum member values.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-duplicate-enum-values** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-duplicate-imports.md
@@ -1,3 +1,7 @@
---
description: 'Disallow duplicate imports.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-duplicate-imports** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-dynamic-delete.md
@@ -1,3 +1,7 @@
---
description: 'Disallow using the `delete` operator on computed key expressions.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-dynamic-delete** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-empty-function.md
@@ -1,3 +1,7 @@
---
description: 'Disallow empty functions.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-empty-function** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-empty-interface.md
@@ -1,3 +1,7 @@
---
description: 'Disallow the declaration of empty interfaces.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-empty-interface** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-explicit-any.md
@@ -1,3 +1,7 @@
---
description: 'Disallow the `any` type.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-explicit-any** for documentation.
Expand Down
@@ -1,3 +1,7 @@
---
description: 'Disallow extra non-null assertion.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-extra-non-null-assertion** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-extra-parens.md
@@ -1,3 +1,7 @@
---
description: 'Disallow unnecessary parentheses.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-extra-parens** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-extra-semi.md
@@ -1,3 +1,7 @@
---
description: 'Disallow unnecessary semicolons.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-extra-semi** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-extraneous-class.md
@@ -1,3 +1,7 @@
---
description: 'Disallow classes used as namespaces.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-extraneous-class** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-floating-promises.md
@@ -1,3 +1,7 @@
---
description: 'Require Promise-like statements to be handled appropriately.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-floating-promises** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-for-in-array.md
@@ -1,3 +1,7 @@
---
description: 'Disallow iterating over an array with a for-in loop.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-for-in-array** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-implicit-any-catch.md
@@ -1,3 +1,7 @@
---
description: 'Disallow usage of the implicit `any` type in catch clauses.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-implicit-any-catch** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-implied-eval.md
@@ -1,3 +1,7 @@
---
description: 'Disallow the use of `eval()`-like methods.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-implied-eval** for documentation.
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/no-inferrable-types.md
@@ -1,3 +1,7 @@
---
description: 'Disallow explicit type declarations for variables or parameters initialized to a number, string, or boolean.'
---

> 🛑 This file is source code, not the primary documentation location! 🛑
>
> See **https://typescript-eslint.io/rules/no-inferrable-types** for documentation.
Expand Down