Generate @deprecated

Author: Shinigami92

scripts/generate-rule-files.ts

@@ -84,6 +84,8 @@ async function main(): Promise<void> {
         }
         const seeDocLink: string = meta?.docs?.url ? `@see [${ruleName}](${meta.docs.url})` : '';
 
+        const deprecated: boolean | undefined = meta?.deprecated;
+
         const schema: JSONSchema4 | JSONSchema4[] | undefined = meta?.schema;
         const mainSchema: JSONSchema4 | undefined = Array.isArray(schema) ? schema[0] : schema;
         const sideSchema: JSONSchema4 | undefined =
@@ -168,20 +170,38 @@ export type ${ruleNamePascalCase}Options = [${ruleNamePascalCase}Option?${
         ruleContent += `
 
   /**
-   * ${description}
+   * ${description}${
+          deprecated
+            ? `
+   *
+   * @deprecated`
+            : ''
+        }
    *
    * ${seeDocLink}
    */
   export type ${ruleNamePascalCase}RuleConfig = RuleConfig<${mainSchema ? `${ruleNamePascalCase}Options` : '[]'}>;
 
   /**
-   * ${description}
+   * ${description}${
+          deprecated
+            ? `
+   *
+   * @deprecated`
+            : ''
+        }
    *
    * ${seeDocLink}
    */
   export interface ${ruleNamePascalCase}Rule {
     /**
-     * ${description}
+     * ${description}${
+          deprecated
+            ? `
+     *
+     * @deprecated`
+            : ''
+        }
      *
      * ${seeDocLink}
      */
@@ -193,7 +213,9 @@ export type ${ruleNamePascalCase}Options = [${ruleNamePascalCase}Option?${
         ruleContent = format(ruleContent, PRETTIER_OPTIONS);
         fs.writeFileSync(rulePath, ruleContent);
       } catch (error) {
-        console.log(`Failed to generate rule ${ruleName} for ${name}`, error);
+        if (error instanceof Error) {
+          console.error(`Failed to generate rule '${ruleName}' for ${name}.\n`, error.stack, '\n');
+        }
         failedRules.push(ruleName);
       }
     }

src/rules/eslint/callback-return.d.ts

@@ -13,19 +13,25 @@ export type CallbackReturnOptions = [CallbackReturnOption?];
 /**
  * Require `return` statements after callbacks.
  *
+ * @deprecated
+ *
  * @see [callback-return](https://eslint.org/docs/rules/callback-return)
  */
 export type CallbackReturnRuleConfig = RuleConfig<CallbackReturnOptions>;
 
 /**
  * Require `return` statements after callbacks.
  *
+ * @deprecated
+ *
  * @see [callback-return](https://eslint.org/docs/rules/callback-return)
  */
 export interface CallbackReturnRule {
   /**
    * Require `return` statements after callbacks.
    *
+   * @deprecated
+   *
    * @see [callback-return](https://eslint.org/docs/rules/callback-return)
    */
   'callback-return': CallbackReturnRuleConfig;

src/rules/eslint/global-require.d.ts

@@ -3,19 +3,25 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Require `require()` calls to be placed at top-level module scope.
  *
+ * @deprecated
+ *
  * @see [global-require](https://eslint.org/docs/rules/global-require)
  */
 export type GlobalRequireRuleConfig = RuleConfig<[]>;
 
 /**
  * Require `require()` calls to be placed at top-level module scope.
  *
+ * @deprecated
+ *
  * @see [global-require](https://eslint.org/docs/rules/global-require)
  */
 export interface GlobalRequireRule {
   /**
    * Require `require()` calls to be placed at top-level module scope.
    *
+   * @deprecated
+   *
    * @see [global-require](https://eslint.org/docs/rules/global-require)
    */
   'global-require': GlobalRequireRuleConfig;

src/rules/eslint/handle-callback-err.d.ts

@@ -13,19 +13,25 @@ export type HandleCallbackErrOptions = [HandleCallbackErrOption?];
 /**
  * Require error handling in callbacks.
  *
+ * @deprecated
+ *
  * @see [handle-callback-err](https://eslint.org/docs/rules/handle-callback-err)
  */
 export type HandleCallbackErrRuleConfig = RuleConfig<HandleCallbackErrOptions>;
 
 /**
  * Require error handling in callbacks.
  *
+ * @deprecated
+ *
  * @see [handle-callback-err](https://eslint.org/docs/rules/handle-callback-err)
  */
 export interface HandleCallbackErrRule {
   /**
    * Require error handling in callbacks.
    *
+   * @deprecated
+   *
    * @see [handle-callback-err](https://eslint.org/docs/rules/handle-callback-err)
    */
   'handle-callback-err': HandleCallbackErrRuleConfig;

src/rules/eslint/indent-legacy.d.ts

@@ -46,19 +46,25 @@ export type IndentLegacyOptions = [IndentLegacyOption?, IndentLegacyConfig?];
 /**
  * Enforce consistent indentation.
  *
+ * @deprecated
+ *
  * @see [indent-legacy](https://eslint.org/docs/rules/indent-legacy)
  */
 export type IndentLegacyRuleConfig = RuleConfig<IndentLegacyOptions>;
 
 /**
  * Enforce consistent indentation.
  *
+ * @deprecated
+ *
  * @see [indent-legacy](https://eslint.org/docs/rules/indent-legacy)
  */
 export interface IndentLegacyRule {
   /**
    * Enforce consistent indentation.
    *
+   * @deprecated
+   *
    * @see [indent-legacy](https://eslint.org/docs/rules/indent-legacy)
    */
   'indent-legacy': IndentLegacyRuleConfig;

src/rules/eslint/lines-around-directive.d.ts

@@ -18,19 +18,25 @@ export type LinesAroundDirectiveOptions = [LinesAroundDirectiveOption?];
 /**
  * Require or disallow newlines around directives.
  *
+ * @deprecated
+ *
  * @see [lines-around-directive](https://eslint.org/docs/rules/lines-around-directive)
  */
 export type LinesAroundDirectiveRuleConfig = RuleConfig<LinesAroundDirectiveOptions>;
 
 /**
  * Require or disallow newlines around directives.
  *
+ * @deprecated
+ *
  * @see [lines-around-directive](https://eslint.org/docs/rules/lines-around-directive)
  */
 export interface LinesAroundDirectiveRule {
   /**
    * Require or disallow newlines around directives.
    *
+   * @deprecated
+   *
    * @see [lines-around-directive](https://eslint.org/docs/rules/lines-around-directive)
    */
   'lines-around-directive': LinesAroundDirectiveRuleConfig;

src/rules/eslint/newline-after-var.d.ts

@@ -13,19 +13,25 @@ export type NewlineAfterVarOptions = [NewlineAfterVarOption?];
 /**
  * Require or disallow an empty line after variable declarations.
  *
+ * @deprecated
+ *
  * @see [newline-after-var](https://eslint.org/docs/rules/newline-after-var)
  */
 export type NewlineAfterVarRuleConfig = RuleConfig<NewlineAfterVarOptions>;
 
 /**
  * Require or disallow an empty line after variable declarations.
  *
+ * @deprecated
+ *
  * @see [newline-after-var](https://eslint.org/docs/rules/newline-after-var)
  */
 export interface NewlineAfterVarRule {
   /**
    * Require or disallow an empty line after variable declarations.
    *
+   * @deprecated
+   *
    * @see [newline-after-var](https://eslint.org/docs/rules/newline-after-var)
    */
   'newline-after-var': NewlineAfterVarRuleConfig;

src/rules/eslint/newline-before-return.d.ts

@@ -3,19 +3,25 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Require an empty line before `return` statements.
  *
+ * @deprecated
+ *
  * @see [newline-before-return](https://eslint.org/docs/rules/newline-before-return)
  */
 export type NewlineBeforeReturnRuleConfig = RuleConfig<[]>;
 
 /**
  * Require an empty line before `return` statements.
  *
+ * @deprecated
+ *
  * @see [newline-before-return](https://eslint.org/docs/rules/newline-before-return)
  */
 export interface NewlineBeforeReturnRule {
   /**
    * Require an empty line before `return` statements.
    *
+   * @deprecated
+   *
    * @see [newline-before-return](https://eslint.org/docs/rules/newline-before-return)
    */
   'newline-before-return': NewlineBeforeReturnRuleConfig;

src/rules/eslint/no-buffer-constructor.d.ts

@@ -3,19 +3,25 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Disallow use of the `Buffer()` constructor.
  *
+ * @deprecated
+ *
  * @see [no-buffer-constructor](https://eslint.org/docs/rules/no-buffer-constructor)
  */
 export type NoBufferConstructorRuleConfig = RuleConfig<[]>;
 
 /**
  * Disallow use of the `Buffer()` constructor.
  *
+ * @deprecated
+ *
  * @see [no-buffer-constructor](https://eslint.org/docs/rules/no-buffer-constructor)
  */
 export interface NoBufferConstructorRule {
   /**
    * Disallow use of the `Buffer()` constructor.
    *
+   * @deprecated
+   *
    * @see [no-buffer-constructor](https://eslint.org/docs/rules/no-buffer-constructor)
    */
   'no-buffer-constructor': NoBufferConstructorRuleConfig;

src/rules/eslint/no-catch-shadow.d.ts

@@ -3,19 +3,25 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Disallow `catch` clause parameters from shadowing variables in the outer scope.
  *
+ * @deprecated
+ *
  * @see [no-catch-shadow](https://eslint.org/docs/rules/no-catch-shadow)
  */
 export type NoCatchShadowRuleConfig = RuleConfig<[]>;
 
 /**
  * Disallow `catch` clause parameters from shadowing variables in the outer scope.
  *
+ * @deprecated
+ *
  * @see [no-catch-shadow](https://eslint.org/docs/rules/no-catch-shadow)
  */
 export interface NoCatchShadowRule {
   /**
    * Disallow `catch` clause parameters from shadowing variables in the outer scope.
    *
+   * @deprecated
+   *
    * @see [no-catch-shadow](https://eslint.org/docs/rules/no-catch-shadow)
    */
   'no-catch-shadow': NoCatchShadowRuleConfig;