How to access rules documentation?

SonarQube Server / Community Build
1

Must-share information (formatted with Markdown):

  • which versions are you using (SonarQube Server / Community Build, Scanner, Plugin, and any relevant extension): “eslint-plugin-sonarjs”: “^4.0.2”,
  • how is SonarQube deployed: zip, Docker, Helm: npm and then eslint
  • what are you trying to achieve: Need documentation on sonarjs/no-unused-vars rule
  • what have you tried so far to achieve this: Accessing from https://www.npmjs.com/package/eslint-plugin-sonarjs the link Sign in to GitHub · GitHub Gives “Unauthorized access error”

What I need to do to set this rule to ignore underscore starting (unused) variables like the “typescript-eslint/no-unused-vars” rule does with its “varsIgnorePattern” parameter.

2

Hi,

Unfortunately, this rule is not customizable; it has no parameters.

Can you share why you think this rule should ignore variables with a leading underscore in the name?

 
Thx,
Ann

3

It is a common idiom to start a variable name with underscore to say “ignore this unused variable”.

Anyway, seems this rule is redundant because it does less than the “typescript-eslint/no-unused-vars” one, so at the end I disabled it.

My request about documentation originated by my desire to see if the rule provides anything more than the typescript-eslint one.

Thanks for your help!

8

btw the documentation link problem mentioned here is still around

I ended up digging into it and found hundreds of the same broken links in the SonarSource repos: