valid-types provides error with using import from other file

[krutoo]

Hi. Please help me resolve problem with "jsdoc/valid-types" rule. Import of types provides error:

error text: "JSDoc syntax error"

eslint-plugin-jsdoc version: 15.5.2
eslint version: 6.0.0

eslint rule configuration:

{
  // ...
  rules: {
    // ...
    "jsdoc/valid-types": "error"
  }
}

[brettz9]

Indeed, support for the TypeScript import() syntax has been added in the underlying jsdoctypeparser and testing this code in our testing environment (and checking the type in the jsdoctypeparser demo) reports no issues:

/**
       * Component.
       * @param {import('../properties-list/properties-list.jsx').PropertyType} prop Property.
       */
       const DownloadList = ({ files }) => {};

Please be sure to restart your IDE after you have installed updates to eslint-plugin-jsdoc. With the Atom linting package at least, it apparently caches the files.

[brettz9]

I expect this is a stale files issue, so closing, but feel free to comment further and we can reopen if we can replicate.

[krutoo]

@brettz Thank you for answer. I have problem with lint in terminal by yarn.
It provides next error:

I don't use cache in ESLint. I restart my IDE (VS Code, PHPStorm) but i think that is independent things.

[brettz9]

Ok, and you are sure you have updated to the latest eslint-plugin-jsdoc, along with its dependencies? Your yarn.lock file should be showing version "5.0.1" for the dependency "jsdoctypeparser" because earlier versions did not properly support import().

If you have confirmed this, can you reduce your test case to a single erring block, and reduce your .eslintrc to the minimum set of rules?

[krutoo]

@brettz9 here is screenshot of yarn.lock file:

I already have only one erring block now.

I understood that rule valid-jsdoc provides this error. After remove this rule i have no errors.

But this rule is necessary for my project. What can i do?

[brettz9]

Ok, good to see you have the dependency, but by a single erring block, I mean you have no other code in the file that triggers the error. And to be safe, try removing all other eslint rules and configs/plugins and paste your exact code and config that still reproduces the issue.

[krutoo]

That config (with old "valid-jsdoc" rule) provides error:

{
  "rules": {
    "valid-jsdoc": [
      "error",
      {
        "prefer": {
          "arg": "param",
          "argument": "param",
          "class": "constructor",
          "virtual": "abstract",
          "returns": "return"
        },
        "preferType": {
          "any": "*",
          "Null": "null",
          "Undefined": "undefined",
          "Boolean": "boolean",
          "Number": "number",
          "int": "number",
          "integer": "number",
          "float": "number",
          "String": "string",
          "Symbol": "symbol",
          "object": "Object",
          "array": "Array",
          "function": "Function"
        },
        "requireReturn": false,
        "requireReturnType": true,
        "requireParamType": true,
        "matchDescription": ".+",
        "requireParamDescription": true,
        "requireReturnDescription": true
      }
    ],
  }
}

In this code:

/**
 * Component.
 * @param {import('../properties-list/properties-list.jsx').PropertyType} prop Property.
 */
const DownloadList = ({ files }) => {/* ... */};

But i just remove "valid-jsdoc" rule and replace it on rules from this plugin. And it works without errors.
I non't now it issue is needed now, because "valid-jsdoc" is deprecated rule. Maybe it can be closed.

[brettz9]

Ahh, I see, I mistook the "valid-jsdoc" in your previous post as being the same as valid-types, so yes, I think you are on the right track to remove it, and if you weren't aware, the wiki page at https://github.com/gajus/eslint-plugin-jsdoc/wiki/Comparison-with-deprecated-JSdoc-related-ESLint-rules shows the equivalent features of valid-jsdoc in eslint-plugin-jsdoc. Glad it's working!

[nemoDreamer]

This is still happening on eslint-plugin-jsdoc@35.4.1 in VS Code:

But VS Code does correctly find the type this way:

---

I'm using

{
    extends: [
        "airbnb-base",
        "plugin:jsdoc/recommended",
        "plugin:prettier/recommended",
    ],
    rules: [
        // deprecated rule conflicting with `eslint-plugin-jsdoc`?
        "valid-jsdoc": "off",
        "require-jsdoc": "off",
    ],
}

... but also happens with only plugin:jsdoc/recommended...

---

Maybe this issue came back because of the switch to jsdoc-type-pratt-parser? 🤞

[brettz9]

To avoid errors, you need to set settings.jsdoc.mode to "typescript" or to include @typescript/eslint-parser as your parser.

[nemoDreamer]

Thank you, @brettz9, that was the missing piece!