Could you provide `eslint-plugin-tsdoc/recommended`?
Open
Nobody has claimed this yet.
effort: easy
enhancement
needs design
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
My current .eslintrc.js:
module.exports = {
extends: [
'standard-with-typescript',
'plugin:jest/recommended'
],
plugins: [
'tsdoc'
],
parserOptions: {
project: './tsconfig.json'
},
rules: {
'tsdoc/syntax': 'warn'
}
}
If eslint-plugin-tsdoc/recommended is provided, it can be more simple.
module.exports = {
extends: [
'standard-with-typescript',
'plugin:tsdoc/recommended',
'plugin:jest/recommended'
],
parserOptions: {
project: './tsconfig.json'
}
}
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 from the existing eslint-plugin-tsdoc setup described in .eslintrc.js, including the tsdoc/syntax rule and tsconfig.json parserOptions. Locate the plugin's configuration exports and determine how the requested plugin:tsdoc/recommended entry should be represented. Done means the simplified configuration works without listing the plugin or rule separately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100