Skip to content

Add tsdoc eslint checking to the codebase #152

Description

@bdls-jamal

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions