Merge pull request #303 from microsoft/deprecated_allow

Allow JSDoc deprecated anywhere
microsoft · Nov 29, 2021 · a4ce8e1 · a4ce8e1
1 parent fed4819
commit a4ce8e1
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/packages/dtslint/package.json b/packages/dtslint/package.json
@@ -1,6 +1,6 @@
 {
   "name": "dtslint",
-  "version": "3.6.13",
+  "version": "3.6.14",
   "description": "Runs tests on TypeScript definition files",
   "files": [
     "bin",

diff --git a/packages/dtslint/src/rules/noRedundantJsdoc2Rule.ts b/packages/dtslint/src/rules/noRedundantJsdoc2Rule.ts
@@ -62,6 +62,9 @@ function walk(ctx: Lint.WalkContext<void>): void {
         // @ts-ignore (until support for 4.0 is added)
         const jsdocDeprecatedTag = ts.SyntaxKind.JSDocDeprecatedTag || 0;
         switch (tag.kind) {
+            case jsdocDeprecatedTag:
+                // A deprecated tag always has meaning
+                break;
             case ts.SyntaxKind.JSDocTag: {
                 const { tagName } = tag;
                 const { text } = tagName;
@@ -87,7 +90,6 @@ function walk(ctx: Lint.WalkContext<void>): void {
             case ts.SyntaxKind.JSDocCallbackTag:
             case ts.SyntaxKind.JSDocThisTag:
             case ts.SyntaxKind.JSDocEnumTag:
-            case jsdocDeprecatedTag:
 
                 // Always redundant
                 ctx.addFailureAtNode(

diff --git a/packages/dtslint/test/no-redundant-jsdoc/declarationFile.d.ts b/packages/dtslint/test/no-redundant-jsdoc/declarationFile.d.ts
@@ -0,0 +1,2 @@
+/** @deprecated */
+export const x: number;
diff --git a/packages/dtslint/test/no-redundant-jsdoc/tslint.json b/packages/dtslint/test/no-redundant-jsdoc/tslint.json
@@ -0,0 +1,6 @@
+{
+  "rulesDirectory": ["../../bin/rules"],
+  "rules": {
+    "no-redundant-jsdoc": true
+  }
+}