.eslintrc.json

{
  "extends": ["cozy-app/react", "plugin:jsdoc/recommended"],
  "plugins": ["jsdoc"],
  "rules": {
    "no-console": 0,
    "no-unused-vars": [
      "error",
      {
        "args": "none",
        "ignoreRestSiblings": true
      }
    ],
    "jsdoc/check-types": 0, // Types are checked via typescript
    "jsdoc/valid-types": 0, // Types are checked via typescript
    "jsdoc/require-jsdoc": 0, // --fix adds empty jsdocs
    "jsdoc/require-param": 0, // --fix breaks docstrings without params
    "jsdoc/require-param-description": ["error"],
    "jsdoc/require-returns": 0, // too much warnings for now
    "jsdoc/require-returns-description": 0, // too much warnings for now
    "no-param-reassign": 2
  },
  "settings": {
    "jsdoc": {
      "mode": "typescript",
      "preferredTypes": {
        "object.<>": "Object.<>", // For Typescript compatibility

        // Typescript utility types are defined here so that the plugin
        // does not consider them as undefined
        "Partial": "Partial",
        "Required": "Required",
        "Readonly": "Readonly",
        "Record": "Record",
        "Pick": "Pick",
        "Omit": "Omit",
        "Exclude": "Exclude",
        "Extract": "Extract",
        "NonNullable": "NonNullable",
        "Parameters": "Parameters",
        "ConstructorParameters": "ConstructorParameters",
        "ReturnType": "ReturnType",
        "InstanceType": "InstanceType",
        "ThisParameterType": "ThisParameterType",
        "OmitThisParameter": "OmitThisParameter",
        "ThisType": "ThisType",
        "Uppercase": "Uppercase",
        "Lowercase": "Lowercase",
        "Capitalize": "Capitalize",
        "Uncapitalize": "Uncapitalize"
      }
    },
    "react": {
      "version": "16.2"
    }
  }
}