.eslintrc.json

Go to the documentation of this file.

{
  "env": {
    "node": true,
    "es2021": true
  },
  "extends": [
    "eslint:recommended",
    "plugin:jsdoc/recommended"
  ],
  "plugins": ["jsdoc"],
  "parserOptions": {
    "ecmaVersion": "latest",
    "sourceType": "module"
  },
  "settings": {
    "jsdoc": {
      "tagNamePreference": {
        "returns": "returns"
      },
      "mode": "jsdoc",
      "preferredTypes": {
        "object": "object",
        "array": "Array"
      },
      "structuredTags": {
        "api": {
          "name": "namepath-defining",
          "required": ["type", "path", "title"]
        },
        "apiName": { "name": false },
        "apiGroup": { "name": false },
        "apiDescription": { "name": false },
        "apiHeader": { "name": "namepath-referencing", "required": ["type", "field"] },
        "apiParam": { "name": "namepath-referencing", "required": ["type"] },
        "apiSuccess": { "name": "namepath-referencing", "required": ["type"] },
        "apiError": { "name": "namepath-referencing", "required": ["type"] },
        "apiExample": { "name": false },
        "apiVersion": { "name": false },
        "apiPermission": { "name": false },
        "apiSampleRequest": { "name": false }
      }
    }
  },
  "rules": {
    "jsdoc/require-jsdoc": ["warn", {
      "require": {
        "FunctionDeclaration": true,
        "MethodDefinition": true,
        "ClassDeclaration": true,
        "ArrowFunctionExpression": false,
        "FunctionExpression": false
      },
      "contexts": [
        "ExportNamedDeclaration > FunctionDeclaration"
      ]
    }],
    "jsdoc/require-param": "warn",
    "jsdoc/require-param-description": "warn",
    "jsdoc/require-param-type": "warn",
    "jsdoc/require-returns": "warn",
    "jsdoc/require-returns-description": "warn",
    "jsdoc/require-returns-type": "warn",
    "jsdoc/check-param-names": "error",
    "jsdoc/check-tag-names": ["error", {
      "definedTags": [
        "api", "apiName", "apiGroup", "apiDescription", "apiHeader", 
        "apiParam", "apiSuccess", "apiError", "apiExample", "apiVersion",
        "apiPermission", "apiSampleRequest", "brief", "date"
      ]
    }],
    "jsdoc/check-types": "warn",
    "jsdoc/no-undefined-types": "off",
    "jsdoc/valid-types": "warn",
    "jsdoc/require-description": ["warn", {
      "contexts": ["FunctionDeclaration", "MethodDefinition", "ClassDeclaration"]
    }]
  },
  "ignorePatterns": [
    "node_modules/",
    "build/",
    "dist/",
    "*.min.js"
  ]
}