0.4.0 • Published 11 months ago

eslint-plugin-tsdoc v0.4.0

Weekly downloads
52,989
License
MIT
Repository
github
Last release
11 months ago

eslint-plugin-tsdoc

This ESLint plugin provides a rule for validating that TypeScript doc comments conform to the TSDoc specification.

Usage

  1. Configure ESLint for your TypeScript project. See the instructions provided by the typescript-eslint project. You will end up with some dependencies like this:

    my-project/package.json (example)

    {
      "name": "my-project",
      "version": "1.0.0",
      "dependencies": {},
      "devDependencies": {
        "@typescript-eslint/eslint-plugin": "~2.6.1",
        "@typescript-eslint/parser": "~2.6.1",
        "eslint": "~6.6.0",
        "typescript": "~3.7.2"
      },
      "scripts": {
        "lint": "eslint -f unix \"src/**/*.{ts,tsx}\""
      }
    }
  2. Add the eslint-plugin-tsdoc dependency to your project:

    $ cd my-project
    $ npm install --save-dev eslint-plugin-tsdoc
  3. In your ESLint config file, add the "eslint-plugin-tsdoc" package to your plugins field, and enable the "tsdoc/syntax" rule. For example:

    my-project/.eslintrc.js (example)

    module.exports =  {
      plugins: [
        "@typescript-eslint/eslint-plugin",
        "eslint-plugin-tsdoc"
      ],
      extends:  [
        'plugin:@typescript-eslint/recommended'
      ],
      parser:  '@typescript-eslint/parser',
      parserOptions: {
        project: "./tsconfig.json",
        tsconfigRootDir: __dirname,
        ecmaVersion: 2018,
        sourceType: "module"
      },
      rules: {
        "tsdoc/syntax": "warn"
      }
    };

This package is maintained by the TSDoc project. If you have questions or feedback, please let us know!

@jiralite/eslint-config-neon@zhengxs/eslint-config-library@zhengxs/spec-lib@zhengxs-devkit/eslint-config@mediinfo/eslint-configbitguild-blockchain-sdk@miszo/eslint-config@eslint-sets/vue3-ts@eslint-sets/simple-ts@marcozac/eslint-config@infinitebrahmanuniverse/nolb-eslint-plugin-t@dankeu/eslint-config-tseslint-config-watchfuleslint-config-watchful-base@everything-registry/sub-chunk-1615eslint-config-zohynorylord-kiteslint-config-miszo@rubensworks/eslint-config@voluspa/style-guideeslint-config-slekup@youngseokangg/common-bundlejodit-prkiiif-manifest-editormassa-web3-fork-workspace@wang1212/eslint-config@wangshaopenga/eslint-config@washingtondc/eslint@websummit/codestyle@websummit/eslint-config@websummit/eslint-config-codestyle@webpuppy/eslint-config@webpuppy/eslint-config-typescript@vercel/style-guide@xhubio/build-base@xhubiotable/build-base@tronite/style-guide@tsparticles/webpack-plugin@ulld/eslint-config@theqrl/eslint-config-base-web3@typedigital/eslint-config@tsparticles/build@tsparticles/cli@tsparticles/eslint-config@toruslabs/eslint-config-typescript@tomer/eslint-config@upaa-test/javascript@upaa/javascript@voltiso/config.eslint@voltiso/eslint-config@voltiso/eslint-config-fast@yeger/eslint-config@ygorluiz/style-guide@yoursunny/xo-config@yokots/eslint-config@youversion/eslint-config-typescript@youwol/eslint-config@zappar/eslint-config-zappar@zhengxs/eslint-configairwallex-payment-elementsanime-search@go-saas/go-saas-ui@auditorium-ai/eslint-config@atom-web/fabric@cksource-cs/eslint-config-cs-module@goodboydigital/eslint-config@chronoverse-eslint/typescript@407dev/eslint-config@abelflopes/eslint-config-tsr-pro@haojian-app/eslint-config@harmonix-hub/eslint@graz-sh/style-guide@graz-sh/style-guide-core@grikomsn/style-guide@grikomsn/style-guide-core@haltcase/style@ahmdigital/eslint-config@e1011/eslint-config@earlorg/eslint-config@easynm/eslint-config@codiumco/afcas-shared@codefast/style-guide@comprend/eslint-config@contract-case/eslint-config-case-maintainer@connectacademic/eslint@connectacademic/eslint-config@ithinkdt/eslint-config@ithinkdt/lint@connoropolous/holochain-client@cosmiccloud/style-guide@cprussin/eslint-config@hyperspaceinc/style-guide@hyperspaceinc/style-guide-core@panmenghan/starter@bausmeier/eslint-config@bisual/eslint-config-js-ts@berun/eslint-config@biased-ts/eslint-config@bestdoctor/eslint-config@carryall/eslint-config
0.4.0

11 months ago

0.3.0

1 year ago

0.2.17

3 years ago

0.2.16

4 years ago

0.2.15

4 years ago

0.2.14

4 years ago

0.2.13

4 years ago

0.2.12

5 years ago

0.2.11

5 years ago

0.2.10

5 years ago

0.2.9

5 years ago

0.2.8

5 years ago

0.2.7

5 years ago

0.2.6

5 years ago

0.2.5

5 years ago

0.2.4

6 years ago

0.2.3

6 years ago

0.2.2

6 years ago

0.2.1

6 years ago

0.2.0

6 years ago

0.1.2

6 years ago

0.1.1

6 years ago

0.1.0

6 years ago

0.0.0

6 years ago