Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tsdoc eslint checking to the codebase #152

Open
bdls-jamal opened this issue Feb 12, 2025 · 0 comments
Open

Add tsdoc eslint checking to the codebase #152

bdls-jamal opened this issue Feb 12, 2025 · 0 comments

Comments

@bdls-jamal
Copy link

Requires only a few modifications to the eslint file:

  1. plugins: ['react', '@typescript-eslint', 'react-hooks', 'simple-import-sort', 'eslint-plugin-tsdoc'], // add eslint-plugin-tsdoc for tsdoc checks
  2. under rules: 'tsdoc/syntax': 'warn'

This will provide warnings when running ePlant locally but will not stop you from using the site as this is for internal documentation and code commenting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant