fix(imports-as-dependencies): allow relative paths

Also: - fix: generation of failing/passing examples
gajus · Jun 4, 2023 · 7469e59 · 7469e59
1 parent e3b0d0c
commit 7469e59
Show file tree

Hide file tree

Showing 5 changed files with 97 additions and 3 deletions.
diff --git a/.README/rules/imports-as-dependencies.md b/.README/rules/imports-as-dependencies.md
@@ -11,4 +11,10 @@ which is not listed in `dependencies` or `devDependencies`.
 |Settings||
 |Options||
 
-<!-- assertions importsAsDependencies -->
+## Failing examples
+
+<!-- assertions-failing importsAsDependencies -->
+
+## Passing examples
+
+<!-- assertions-passing importsAsDependencies -->
diff --git a/docs/rules/imports-as-dependencies.md b/docs/rules/imports-as-dependencies.md
@@ -13,4 +13,75 @@ which is not listed in `dependencies` or `devDependencies`.
 |Settings||
 |Options||
 
-<!-- assertions importsAsDependencies -->
+<a name="user-content-failing-examples"></a>
+<a name="failing-examples"></a>
+## Failing examples
+
+The following patterns are considered problems:
+
+````js
+/**
+ * @type {null|import('sth').SomeApi}
+ */
+// Message: import points to package which is not found in dependencies
+
+/**
+ * @type {null|import('sth').SomeApi}
+ */
+// Settings: {"jsdoc":{"mode":"permissive"}}
+// Message: import points to package which is not found in dependencies
+
+/**
+ * @type {null|import('missingpackage/subpackage').SomeApi}
+ */
+// Message: import points to package which is not found in dependencies
+
+/**
+ * @type {null|import('@sth/pkg').SomeApi}
+ */
+// Message: import points to package which is not found in dependencies
+````
+
+
+
+<a name="user-content-passing-examples"></a>
+<a name="passing-examples"></a>
+## Passing examples
+
+The following patterns are not considered problems:
+
+````js
+/**
+ * @type {null|import('eslint').ESLint}
+ */
+
+/**
+ * @type {null|import('eslint/use-at-your-own-risk').ESLint}
+ */
+
+/**
+ * @type {null|import('@es-joy/jsdoccomment').InlineTag}
+ */
+
+/**
+ * @type {null|import(}
+ */
+
+/**
+ * @type {null|import('esquery').ESQueryOptions}
+ */
+
+/**
+ * @type {null|import('@es-joy/jsdoccomment').InlineTag|
+ *   import('@es-joy/jsdoccomment').JsdocBlock}
+ */
+
+/**
+ * @type {null|import('typescript').Program}
+ */
+
+/**
+ * @type {null|import('./relativePath.js').Program}
+ */
+````
+
diff --git a/src/bin/generateRule.js b/src/bin/generateRule.js
@@ -127,7 +127,13 @@ export default iterateJsdoc(({
 |Settings||
 |Options||
 
-<!-- assertions ${camelCasedRuleName} -->
+## Failing examples
+
+<!-- assertions-failing ${camelCasedRuleName} -->
+
+## Passing examples
+
+<!-- assertions-passing ${camelCasedRuleName} -->
 `;
 
   const ruleReadmePath = `./.README/rules/${ruleName}.md`;

diff --git a/src/rules/importsAsDependencies.js b/src/rules/importsAsDependencies.js
@@ -67,6 +67,10 @@ export default iterateJsdoc(({
           /^(@[^/]+\/[^/]+|[^/]+).*$/u, '$1',
         );
 
+        if ((/^[./]/u).test(mod)) {
+          return;
+        }
+
         if (!moduleCheck.has(mod)) {
           let pkg;
           try {

diff --git a/test/rules/assertions/importsAsDependencies.js b/test/rules/assertions/importsAsDependencies.js
@@ -109,5 +109,12 @@ export default {
          */
       `,
     },
+    {
+      code: `
+        /**
+         * @type {null|import('./relativePath.js').Program}
+         */
+      `,
+    },
   ],
 };