@wistia/eslint-config 0.16.0 → 0.17.0

package/configs/eslint/storybook.js

@@ -0,0 +1,9 @@
+require('@rushstack/eslint-patch/modern-module-resolution');
+
+module.exports = {
+  env: {
+    node: true,
+  },
+
+  extends: ['../../rules/eslint/storybook'].map(require.resolve),
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/eslint-config",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "Wistia's ESLint configurations",
   "main": "react.js",
   "exports": {
@@ -11,6 +11,7 @@
     "./node": "./configs/eslint/node.js",
     "./prettier": "./configs/eslint/prettier.js",
     "./react": "./configs/eslint/react.js",
+    "./storybook": "./configs/eslint/storybook.js",
     "./strict": "./configs/eslint/strict.js",
     "./styled-components": "./configs/eslint/styled-components.js",
     "./stylelint": "./configs/stylelint/default.js",
@@ -53,6 +54,7 @@
     "eslint-plugin-react": "^7.31.10",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-sonarjs": "^0.16.0",
+    "eslint-plugin-storybook": "^0.6.7",
     "eslint-plugin-styled-components-a11y": "^1.0.0",
     "eslint-plugin-testing-library": "^5.9.1",
     "postcss": "^8.4.18",

package/rules/eslint/storybook.js

@@ -0,0 +1,66 @@
+// only add storybook rules
+// see: https://github.com/storybookjs/eslint-plugin-storybook#supported-rules-and-configurations
+
+module.exports = {
+  plugins: ['eslint-plugin-storybook'],
+
+  rules: {
+    // storybook 6 requires default exports in stories
+    'import/no-anonymous-default-export': 'off',
+    'import/no-default-export': 'off',
+    'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
+    'import/prefer-default-export': 'error',
+
+    // Interactions should be awaited
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/await-interactions.md
+    'storybook/await-interactions': 'error',
+
+    // Pass a context when invoking play function of another story
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/context-in-play-function.md
+    'storybook/context-in-play-function': 'error',
+
+    // The component property should be set
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/csf-component.md
+    'storybook/csf-component': 'error',
+
+    // Story files should have a default export
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/default-exports.md
+    'storybook/default-exports': 'error',
+
+    // Deprecated hierarchy separator in title property
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/hierarchy-separator.md
+    'storybook/hierarchy-separator': 'error',
+
+    // A story should not have a redundant name property
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/no-redundant-story-name.md
+    'storybook/no-redundant-story-name': 'error',
+
+    // storiesOf is deprecated and should not be used
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/no-stories-of.md
+    'storybook/no-stories-of': 'error',
+
+    // Do not define a title in meta
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/no-title-property-in-meta.md
+    'storybook/no-title-property-in-meta': 'error',
+
+    // This rule identifies storybook addons that are invalid because they are either not installed or contain a typo in their name
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/no-uninstalled-addons.md
+    'storybook/no-uninstalled-addons': 'error',
+
+    // Stories should use PascalCase
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/prefer-pascal-case.md
+    'storybook/prefer-pascal-case': 'error',
+
+    // A story file must contain at least one story export
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/story-exports.md
+    'storybook/story-exports': 'error',
+
+    // Use expect from @storybook/jest
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/use-storybook-expect.md
+    'storybook/use-storybook-expect': 'error',
+
+    // Do not use testing-library directly on stories
+    // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/storybook/use-storybook-testing-library.md
+    'storybook/use-storybook-testing-library': 'error',
+  },
+};

package/rules/eslint/typescript-imports.js

@@ -12,12 +12,18 @@ module.exports = {
 
   rules: {
     ...adjustedImportRules,
+
     // turn on errors for missing imports
     'import/no-unresolved': 'error',
+
+    //
+    'import/no-unused-modules': 'off',
   },
 
   settings: {
     'import/parsers': {
+      // omit `.d.ts` because 1) TypeScript compilation already confirms that types are resolved, and
+      // 2) it would mask an unresolved `.ts`/`.tsx`/`.js`/`.jsx` implementation.
       '@typescript-eslint/parser': ['.ts', '.tsx'],
     },
 

package/rules/eslint/typescript.js

@@ -5,6 +5,16 @@ module.exports = {
   plugins: ['@typescript-eslint'],
 
   rules: {
+    // recommended to be disabled for TypeScript projects
+    // https://github.com/typescript-eslint/typescript-eslint/blob/main/docs/linting/TROUBLESHOOTING.md#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
+    'no-undef': 'off',
+
+    // prefer @typescript-eslint/no-unused-vars
+    'no-unused-vars': 'off',
+
+    // prefer @typescript-eslint/no-use-before-define
+    'no-use-before-define': 'off',
+
     // Require that member overloads be consecutive
     // https://typescript-eslint.io/rules/adjacent-overload-signatures
     '@typescript-eslint/adjacent-overload-signatures': 'error',
@@ -47,7 +57,7 @@ module.exports = {
 
     // Enforce type definitions to consistently use either <code>interface</code> or <code>type</code>
     // https://typescript-eslint.io/rules/consistent-type-definitions
-    '@typescript-eslint/consistent-type-definitions': 'error',
+    '@typescript-eslint/consistent-type-definitions': 'off',
 
     // Enforce consistent usage of type exports
     // https://typescript-eslint.io/rules/consistent-type-exports
@@ -55,11 +65,16 @@ module.exports = {
 
     // Enforce consistent usage of type imports
     // https://typescript-eslint.io/rules/consistent-type-imports
-    '@typescript-eslint/consistent-type-imports': 'error',
+    '@typescript-eslint/consistent-type-imports': [
+      'error',
+      {
+        prefer: 'no-type-imports',
+      },
+    ],
 
     // Require explicit return types on functions and class methods
     // https://typescript-eslint.io/rules/explicit-function-return-type
-    '@typescript-eslint/explicit-function-return-type': 'error',
+    '@typescript-eslint/explicit-function-return-type': 'off',
 
     // Require explicit accessibility modifiers on class properties and methods
     // https://typescript-eslint.io/rules/explicit-member-accessibility
@@ -83,7 +98,7 @@ module.exports = {
 
     // Enforce naming conventions for everything across a codebase
     // https://typescript-eslint.io/rules/naming-convention
-    '@typescript-eslint/naming-convention': 'error',
+    '@typescript-eslint/naming-convention': 'off',
 
     // Require <code>.toString()</code> to only be called on objects which provide useful information when stringified
     // https://typescript-eslint.io/rules/no-base-to-string
@@ -187,7 +202,7 @@ module.exports = {
 
     // Disallow type aliases
     // https://typescript-eslint.io/rules/no-type-alias
-    '@typescript-eslint/no-type-alias': 'error',
+    '@typescript-eslint/no-type-alias': 'off',
 
     // Disallow unnecessary equality comparisons against boolean literals
     // https://typescript-eslint.io/rules/no-unnecessary-boolean-literal-compare
@@ -291,7 +306,8 @@ module.exports = {
 
     // Require function parameters to be typed as <code>readonly</code> to prevent accidental mutation of inputs
     // https://typescript-eslint.io/rules/prefer-readonly-parameter-types
-    '@typescript-eslint/prefer-readonly-parameter-types': 'error',
+    // disabled due to development friction and lackluster linting hints to resolve violations
+    '@typescript-eslint/prefer-readonly-parameter-types': 'off',
 
     // Enforce using type parameter when calling <code>Array#reduce</code> instead of casting
     // https://typescript-eslint.io/rules/prefer-reduce-type-parameter
@@ -448,7 +464,18 @@ module.exports = {
 
     // Disallow magic numbers
     // https://typescript-eslint.io/rules/no-magic-numbers
-    '@typescript-eslint/no-magic-numbers': 'error',
+    '@typescript-eslint/no-magic-numbers': [
+      'error',
+      {
+        ignore: [0, 1, 2, 3, 4, 5, 1000],
+        ignoreArrayIndexes: true,
+        ignoreDefaultValues: true,
+        ignoreTypeIndexes: true,
+        ignoreReadonlyClassProperties: true,
+        ignoreEnums: true,
+        ignoreNumericLiteralTypes: true,
+      },
+    ],
 
     // Disallow variable redeclaration
     // https://typescript-eslint.io/rules/no-redeclare