Skip to content

Commit

Permalink
docs: add tombstone file for no-parameter-properties and suggested re…
Browse files Browse the repository at this point in the history
…placements for deprecated rules in v6 (#8104)

* Add redirection file for no-parameter-peroperties, indicate replacements in 2023-07-09 blog post to announce v6

* Add link for useUnknownInCatchVariables for no-implicit-any-catch's suggested replacement

* Add no-parameter-properties.md to ignored files in validating rules docs describe block
  • Loading branch information
peanutenthusiast committed Dec 24, 2023
1 parent 4184c5e commit f6f6a57
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 4 deletions.
12 changes: 12 additions & 0 deletions packages/eslint-plugin/docs/rules/no-parameter-properties.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
:::danger Deprecated

This rule has been deprecated in favour of the [`parameter-properties`](https://typescript-eslint.io/rules/parameter-properties/) rule.

:::

<!--
This doc file has been left on purpose to help direct people to the replacement rule.
Note that there is no actual way to get to this page in the normal navigation,
so end-users will only be able to get to this page from the search bar.
-->
1 change: 1 addition & 0 deletions packages/eslint-plugin/tests/docs.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ describe('Validating rule docs', () => {
// comments in the files for more information.
'camelcase.md',
'no-duplicate-imports.md',
'no-parameter-properties.md',
]);
it('All rules must have a corresponding rule doc', () => {
const files = fs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -481,10 +481,10 @@ console.log(
Several rules were changed in significant enough ways to be considered breaking changes:

- Previously deprecated rules are deleted ([chore(eslint-plugin): remove deprecated rules for v6](https://github.com/typescript-eslint/typescript-eslint/pull/6112)):
- `@typescript-eslint/no-duplicate-imports`
- `@typescript-eslint/no-implicit-any-catch`
- `@typescript-eslint/no-parameter-properties`
- `@typescript-eslint/sort-type-union-intersection-members`
- `@typescript-eslint/no-duplicate-imports`, replaced by `imports/no-duplicates`
- `@typescript-eslint/no-implicit-any-catch`, replaced by the TSConfig option [`useUnknownInCatchVariables`](https://www.typescriptlang.org/tsconfig#useUnknownInCatchVariables)
- `@typescript-eslint/no-parameter-properties`, replaced by `@typescript-eslint/parameter-properties`
- `@typescript-eslint/sort-type-union-intersection-members`, replaced by `@typescript-eslint/sort-type-constituents`
- [feat(eslint-plugin): [prefer-nullish-coalescing]: add support for assignment expressions](https://github.com/typescript-eslint/typescript-eslint/pull/5234): Enhances the [`@typescript-eslint/prefer-nullish-coalescing`](https://typescript-eslint.io/prefer-nullish-coalescing) rule to also check `||=` expressions.
- [feat(eslint-plugin): [prefer-optional-chain] use type checking for strict falsiness](https://github.com/typescript-eslint/typescript-eslint/pull/6240): Fixes edge case bugs in the [`@typescript-eslint/prefer-optional-chain`](https://typescript-eslint.io/prefer-optional-chain) rule around false positives, at the cost of making it require type information.
-[feat(eslint-plugin): [restrict-plus-operands] change checkCompoundAssignments to skipCompoundAssignments](https://github.com/typescript-eslint/typescript-eslint/pull/7027): inverses the logical value of the option and renames it
Expand Down

0 comments on commit f6f6a57

Please sign in to comment.