Skip to content

Commit b58b4a3

Browse files
JoshuaKGoldbergJoshuaKGoldberg
authored
fix: remove eslint-plugin-deprecation temporarily (#1470)
## PR Checklist - [x] Addresses an existing open issue: fixes #1469 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md) were taken ## Overview Alas.
1 parent ae44d67 commit b58b4a3

18 files changed

+5
-97
lines changed

‎.eslintrc.cjs

+1-9
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ module.exports = {
4545
},
4646
rules: {
4747
// These off-by-default rules work well for this repo and we like them on.
48-
"deprecation/deprecation": "error",
4948
"jsdoc/informative-docs": "error",
5049
"logical-assignment-operators": [
5150
"error",
@@ -140,14 +139,7 @@ module.exports = {
140139
},
141140
],
142141
parser: "@typescript-eslint/parser",
143-
plugins: [
144-
"@typescript-eslint",
145-
"deprecation",
146-
"jsdoc",
147-
"perfectionist",
148-
"regexp",
149-
"vitest",
150-
],
142+
plugins: ["@typescript-eslint", "jsdoc", "perfectionist", "regexp", "vitest"],
151143
reportUnusedDisableDirectives: true,
152144
root: true,
153145
rules: {

‎docs/Options.md

-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@ Alternately, you can bypass that prompt by providing any number of the following
8989
- `--exclude-lint-knip`: Don't add Knip to detect unused files, dependencies, and code exports.
9090
- `--exclude-lint-md`: Don't apply linting to `*.md` files.
9191
- `--exclude-lint-package-json`: Don't add eslint-plugin-package-json to lint for package.json correctness.
92-
- `--exclude-lint-deprecation`: Don't use eslint-plugin-deprecation to report on usage of code marked as `@deprecated`.
9392
- `--exclude-lint-eslint`: Don't use eslint-plugin-eslint-comment to enforce good practices around ESLint comment directives.
9493
- `--exclude-lint-jsdoc`: Don't use eslint-plugin-jsdoc to enforce good practices around JSDoc comments.
9594
- `--exclude-lint-packages`: Don't add a pnpm dedupe workflow to ensure packages aren't duplicated unnecessarily.

‎docs/Tooling.md

-6
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ This table summarizes each tooling piece and which base levels they're included
2323
| [Compliance](#compliance) | `--exclude-compliance` | | | 💯 |
2424
| [Contributors](#contributors) | `--exclude-contributors` | | ✅ | 💯 |
2525
| [Formatting](#formatting) | | ✔️ | ✅ | 💯 |
26-
| [Lint Deprecation](#lint-deprecation) | `--exclude-lint-deprecation` | | | 💯 |
2726
| [Lint ESLint](#lint-eslint) | `--exclude-lint-eslint` | | | 💯 |
2827
| [Lint JSDoc](#lint-jsdoc) | `--exclude-lint-jsdoc` | | | 💯 |
2928
| [Lint JSON](#lint-json) | `--exclude-lint-json` | | | 💯 |
@@ -220,7 +219,6 @@ This level is for developers who are eager to get the maximum tooling benefits i
220219
Using the _"everything"_ level will gain you comprehensive, strict coverage of all sorts of repository issues, including auto-sorting of properties and strict ESLint configs.
221220

222221
- [Compliance](#compliance)
223-
- [Lint Deprecation](#lint-deprecation)
224222
- [Lint ESLint](#lint-eslint)
225223
- [Lint JSDoc](#lint-jsdoc)
226224
- [Lint JSON](#lint-json)
@@ -238,10 +236,6 @@ Using the _"everything"_ level will gain you comprehensive, strict coverage of a
238236

239237
[**PR Compliance Action**](https://github.com/mtfoley/pr-compliance-action): Checks PRs for compliance such as addressing a linked issue and proper title formatting.
240238

241-
### Lint Deprecation
242-
243-
[`eslint-plugin-deprecation`](https://github.com/gund/eslint-plugin-deprecation): Reports on usage of code marked with `@deprecated`.
244-
245239
### Lint ESLint
246240

247241
[`eslint-plugin-eslint-comments`](https://github.com/mysticatea/eslint-plugin-eslint-comments): Enforces proper usage of [ESLint configuration comments](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments).

‎package.json

-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@
7171
"console-fail-test": "^0.2.3",
7272
"cspell": "^8.1.3",
7373
"eslint": "^8.55.0",
74-
"eslint-plugin-deprecation": "^2.0.0",
7574
"eslint-plugin-eslint-comments": "^3.2.0",
7675
"eslint-plugin-jsdoc": "^48.0.0",
7776
"eslint-plugin-jsonc": "^2.10.0",

‎pnpm-lock.yaml

-32
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/bin/help.test.ts

-5
Original file line numberDiff line numberDiff line change
@@ -202,11 +202,6 @@ describe("logHelpText", () => {
202202
--exclude-compliance: Don't add a GitHub Actions workflow to verify that PRs match
203203
an expected format.",
204204
],
205-
[
206-
"
207-
--exclude-lint-deprecation: Don't use eslint-plugin-deprecation to report on usage
208-
of code marked as @deprecated.",
209-
],
210205
[
211206
"
212207
--exclude-lint-jsdoc: Don't use eslint-plugin-jsdoc to enforce good practices around

‎src/shared/options/args.ts

-6
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,6 @@ export const allArgOptions = {
8787
docsSection: "opt-out",
8888
type: "boolean",
8989
},
90-
"exclude-lint-deprecation": {
91-
description: `Don't use eslint-plugin-deprecation to report on usage
92-
of code marked as ${chalk.cyanBright("@deprecated")}.`,
93-
docsSection: "opt-out",
94-
type: "boolean",
95-
},
9690
"exclude-lint-jsdoc": {
9791
description: `Don't use eslint-plugin-jsdoc to enforce good practices around
9892
JSDoc comments.`,

‎src/shared/options/augmentOptionsWithExcludes.test.ts

-4
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ const optionsBase = {
2828
},
2929
excludeAllContributors: undefined,
3030
excludeCompliance: undefined,
31-
excludeLintDeprecation: undefined,
3231
excludeLintESLint: undefined,
3332
excludeLintJSDoc: undefined,
3433
excludeLintJson: undefined,
@@ -86,7 +85,6 @@ describe("augmentOptionsWithExcludes", () => {
8685
base,
8786
excludeAllContributors: true,
8887
excludeCompliance: true,
89-
excludeLintDeprecation: true,
9088
excludeLintESLint: true,
9189
excludeLintJSDoc: true,
9290
excludeLintJson: true,
@@ -128,7 +126,6 @@ describe("augmentOptionsWithExcludes", () => {
128126
expect(actual).toEqual({
129127
...options,
130128
excludeCompliance: true,
131-
excludeLintDeprecation: true,
132129
excludeLintESLint: true,
133130
excludeLintJSDoc: true,
134131
excludeLintJson: true,
@@ -156,7 +153,6 @@ describe("augmentOptionsWithExcludes", () => {
156153
...options,
157154
excludeAllContributors: true,
158155
excludeCompliance: true,
159-
excludeLintDeprecation: true,
160156
excludeLintESLint: true,
161157
excludeLintJSDoc: true,
162158
excludeLintJson: true,

‎src/shared/options/exclusionKeys.ts

-6
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,6 @@ export const exclusionDescriptions: Record<ExclusionKey, ExclusionDescription> =
2121
"Add a GitHub Actions workflow to verify that PRs match an expected format.",
2222
uncommon: true,
2323
},
24-
excludeLintDeprecation: {
25-
hint: "--exclude-lint-deprecation",
26-
label:
27-
"Include an eslint-plugin-deprecation to reports on usage of code marked as @deprecated.",
28-
uncommon: true,
29-
},
3024
excludeLintESLint: {
3125
hint: "--exclude-lint-eslint",
3226
label:

‎src/shared/options/optionsSchema.ts

-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ export const optionsSchemaShape = {
2323
.optional(),
2424
excludeAllContributors: z.boolean().optional(),
2525
excludeCompliance: z.boolean().optional(),
26-
excludeLintDeprecation: z.boolean().optional(),
2726
excludeLintESLint: z.boolean().optional(),
2827
excludeLintJSDoc: z.boolean().optional(),
2928
excludeLintJson: z.boolean().optional(),

‎src/shared/options/readOptions.test.ts

-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ const emptyOptions = {
1717
email: undefined,
1818
excludeAllContributors: undefined,
1919
excludeCompliance: undefined,
20-
excludeLintDeprecation: undefined,
2120
excludeLintESLint: undefined,
2221
excludeLintJSDoc: undefined,
2322
excludeLintJson: undefined,
@@ -736,7 +735,6 @@ describe("readOptions", () => {
736735
},
737736
"excludeAllContributors": undefined,
738737
"excludeCompliance": undefined,
739-
"excludeLintDeprecation": undefined,
740738
"excludeLintESLint": undefined,
741739
"excludeLintJSDoc": undefined,
742740
"excludeLintJson": undefined,

‎src/shared/options/readOptions.ts

-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ export async function readOptions(
6767
: undefined,
6868
excludeAllContributors: values["exclude-all-contributors"],
6969
excludeCompliance: values["exclude-compliance"],
70-
excludeLintDeprecation: values["exclude-lint-deprecation"],
7170
excludeLintESLint: values["exclude-lint-eslint"],
7271
excludeLintJSDoc: values["exclude-lint-jsdoc"],
7372
excludeLintJson: values["exclude-lint-json"],

‎src/shared/types.ts

-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ export interface Options {
5555
email: OptionsEmail;
5656
excludeAllContributors?: boolean;
5757
excludeCompliance?: boolean;
58-
excludeLintDeprecation?: boolean;
5958
excludeLintESLint?: boolean;
6059
excludeLintJSDoc?: boolean;
6160
excludeLintJson?: boolean;

‎src/steps/finalizeDependencies.test.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ describe("finalize", () => {
3838
expect(mockExecaCommand.mock.calls).toMatchInlineSnapshot(`
3939
[
4040
[
41-
"pnpm add @release-it/conventional-changelog@latest @types/eslint@latest @typescript-eslint/eslint-plugin@latest @typescript-eslint/parser@latest @vitest/coverage-v8@latest all-contributors-cli@latest console-fail-test@latest cspell@latest eslint@latest eslint-plugin-deprecation@latest eslint-plugin-eslint-comments@latest eslint-plugin-jsdoc@latest eslint-plugin-jsonc@latest eslint-plugin-markdown@latest eslint-plugin-n@latest eslint-plugin-package-json@latest eslint-plugin-perfectionist@latest eslint-plugin-regexp@latest eslint-plugin-vitest@latest eslint-plugin-yml@latest husky@latest jsonc-eslint-parser@latest knip@latest lint-staged@latest markdownlint@latest markdownlint-cli@latest prettier@latest prettier-plugin-curly@latest prettier-plugin-packagejson@latest release-it@latest sentences-per-line@latest tsup@latest typescript@latest vitest@latest yaml-eslint-parser@latest -D",
41+
"pnpm add @release-it/conventional-changelog@latest @types/eslint@latest @typescript-eslint/eslint-plugin@latest @typescript-eslint/parser@latest @vitest/coverage-v8@latest all-contributors-cli@latest console-fail-test@latest cspell@latest eslint@latest eslint-plugin-eslint-comments@latest eslint-plugin-jsdoc@latest eslint-plugin-jsonc@latest eslint-plugin-markdown@latest eslint-plugin-n@latest eslint-plugin-package-json@latest eslint-plugin-perfectionist@latest eslint-plugin-regexp@latest eslint-plugin-vitest@latest eslint-plugin-yml@latest husky@latest jsonc-eslint-parser@latest knip@latest lint-staged@latest markdownlint@latest markdownlint-cli@latest prettier@latest prettier-plugin-curly@latest prettier-plugin-packagejson@latest release-it@latest sentences-per-line@latest tsup@latest typescript@latest vitest@latest yaml-eslint-parser@latest -D",
4242
],
4343
[
4444
"npx all-contributors-cli generate",
@@ -59,7 +59,7 @@ describe("finalize", () => {
5959
expect(mockExecaCommand.mock.calls).toMatchInlineSnapshot(`
6060
[
6161
[
62-
"pnpm add @release-it/conventional-changelog@latest @types/eslint@latest @typescript-eslint/eslint-plugin@latest @typescript-eslint/parser@latest @vitest/coverage-v8@latest all-contributors-cli@latest console-fail-test@latest cspell@latest eslint@latest eslint-plugin-deprecation@latest eslint-plugin-eslint-comments@latest eslint-plugin-jsdoc@latest eslint-plugin-jsonc@latest eslint-plugin-markdown@latest eslint-plugin-n@latest eslint-plugin-package-json@latest eslint-plugin-perfectionist@latest eslint-plugin-regexp@latest eslint-plugin-vitest@latest eslint-plugin-yml@latest husky@latest jsonc-eslint-parser@latest knip@latest lint-staged@latest markdownlint@latest markdownlint-cli@latest prettier@latest prettier-plugin-curly@latest prettier-plugin-packagejson@latest release-it@latest sentences-per-line@latest tsup@latest typescript@latest vitest@latest yaml-eslint-parser@latest -D --offline",
62+
"pnpm add @release-it/conventional-changelog@latest @types/eslint@latest @typescript-eslint/eslint-plugin@latest @typescript-eslint/parser@latest @vitest/coverage-v8@latest all-contributors-cli@latest console-fail-test@latest cspell@latest eslint@latest eslint-plugin-eslint-comments@latest eslint-plugin-jsdoc@latest eslint-plugin-jsonc@latest eslint-plugin-markdown@latest eslint-plugin-n@latest eslint-plugin-package-json@latest eslint-plugin-perfectionist@latest eslint-plugin-regexp@latest eslint-plugin-vitest@latest eslint-plugin-yml@latest husky@latest jsonc-eslint-parser@latest knip@latest lint-staged@latest markdownlint@latest markdownlint-cli@latest prettier@latest prettier-plugin-curly@latest prettier-plugin-packagejson@latest release-it@latest sentences-per-line@latest tsup@latest typescript@latest vitest@latest yaml-eslint-parser@latest -D --offline",
6363
],
6464
[
6565
"npx all-contributors-cli generate",
@@ -92,7 +92,7 @@ describe("finalize", () => {
9292
expect(mockExecaCommand.mock.calls).toMatchInlineSnapshot(`
9393
[
9494
[
95-
"pnpm add @types/eslint@latest @typescript-eslint/eslint-plugin@latest @typescript-eslint/parser@latest eslint@latest eslint-plugin-deprecation@latest eslint-plugin-eslint-comments@latest eslint-plugin-jsdoc@latest eslint-plugin-n@latest eslint-plugin-regexp@latest husky@latest lint-staged@latest prettier@latest prettier-plugin-curly@latest prettier-plugin-packagejson@latest tsup@latest typescript@latest -D",
95+
"pnpm add @types/eslint@latest @typescript-eslint/eslint-plugin@latest @typescript-eslint/parser@latest eslint@latest eslint-plugin-eslint-comments@latest eslint-plugin-jsdoc@latest eslint-plugin-n@latest eslint-plugin-regexp@latest husky@latest lint-staged@latest prettier@latest prettier-plugin-curly@latest prettier-plugin-packagejson@latest tsup@latest typescript@latest -D",
9696
],
9797
[
9898
"pnpm dedupe",

‎src/steps/finalizeDependencies.ts

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ export async function finalizeDependencies(options: Options) {
99
"@typescript-eslint/eslint-plugin",
1010
"@typescript-eslint/parser",
1111
"eslint",
12-
"eslint-plugin-deprecation",
1312
"eslint-plugin-eslint-comments",
1413
"eslint-plugin-jsdoc",
1514
"eslint-plugin-n",

‎src/steps/writing/creation/createESLintRC.test.ts

+1-11
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ function fakeOptions(getExcludeValue: (exclusionName: string) => boolean) {
1818
[
1919
"excludeCompliance",
2020
"excludeAllContributors",
21-
"excludeLintDeprecation",
2221
"excludeLintESLint",
2322
"excludeLintJSDoc",
2423
"excludeLintJson",
@@ -72,7 +71,6 @@ describe("createESLintRC", () => {
7271
},
7372
rules: {
7473
// These off-by-default rules work well for this repo and we like them on.
75-
"deprecation/deprecation": "error",
7674
"logical-assignment-operators": [
7775
"error",
7876
"always",
@@ -146,7 +144,6 @@ describe("createESLintRC", () => {
146144
},
147145
rules: {
148146
// These off-by-default rules work well for this repo and we like them on.
149-
"deprecation/deprecation": "error",
150147
"jsdoc/informative-docs": "error",
151148
"logical-assignment-operators": [
152149
"error",
@@ -222,14 +219,7 @@ describe("createESLintRC", () => {
222219
},
223220
],
224221
parser: "@typescript-eslint/parser",
225-
plugins: [
226-
"@typescript-eslint",
227-
"deprecation",
228-
"jsdoc",
229-
"perfectionist",
230-
"regexp",
231-
"vitest",
232-
],
222+
plugins: ["@typescript-eslint", "jsdoc", "perfectionist", "regexp", "vitest"],
233223
reportUnusedDisableDirectives: true,
234224
root: true,
235225
rules: {

‎src/steps/writing/creation/createESLintRC.ts

-6
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ module.exports = {
6666
},
6767
rules: {
6868
// These off-by-default rules work well for this repo and we like them on.
69-
"deprecation/deprecation": "error",
7069
${
7170
options.excludeLintJSDoc
7271
? ""
@@ -169,11 +168,6 @@ module.exports = {
169168
plugins: [
170169
"@typescript-eslint",
171170
${
172-
options.excludeLintDeprecation
173-
? ""
174-
: `"deprecation",
175-
`
176-
}${
177171
options.excludeLintJSDoc
178172
? ""
179173
: `"jsdoc",

‎src/steps/writing/creation/dotVSCode.test.ts

-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ function fakeOptions(
2323
[
2424
"excludeCompliance",
2525
"excludeAllContributors",
26-
"excludeLintDeprecation",
2726
"excludeLintESLint",
2827
"excludeLintJSDoc",
2928
"excludeLintJson",

0 commit comments

Comments
 (0)