fix(valid-types): ensure requires checking works without module:;

fixes #840
gajus · Feb 17, 2022 · 0cfdfd7 · 0cfdfd7
1 parent 9e78b57
commit 0cfdfd7
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/src/getDefaultTagStructureForMode.js b/src/getDefaultTagStructureForMode.js
@@ -712,6 +712,10 @@ const getDefaultTagStructureForMode = (mode) => {
     [
       'requires', new Map([
         // <someModuleName>
+        [
+          'nameContents', 'namepath-referencing',
+        ],
+
         [
           'nameRequired', true,
         ],

diff --git a/src/rules/validTypes.js b/src/rules/validTypes.js
@@ -102,6 +102,7 @@ export default iterateJsdoc(({
       if (tagName) {
         // eslint-disable-next-line default-case
         switch (tagName) {
+        case 'requires':
         case 'module': {
           if (!namepath.startsWith('module:')) {
             handled = tryParsePathIgnoreError(`module:${namepath}`);

diff --git a/test/rules/assertions/validTypes.js b/test/rules/assertions/validTypes.js
@@ -1610,5 +1610,14 @@ export default {
         ecmaVersion: 2_017,
       },
     },
+    {
+      code: `
+      /**
+       * @module module:scenarios/scenarios
+       * @requires scenarios/effects
+       */
+      `,
+      ignoreReadme: true,
+    },
   ],
 };