fix: add TS import tag; fixes #1218

gajus · Mar 28, 2024 · 9e9fed5 · 9e9fed5
1 parent 3e88f9a
commit 9e9fed5
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 9 deletions.
diff --git a/.README/rules/informative-docs.md b/.README/rules/informative-docs.md
@@ -46,6 +46,7 @@ For example, with `{ excludedTags: ["category"] }`, the following comment would
 function computeTypes(node) {
   // ...
 }
+```
 
 No tags are excluded by default.
 

diff --git a/.README/rules/sort-tags.md b/.README/rules/sort-tags.md
@@ -63,6 +63,7 @@ a fixed order that doesn't change into the future, supply your own
   'file',
   'fileoverview',
   'overview',
+  'import',
 
   // Identifying (name, type)
   'typedef',

diff --git a/docs/rules/check-tag-names.md b/docs/rules/check-tag-names.md
@@ -714,6 +714,7 @@ function quux (foo) {}
  * @variation
  * @version
  * @yields
+ * @import
  * @internal
  * @overload
  * @satisfies
@@ -1028,6 +1029,7 @@ function quux (foo) {}
  * @variation
  * @version
  * @yields
+ * @import
  * @internal
  * @overload
  * @satisfies

diff --git a/docs/rules/informative-docs.md b/docs/rules/informative-docs.md
@@ -4,6 +4,7 @@
 
 * [Options](#user-content-informative-docs-options)
     * [`aliases`](#user-content-informative-docs-options-aliases)
+    * [`excludedTags`](#user-content-informative-docs-options-excludedtags)
     * [`uselessWords`](#user-content-informative-docs-options-uselesswords)
 * [Context and settings](#user-content-informative-docs-context-and-settings)
 * [Failing examples](#user-content-informative-docs-failing-examples)
@@ -60,6 +61,7 @@ For example, with `{ excludedTags: ["category"] }`, the following comment would
 function computeTypes(node) {
   // ...
 }
+```
 
 No tags are excluded by default.
 

diff --git a/docs/rules/sort-tags.md b/docs/rules/sort-tags.md
diff --git a/src/defaultTagOrder.js b/src/defaultTagOrder.js
@@ -11,6 +11,7 @@ const defaultTagOrder = [
       'file',
       'fileoverview',
       'overview',
+      'import',
 
       // Identifying (name, type)
       'typedef',

diff --git a/src/tagNames.js b/src/tagNames.js
@@ -136,6 +136,9 @@ const jsdocTags = {
 const typeScriptTags = {
   ...jsdocTags,
 
+  // https://github.com/microsoft/TypeScript/issues/22160
+  import: [],
+
   // https://www.typescriptlang.org/tsconfig/#stripInternal
   internal: [],
 

diff --git a/test/rules/assertions/checkTagNames.js b/test/rules/assertions/checkTagNames.js
@@ -856,6 +856,10 @@ export default {
     {
       code: `${ALL_TYPESCRIPT_TAGS_COMMENT}\nfunction quux (foo) {}`,
       errors: [
+        {
+          line: lineCount(ALL_TYPESCRIPT_TAGS_COMMENT) - 4,
+          message: 'Invalid JSDoc tag name "import".',
+        },
         {
           line: lineCount(ALL_TYPESCRIPT_TAGS_COMMENT) - 3,
           message: 'Invalid JSDoc tag name "internal".',