@shopgate/eslint-config 7.30.3 → 7.31.0-alpha.1

package/package.json

@@ -1,18 +1,22 @@
 {
   "name": "@shopgate/eslint-config",
-  "version": "7.30.3",
+  "version": "7.31.0-alpha.1",
   "description": "Eslint configuration for the Shopgate Connect projects.",
   "author": "Shopgate <support@shopgate.com>",
   "license": "Apache-2.0",
   "main": "./ruleset/index.js",
   "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-import-resolver-babel-module": "^5.3.2",
     "eslint-import-resolver-exports": "^1.0.0-beta.5",
+    "eslint-import-resolver-typescript": "3.6.1",
     "eslint-plugin-cypress": "^2.6.1",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-extra-rules": "~0.0.0-development",
     "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsdoc": "^62.7.1",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-react": "^7.37.5",

package/ruleset/index.js

@@ -3,6 +3,7 @@ module.exports = {
     './main',
     './react',
     './extras',
+    './typescript',
   ].map(require.resolve),
   rules: {},
 };

package/ruleset/main.js

@@ -163,33 +163,55 @@ module.exports = {
     {
       files: [
         '**/*.spec.js',
+        '**/*.spec.ts',
         '**/*.spec.jsx',
+        '**/*.spec.tsx',
         '**/*.test.js',
+        '**/*.test.ts',
         '**/*.test.jsx',
+        '**/*.test.tsx',
         '**/*.mock.js',
+        '**/*.mock.ts',
         '**/*.mock.jsx',
+        '**/*.mock.tsx',
         '**/spec.js',
+        '**/spec.ts',
         '**/spec.jsx',
+        '**/spec.tsx',
         '**/mock.js',
+        '**/mock.ts',
         '**/mock.jsx',
+        '**/mock.tsx',
       ],
       rules: {
         // Allow more than one class per file in test files
         'max-classes-per-file': 'off',
         // Allow non-camelcase names in test files (e.g., snake_case from API)
         camelcase: 'off',
+        // Don't require JSDoc in test/mock files
+        'require-jsdoc': 'off',
+        'valid-jsdoc': 'off',
+        'no-console': 'off',
       },
     },
   ],
   settings: {
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts', '.tsx'],
+    },
     'import/extensions': [
       '.js',
       '.json',
       '.jsx',
+      '.ts',
+      '.tsx',
     ],
     'import/resolver': {
       exports: {},
-      node: {},
+      node: { extensions: ['.js', '.jsx', '.ts', '.tsx', '.d.ts'] },
+      typescript: {
+        alwaysTryTypes: true,
+      },
     },
   },
 };

package/ruleset/typescript.js

@@ -0,0 +1,114 @@
+module.exports = {
+  overrides: [
+    {
+      files: ['**/*.ts', '**/*.tsx'],
+      parser: '@typescript-eslint/parser',
+      plugins: ['@typescript-eslint', 'jsdoc'],
+      extends: [
+        'plugin:@typescript-eslint/recommended',
+      ],
+      rules: {
+        // Prefer TS variants
+        'no-unused-vars': 'off',
+        'no-shadow': 'off',
+        'no-use-before-define': 'off',
+
+        '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+        '@typescript-eslint/no-shadow': 'warn',
+        '@typescript-eslint/no-use-before-define': [
+          'error',
+          {
+            functions: false,
+            classes: true,
+            variables: false,
+          },
+        ],
+
+        // Common TS ergonomics (tune as you like)
+        '@typescript-eslint/consistent-type-imports': ['warn', { prefer: 'type-imports' }],
+
+        'valid-jsdoc': 'off',
+        'require-jsdoc': 'off',
+        // Require JSDoc only for "public" (exported) APIs.
+        'jsdoc/require-jsdoc': ['warn', {
+          publicOnly: true,
+          require: {
+            ArrowFunctionExpression: true,
+            FunctionDeclaration: true,
+            ClassDeclaration: true,
+            MethodDefinition: true,
+          },
+        }],
+        // Require JSDoc Description only for "public" (exported) APIs.
+        'jsdoc/require-description': ['warn', {
+          contexts: [
+          // export function foo() {}
+            'ExportNamedDeclaration > FunctionDeclaration',
+            // export const foo = () => {}
+            'ExportNamedDeclaration VariableDeclarator > ArrowFunctionExpression',
+            // export class Foo {}
+            'ExportNamedDeclaration > ClassDeclaration',
+            // export default function foo() {}
+            // export default function () {}
+            'ExportDefaultDeclaration > FunctionDeclaration',
+            // export default class Foo {}
+            'ExportDefaultDeclaration > ClassDeclaration',
+            // const Foo = () => {}; export default Foo;
+            'Program > VariableDeclaration > VariableDeclarator > ArrowFunctionExpression',
+          ],
+        }],
+
+        'jsdoc/require-param': 'warn',
+        // When @param is provided, it also needs to be described
+        'jsdoc/require-param-description': 'warn',
+
+        'jsdoc/require-returns': 'warn',
+        // When @returns is provided, it also needs to be described
+        'jsdoc/require-returns-description': 'warn',
+
+        // Disallow usage of JSDoc types for params. That's already done by TS
+        'jsdoc/no-types': 'error',
+        // Check if JSDoc only contains valid tags e.g. @example or @deprecated
+        'jsdoc/check-tag-names': 'warn',
+        // Check if param names match function names
+        'jsdoc/check-param-names': 'warn',
+        // Reports invalid alignment of JSDoc block asterisks.
+        'jsdoc/check-alignment': 'warn',
+        'jsdoc/check-line-alignment': 'warn',
+        'jsdoc/sort-tags': 'warn',
+
+        'react/jsx-filename-extension': [
+          'error',
+          { extensions: ['.jsx', '.tsx'] }, // Allow JSX in .tsx files
+        ],
+        // Special max-len rules for TS files that allow longer lines in comments
+        'max-len': ['error', 100, 2, {
+          ignoreUrls: true,
+          ignoreComments: true,
+          ignoreRegExpLiterals: true,
+          ignoreStrings: true,
+          ignoreTemplateLiterals: true,
+        }],
+
+        // '@stylistic/object-curly-spacing': ['warn', 'always'],
+        // '@stylistic/type-annotation-spacing': 'warn',
+        // '@stylistic/type-generic-spacing': 'warn',
+        // '@stylistic/type-named-tuple-spacing': 'warn',
+        // '@stylistic/member-delimiter-style': 'warn',
+      },
+    },
+    // Rules for  React components in .tsx files
+    {
+      files: ['**/*.tsx'],
+      rules: {
+        'react/prop-types': 'off',
+        'react/require-default-props': 'off',
+        'jsdoc/require-param-description': 'warn',
+        // JSDoc for params is not needed for React components, as already covered by TS.
+        'jsdoc/require-param': 'off',
+        // JSDoc for return values is not needed for React components, as already covered by TS.
+        'jsdoc/require-returns': 'off',
+      },
+    },
+  ],
+};