Skip to content

chore(website): automate the addition of rule attributes to the website #5085

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

Merged
merged 3 commits into from
May 30, 2022
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,3 @@ const defaultOptions: Options = {

To fill out: why wouldn't you want to use this rule?
For example if this rule requires a feature released in a certain TS version.

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [ ] 🔧 Fixable
- [ ] 💭 Requires type information
Original file line number Diff line number Diff line change
Expand Up @@ -104,11 +104,3 @@ If you don't care about the general structure of the code, then you will not nee
## Related To

- TSLint: [adjacent-overload-signatures](https://palantir.github.io/tslint/rules/adjacent-overload-signatures/)

## Attributes

- Configs:
- [x] ✅ Recommended
- [x] 🔒 Strict
- [ ] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/array-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,3 @@ This matrix lists all possible option combinations and their expected results fo
## Related To

- TSLint: [array-type](https://palantir.github.io/tslint/rules/array-type/)

## Attributes

- Configs:
- [ ] ✅ Recommended
- [x] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/await-thenable.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,3 @@ This is generally not preferred, but can sometimes be useful for visual consiste
## Related To

- TSLint: ['await-promise'](https://palantir.github.io/tslint/rules/await-promise)

## Attributes

- Configs:
- [x] ✅ Recommended
- [x] 🔒 Strict
- [ ] 🔧 Fixable
- [x] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/ban-ts-comment.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,3 @@ If you want to use all of the TypeScript directives.
## Related To

- TSLint: [ban-ts-ignore](https://palantir.github.io/tslint/rules/ban-ts-ignore/)

## Attributes

- Configs:
- [x] ✅ Recommended
- [x] 🔒 Strict
- [ ] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/ban-tslint-comment.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,3 @@ This rule is not configurable.
## When Not To Use It

If you are still using TSLint.

## Attributes

- Configs:
- [ ] ✅ Recommended
- [x] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/ban-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,11 +201,3 @@ const curly2: Record<'a', string> = { a: 'string' };
## Related To

- TSLint: [ban-types](https://palantir.github.io/tslint/rules/ban-types)

## Attributes

- Configs:
- [x] ✅ Recommended
- [x] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/brace-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,3 @@ See [`eslint/brace-style` options](https://eslint.org/docs/rules/brace-style#opt
Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/brace-style.md)

</sup>

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,3 @@ class Mx {

When you have no strong preference, or do not wish to enforce a particular style
for how literal values are exposed by your classes.

## Attributes

- Configs:
- [ ] ✅ Recommended
- [x] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/comma-dangle.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,3 @@ This rule has a string option and an object option.
Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/comma-dangle.md)

</sup>

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/comma-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,3 @@ See [`eslint/comma-spacing` options](https://eslint.org/docs/rules/comma-spacing
Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/comma-spacing.md)

</sup>

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,3 @@ type Foo = {
[key: string]: unknown;
};
```

## Attributes

- Configs:
- [ ] ✅ Recommended
- [x] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
Original file line number Diff line number Diff line change
Expand Up @@ -116,11 +116,3 @@ If you do not want to enforce consistent type assertions.

- TSLint: [no-angle-bracket-type-assertion](https://palantir.github.io/tslint/rules/no-angle-bracket-type-assertion/)
- TSLint: [no-object-literal-type-assertion](https://palantir.github.io/tslint/rules/no-object-literal-type-assertion/)

## Attributes

- Configs:
- [ ] ✅ Recommended
- [x] 🔒 Strict
- [ ] 🔧 Fixable
- [ ] 💭 Requires type information
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,3 @@ If you specifically want to use an interface or type literal for stylistic reaso
## Related To

- TSLint: [interface-over-type-literal](https://palantir.github.io/tslint/rules/interface-over-type-literal/)

## Attributes

- Configs:
- [ ] ✅ Recommended
- [x] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/consistent-type-exports.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,3 @@ export { Button, type ButtonProps } from 'some-library';
- If you are using a TypeScript version less than 3.8, then you will not be able to use this rule as type exports are not supported.
- If you specifically want to use both export kinds for stylistic reasons, you can disable this rule.
- If you use `--isolatedModules` the compiler would error if a type is not re-exported using `export type`. If you also don't wish to enforce one style over the other, you can disable this rule.

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [x] 🔧 Fixable
- [x] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/consistent-type-imports.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,3 @@ const x: import('Bar') = 1;

- If you are not using TypeScript 3.8 (or greater), then you will not be able to use this rule, as type-only imports are not allowed.
- If you specifically want to use both import kinds for stylistic reasons, you can disable this rule.

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/default-param-last.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,3 @@ See [`eslint/default-param-last` options](https://eslint.org/docs/rules/default-
Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/default-param-last.md)

</sup>

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [ ] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/dot-notation.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,3 @@ If the TypeScript compiler option `noPropertyAccessFromIndexSignature` is set to
Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/dot-notation.md)

</sup>

## Attributes

- Configs:
- [ ] ✅ Recommended
- [x] 🔒 Strict
- [x] 🔧 Fixable
- [x] 💭 Requires type information
Original file line number Diff line number Diff line change
Expand Up @@ -290,11 +290,3 @@ you will not need this rule.
## Further Reading

- TypeScript [Functions](https://www.typescriptlang.org/docs/handbook/functions.html#function-types)

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [ ] 🔧 Fixable
- [ ] 💭 Requires type information
Original file line number Diff line number Diff line change
Expand Up @@ -348,11 +348,3 @@ If you think defaulting to public is a good default, then you should consider us
## Related To

- TSLint: [member-access](http://palantir.github.io/tslint/rules/member-access/)

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
Original file line number Diff line number Diff line change
Expand Up @@ -285,11 +285,3 @@ If you wish to make sure all functions have explicit return types, as opposed to
## Further Reading

- TypeScript [Functions](https://www.typescriptlang.org/docs/handbook/functions.html#function-types)

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [ ] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/func-call-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,3 @@ See [`eslint/func-call-spacing` options](https://eslint.org/docs/rules/func-call
Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/func-call-spacing.md)

</sup>

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/indent.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,3 @@ See [`eslint/indent` options](https://eslint.org/docs/rules/indent#options).
Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/indent.md)

</sup>

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/init-declarations.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,3 @@ See [`eslint/init-declarations` options](https://eslint.org/docs/rules/init-decl
Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/init-declarations.md)

</sup>

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [ ] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/keyword-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,3 @@ See [`eslint/keyword-spacing` options](https://eslint.org/docs/rules/keyword-spa
Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/keyword-spacing.md)

</sup>

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,3 @@ class foo {
Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/lines-between-class-members.md)

</sup>

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/member-delimiter-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,11 +208,3 @@ type FooBar = { name: string; greet(): string }
## When Not To Use It

If you don't care about enforcing a consistent member delimiter in interfaces and type literals, then you will not need this rule.

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/member-ordering.md
Original file line number Diff line number Diff line change
Expand Up @@ -1163,11 +1163,3 @@ If you don't care about the general order of your members, then you will not nee
## Related To

- TSLint: [member-ordering](https://palantir.github.io/tslint/rules/member-ordering/)

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [ ] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/method-signature-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,11 +104,3 @@ type T2 = {
## When Not To Use It

If you don't want to enforce a particular style for object/interface function types, and/or if you don't use `strictFunctionTypes`, then you don't need this rule.

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/naming-convention.md
Original file line number Diff line number Diff line change
Expand Up @@ -700,11 +700,3 @@ You can use the `destructured` modifier to match these names, and explicitly set
## When Not To Use It

If you do not want to enforce naming conventions for anything.

## Attributes

- Configs:
- [ ] ✅ Recommended
- [ ] 🔒 Strict
- [ ] 🔧 Fixable
- [x] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/no-array-constructor.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,3 @@ See [`eslint/no-array-constructor` options](https://eslint.org/docs/rules/no-arr
Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-array-constructor.md)

</sup>

## Attributes

- Configs:
- [x] ✅ Recommended
- [x] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
8 changes: 0 additions & 8 deletions packages/eslint-plugin/docs/rules/no-base-to-string.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,3 @@ let text = `${value}`;
If you don't mind `"[object Object]"` in your strings, then you will not need this rule.

- [`Object.prototype.toString()` MDN documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/toString)

## Attributes

- Configs:
- [ ] ✅ Recommended
- [x] 🔒 Strict
- [ ] 🔧 Fixable
- [x] 💭 Requires type information
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,3 @@ If you don't care about this confusion, then you will not need this rule.
## Further Reading

- [`Issue: Easy misunderstanding: "! ==="`](https://github.com/microsoft/TypeScript/issues/37837) in [TypeScript repo](https://github.com/microsoft/TypeScript)

## Attributes

- Configs:
- [ ] ✅ Recommended
- [x] 🔒 Strict
- [x] 🔧 Fixable
- [ ] 💭 Requires type information
Loading