eslint-plugin-tsdoc: allow policies to be ignored in tsdoc/syntax rule
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Now that less-strict parsing for @param tags is merged (https://github.com/microsoft/tsdoc/issues/128), I'd love to be able to loosen the requirements of the tsdoc/syntax rule to allow for certain deviations from the expected syntax.
Primarily, VSCode's built-in JSDoc support automatically adds a doc comment where each @param tag is followed immediately by a description, without the expected hyphen. With the following .eslintrc configuration:
{
rules: {
'tsdoc/syntax': 'warn'
}
}
This snippet is valid:
/**
* Description
* @param a - first number
* @param b - second number
*/
const add = (a: number, b: number) => a + b;
While this snippet:
/**
* Description
* @param a first number
* @param b second number
*/
const add = (a: number, b: number) => a + b;
Warns with the following:
tsdoc-param-tag-missing-hyphen: The @param block should be followed by a parameter name and then a hyphen eslint(tsdoc/syntax)
I'd love to be able to ignore this particular syntax deviation with something like:
{
rules: {
'tsdoc/syntax': ['warn', ignore: ['tsdoc-param-tag-missing-hyphen'] ]
}
}
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the eslint-plugin-tsdoc tsdoc/syntax rule and the less-strict @param parsing context in issue #128; compare the two examples and determine how rule options are represented. Done means a configuration can ignore tsdoc-param-tag-missing-hyphen while other syntax diagnostics still warn, with coverage for both forms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100