Missing JSDoc param in .vue file

[Holiden]

Hello!

Expected behavior

It is expected that the plugin will not display a missing parameter error as they are already defined.

Actual behavior

I am getting an error about missing parameters. However, my JSDoc are filled in correctly. This is .vue file.

If use the suggested autofix, then the parameters are inserted before existing JSDoc declaration

When editing a file anywhere, errors disappear. Not always, but sometimes it works

ESLint Config

module.exports = {
  plugins: ['jsdoc', 'vue'],
  parser: 'vue-eslint-parser',
  parserOptions: {
    parser: '@babel/eslint-parser',
    sourceType: 'module',
  },
  rules: {
    'jsdoc/check-alignment': 'error',
    'jsdoc/check-param-names': ['error', { checkRestProperty: true }],
    'jsdoc/check-property-names': 'error',
    'jsdoc/check-tag-names': 'error',
    'jsdoc/check-types': 'error',
    'jsdoc/newline-after-description': 'error',
    'jsdoc/no-bad-blocks': 'error',
    'jsdoc/no-undefined-types': 'error',
    'jsdoc/require-description': 'error',
    'jsdoc/require-description-complete-sentence': 'error',
    'jsdoc/require-hyphen-before-param-description': 'error',
    'jsdoc/require-param': ['error', { checkRestProperty: true, enableFixer: false }],
    'jsdoc/require-param-description': 'error',
    'jsdoc/require-param-name': 'error',
    'jsdoc/require-param-type': 'error',
    'jsdoc/require-property': 'error',
    'jsdoc/require-property-description': 'error',
    'jsdoc/require-property-name': 'error',
    'jsdoc/require-property-type': 'error',
    'jsdoc/require-returns': 'error',
    'jsdoc/require-returns-check': 'error',
    'jsdoc/require-returns-description': 'error',
    'jsdoc/require-returns-type': 'error',
    'jsdoc/require-throws': 'error',
    'jsdoc/require-yields': 'error',
    'jsdoc/require-yields-check': 'error',
    'jsdoc/valid-types': 'error',
  }
}

Environment

• Node version: v14.16.1
• ESLint version: v7.24.0
• eslint-plugin-jsdoc version: v32.3.3
• IDE: Php Storm 2021.1.1

[brettz9]

If you can create a minimal test case repo, there is a greater chance we can debug this. I don't know it if may relate to your Webpack or Rollup routine.

[Holiden]

If you can create a minimal test case repo, there is a greater chance we can debug this. I don't know it if may relate to your Webpack or Rollup routine.

Yes of course. Here it is.
src/App.vue - all the same.

[brettz9]

Using the command line, $(npm bin)/eslint --ext=vue ., I only get one unrelated error, "Missing an explicit type attribute for button vue/html-button-has-type".

When viewing within Atom, I get an error about no Babel config file being detected, but when I add babelOptions like thus (and I wasn't able to use ~/ for some reason):

  parserOptions: {
    babelOptions: {
      cwd: '/Users/brett',
      configFile: './forJSDoc/babel.config.js'
    },
    parser: '@babel/eslint-parser',
    sourceType: 'module',
  },

...I also just get the same error as on the command line.

Perhaps this is an issue specific to your IDE.

[Holiden]

Perhaps this is an issue specific to your IDE.

I tried opening it in VSCode and got the same errors

[Holiden]

I will clarify what it is in the files .vue. In files .js everything is correct.

[brettz9]

Do you have Atom available to test? I'm not sure why it would be working there... What was the original IDE you were using?

[Holiden]

Do you have Atom available to test? I'm not sure why it would be working there... What was the original IDE you were using?

• IDE: Php Storm 2021.1.1

I do not have Atom, but i can set it for test.

[brettz9]

I'm afraid I'm rather tied up in other projects to really explore this too deeply atm myself.

Hopefully someone can go to /node_modules/eslint-plugin-jsdoc/dist/rules/requireParam.js and add logging (or throwing errors as need be for the IDE to pick it up) around the Missing JSDoc to find out where things are going wrong.

Or perhaps it can be solved by adjusting the IDE's settings, e.g., ala babel/babel-eslint#769 (comment) , in case your @vue/cli-plugin-babel/preset is required but is not getting discovered.

Hope that leads to some avenues of exploration, as I'm not really too sure at this point.

[gcunsolo]

Hi all,

I'm having the very same issue when working on a Windows 10 OS.

Please note that I got no problem at all when using MAC OS.

Here's a sample of a file I'm trying to lint:

/**
     * @description My beautiful description
     * @param {string} param - This is an awesome param indeed
     * @return {boolean} true if not false
     */
    myBeautifulMethod(param) { ... }

Here's the output of my lint job:

   97:5  error  Missing JSDoc @description declaration        jsdoc/require-description
   97:5  error  Missing JSDoc @param "param" declaration     jsdoc/require-param
   97:5  error  Missing JSDoc @return declaration             jsdoc/require-returns

It's like the plugin found a JSDoc block, but was totally unable to analyze its content.

Just like @Holiden, If I try an autofix I got this result:

> 59 |     * @param param
     |       ^
  60 | /**
  61 |      * @description My beautiful description
  62 |      * @param {string} param - This is an awesome param indeed

From where I stand, it looks like a bad detection of end-of-line after the /**

Edit:
Browsing your issues, the only problem that looks vaguely related may be #431

[gcunsolo]

When editing a file anywhere, errors disappear. Not always, but sometimes it works

Again, I got the very same behaviour.

@Holiden Can you please confirm my lead about Windows OS? Thanks in advance

[brettz9]

@gcunsolo : If you can use plugins with jsdoc and add the rules individually (instead of using extends with plugins:jsdoc/recommended), can you try removing one half of the rules and through the process of elimination, identify which single rule may be sufficient to trigger the problem (is it require-param` alone?)

Then, if you could reduce your code down to see whether that comment block alone in a file is sufficient to trigger the error...

And if you would also try upgrading to the latest eslint-plugin-jsdoc, since the reported version is several versions earlier now, and it is possible there was some fix.

[gcunsolo]

Thank you @brettz9

I'm currently using 33.1.1, I'll give 34.0.2 a shot and get back to you with more information, as you asked!

(...and hey! Good job! We all get here to complain when there's something wrong... we never take the time to thank you all for your work!!)

[Holiden]

@Holiden Не могли бы вы подтвердить мое мнение об ОС Windows? заранее спасибо

All right. This is the problem I have on OS Windows 10.