microsoft / tsdoc

A doc comment standard for TypeScript
https://tsdoc.org/
MIT License
4.7k stars 130 forks source link

Could you provide `eslint-plugin-tsdoc/recommended`? #321

Open munierujp opened 2 years ago

munierujp commented 2 years ago

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'
  }
}
octogonz commented 2 years ago

Our recommended config is in:

https://github.com/microsoft/rushstack/blob/main/eslint/eslint-config/mixins/tsdoc.js

Maybe we should provide a recommended tsdoc.json as well.