From 44f7de5ee4d934dee540d3d55305126c670f6bfc Mon Sep 17 00:00:00 2001 From: TagawaHirotaka Date: Tue, 24 Aug 2021 22:11:37 +0900 Subject: [PATCH] Docs: Update deprecated information (#14961) --- docs/rules/lines-around-comment.md | 2 ++ lib/rules/callback-return.js | 1 + lib/rules/global-require.js | 1 + lib/rules/handle-callback-err.js | 1 + lib/rules/id-blacklist.js | 1 + lib/rules/indent-legacy.js | 1 + lib/rules/lines-around-directive.js | 2 +- lib/rules/newline-after-var.js | 2 +- lib/rules/newline-before-return.js | 2 +- lib/rules/no-buffer-constructor.js | 1 + lib/rules/no-mixed-requires.js | 1 + lib/rules/no-new-require.js | 1 + lib/rules/no-path-concat.js | 1 + lib/rules/no-process-env.js | 1 + lib/rules/no-process-exit.js | 1 + lib/rules/no-restricted-modules.js | 1 + lib/rules/no-sync.js | 1 + lib/rules/require-jsdoc.js | 1 + lib/rules/valid-jsdoc.js | 1 + 19 files changed, 20 insertions(+), 3 deletions(-) diff --git a/docs/rules/lines-around-comment.md b/docs/rules/lines-around-comment.md index ae543bd837b..70282513da0 100644 --- a/docs/rules/lines-around-comment.md +++ b/docs/rules/lines-around-comment.md @@ -1,5 +1,7 @@ # require empty lines around comments (lines-around-comment) +This rule was **deprecated** in ESLint v4.0.0 and replaced by the [`padding-line-between-statements`](padding-line-between-statements.md) rule. + Many style guides require empty lines before or after comments. The primary goal of these rules is to make the comments easier to read and improve readability of the code. diff --git a/lib/rules/callback-return.js b/lib/rules/callback-return.js index 9cc9089fbff..449b9a96227 100644 --- a/lib/rules/callback-return.js +++ b/lib/rules/callback-return.js @@ -1,6 +1,7 @@ /** * @fileoverview Enforce return after a callback. * @author Jamund Ferguson + * @deprecated in ESLint v7.0.0 */ "use strict"; diff --git a/lib/rules/global-require.js b/lib/rules/global-require.js index aa8508eb566..f2d29d1df5a 100644 --- a/lib/rules/global-require.js +++ b/lib/rules/global-require.js @@ -1,6 +1,7 @@ /** * @fileoverview Rule for disallowing require() outside of the top-level module context * @author Jamund Ferguson + * @deprecated in ESLint v7.0.0 */ "use strict"; diff --git a/lib/rules/handle-callback-err.js b/lib/rules/handle-callback-err.js index 2f782e7e8aa..cdb3a7642ea 100644 --- a/lib/rules/handle-callback-err.js +++ b/lib/rules/handle-callback-err.js @@ -1,6 +1,7 @@ /** * @fileoverview Ensure handling of errors when we know they exist. * @author Jamund Ferguson + * @deprecated in ESLint v7.0.0 */ "use strict"; diff --git a/lib/rules/id-blacklist.js b/lib/rules/id-blacklist.js index 3723651ba57..77deac70708 100644 --- a/lib/rules/id-blacklist.js +++ b/lib/rules/id-blacklist.js @@ -2,6 +2,7 @@ * @fileoverview Rule that warns when identifier names that are * specified in the configuration are used. * @author Keith Cirkel (http://keithcirkel.co.uk) + * @deprecated in ESLint v7.5.0 */ "use strict"; diff --git a/lib/rules/indent-legacy.js b/lib/rules/indent-legacy.js index 68bd9db99ed..54ca9ddd138 100644 --- a/lib/rules/indent-legacy.js +++ b/lib/rules/indent-legacy.js @@ -4,6 +4,7 @@ * This rule has been ported and modified from nodeca. * @author Vitaly Puzrin * @author Gyandeep Singh + * @deprecated in ESLint v4.0.0 */ "use strict"; diff --git a/lib/rules/lines-around-directive.js b/lib/rules/lines-around-directive.js index 39782aaf7ec..c0c70e1a61f 100644 --- a/lib/rules/lines-around-directive.js +++ b/lib/rules/lines-around-directive.js @@ -1,7 +1,7 @@ /** * @fileoverview Require or disallow newlines around directives. * @author Kai Cataldo - * @deprecated + * @deprecated in ESLint v4.0.0 */ "use strict"; diff --git a/lib/rules/newline-after-var.js b/lib/rules/newline-after-var.js index 05fb39493ab..3eea1b1f732 100644 --- a/lib/rules/newline-after-var.js +++ b/lib/rules/newline-after-var.js @@ -1,7 +1,7 @@ /** * @fileoverview Rule to check empty newline after "var" statement * @author Gopal Venkatesan - * @deprecated + * @deprecated in ESLint v4.0.0 */ "use strict"; diff --git a/lib/rules/newline-before-return.js b/lib/rules/newline-before-return.js index c2680c606dc..93939024ca0 100644 --- a/lib/rules/newline-before-return.js +++ b/lib/rules/newline-before-return.js @@ -1,7 +1,7 @@ /** * @fileoverview Rule to require newlines before `return` statement * @author Kai Cataldo - * @deprecated + * @deprecated in ESLint v4.0.0 */ "use strict"; diff --git a/lib/rules/no-buffer-constructor.js b/lib/rules/no-buffer-constructor.js index 832287607f3..cc5906e78a3 100644 --- a/lib/rules/no-buffer-constructor.js +++ b/lib/rules/no-buffer-constructor.js @@ -1,6 +1,7 @@ /** * @fileoverview disallow use of the Buffer() constructor * @author Teddy Katz + * @deprecated in ESLint v7.0.0 */ "use strict"; diff --git a/lib/rules/no-mixed-requires.js b/lib/rules/no-mixed-requires.js index de981d7b33a..f7c2d11ee4f 100644 --- a/lib/rules/no-mixed-requires.js +++ b/lib/rules/no-mixed-requires.js @@ -1,6 +1,7 @@ /** * @fileoverview Rule to enforce grouped require statements for Node.JS * @author Raphael Pigulla + * @deprecated in ESLint v7.0.0 */ "use strict"; diff --git a/lib/rules/no-new-require.js b/lib/rules/no-new-require.js index 12745c02b71..7973f8f2a27 100644 --- a/lib/rules/no-new-require.js +++ b/lib/rules/no-new-require.js @@ -1,6 +1,7 @@ /** * @fileoverview Rule to disallow use of new operator with the `require` function * @author Wil Moore III + * @deprecated in ESLint v7.0.0 */ "use strict"; diff --git a/lib/rules/no-path-concat.js b/lib/rules/no-path-concat.js index 0671e511e86..184c9182b4d 100644 --- a/lib/rules/no-path-concat.js +++ b/lib/rules/no-path-concat.js @@ -1,6 +1,7 @@ /** * @fileoverview Disallow string concatenation when using __dirname and __filename * @author Nicholas C. Zakas + * @deprecated in ESLint v7.0.0 */ "use strict"; diff --git a/lib/rules/no-process-env.js b/lib/rules/no-process-env.js index 3ba66d6f5a2..c61b5572314 100644 --- a/lib/rules/no-process-env.js +++ b/lib/rules/no-process-env.js @@ -1,6 +1,7 @@ /** * @fileoverview Disallow the use of process.env() * @author Vignesh Anand + * @deprecated in ESLint v7.0.0 */ "use strict"; diff --git a/lib/rules/no-process-exit.js b/lib/rules/no-process-exit.js index de6de4fabc4..73310a9e4e6 100644 --- a/lib/rules/no-process-exit.js +++ b/lib/rules/no-process-exit.js @@ -1,6 +1,7 @@ /** * @fileoverview Disallow the use of process.exit() * @author Nicholas C. Zakas + * @deprecated in ESLint v7.0.0 */ "use strict"; diff --git a/lib/rules/no-restricted-modules.js b/lib/rules/no-restricted-modules.js index ebf88dcb6ce..66e6fe49e31 100644 --- a/lib/rules/no-restricted-modules.js +++ b/lib/rules/no-restricted-modules.js @@ -1,6 +1,7 @@ /** * @fileoverview Restrict usage of specified node modules. * @author Christian Schulz + * @deprecated in ESLint v7.0.0 */ "use strict"; diff --git a/lib/rules/no-sync.js b/lib/rules/no-sync.js index a67eb8acf49..ea40df12933 100644 --- a/lib/rules/no-sync.js +++ b/lib/rules/no-sync.js @@ -1,6 +1,7 @@ /** * @fileoverview Rule to check for properties whose identifier ends with the string Sync * @author Matt DuVall + * @deprecated in ESLint v7.0.0 */ "use strict"; diff --git a/lib/rules/require-jsdoc.js b/lib/rules/require-jsdoc.js index f1c21688d48..1d76e3d222b 100644 --- a/lib/rules/require-jsdoc.js +++ b/lib/rules/require-jsdoc.js @@ -1,6 +1,7 @@ /** * @fileoverview Rule to check for jsdoc presence. * @author Gyandeep Singh + * @deprecated in ESLint v5.10.0 */ "use strict"; diff --git a/lib/rules/valid-jsdoc.js b/lib/rules/valid-jsdoc.js index 02abd7065d9..824410b3370 100644 --- a/lib/rules/valid-jsdoc.js +++ b/lib/rules/valid-jsdoc.js @@ -1,6 +1,7 @@ /** * @fileoverview Validates JSDoc comments are syntactically correct * @author Nicholas C. Zakas + * @deprecated in ESLint v5.10.0 */ "use strict";