@wistia/eslint-config 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @wistia/eslint-config
 
+## 1.1.0
+
+### Minor Changes
+
+- [#397](https://github.com/wistia/eslint-config/pull/397) [`92ddfaa`](https://github.com/wistia/eslint-config/commit/92ddfaaf2085586ddcee24fe98063f2c826d1f15) Thanks [@okize](https://github.com/okize)! - feat: add rules relating to barrel-file management
+
+## 1.0.1
+
+### Patch Changes
+
+- [#395](https://github.com/wistia/eslint-config/pull/395) [`48f88a3`](https://github.com/wistia/eslint-config/commit/48f88a3e297a617a02c487276907115c180d0960) Thanks [@okize](https://github.com/okize)! - fix: add `global` to vitest to avoid "no-undef" errors
+
 ## 1.0.0
 
 ### Major Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/eslint-config",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Wistia's ESLint configurations",
   "packageManager": "yarn@4.9.2",
   "type": "module",
@@ -47,6 +47,7 @@
     "@typescript-eslint/parser": "^8.48.1",
     "confusing-browser-globals": "^1.0.11",
     "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-barrel-files": "^3.0.1",
     "eslint-plugin-filenames": "^1.3.2",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jest": "^29.2.1",

package/src/configs/javascript.mjs

@@ -5,6 +5,7 @@ import jsPlugin from '@eslint/js';
 import stylisticPlugin from '@stylistic/eslint-plugin';
 import filenamesPlugin from 'eslint-plugin-filenames';
 import importPlugin from 'eslint-plugin-import';
+import barrelFilesPlugin from 'eslint-plugin-barrel-files';
 import prettierPlugin from 'eslint-plugin-prettier';
 import promisePlugin from 'eslint-plugin-promise';
 import baseRules from '../rules/base.mjs';
@@ -12,6 +13,7 @@ import stylisticRules from '../rules/stylistic.mjs';
 import promiseRules from '../rules/promise.mjs';
 import filenameRules from '../rules/filenames.mjs';
 import importRules from '../rules/import.mjs';
+import barrelFilesRules from '../rules/barrel-files.mjs';
 
 export default [
   {
@@ -33,16 +35,18 @@ export default [
       'import/extensions': ['.js', '.jsx', '.mjs', '.cjs'],
     },
     plugins: {
-      js: jsPlugin,
       '@stylistic': stylisticPlugin,
+      'barrel-files': barrelFilesPlugin,
       filenames: fixupPluginRules(filenamesPlugin),
       import: importPlugin,
+      js: jsPlugin,
       prettier: prettierPlugin,
       promise: promisePlugin,
     },
     rules: {
       ...baseRules,
       ...stylisticRules,
+      ...barrelFilesRules,
       ...filenameRules,
       ...importRules,
       ...promiseRules,

package/src/configs/typescript.mjs

@@ -5,6 +5,7 @@ import { fixupPluginRules } from '@eslint/compat';
 import stylisticPlugin from '@stylistic/eslint-plugin';
 import filenamesPlugin from 'eslint-plugin-filenames';
 import importPlugin from 'eslint-plugin-import';
+import barrelFilesPlugin from 'eslint-plugin-barrel-files';
 import prettierPlugin from 'eslint-plugin-prettier';
 import promisePlugin from 'eslint-plugin-promise';
 import baseRules from '../rules/base.mjs';
@@ -13,6 +14,7 @@ import promiseRules from '../rules/promise.mjs';
 import filenameRules from '../rules/filenames.mjs';
 import importRules from '../rules/import.mjs';
 import typescriptRules from '../rules/typescript.mjs';
+import barrelFilesRules from '../rules/barrel-files.mjs';
 
 export default [
   {
@@ -31,8 +33,9 @@ export default [
       },
     },
     plugins: {
-      '@typescript-eslint': typescriptPlugin,
       '@stylistic': stylisticPlugin,
+      '@typescript-eslint': typescriptPlugin,
+      'barrel-files': barrelFilesPlugin,
       filenames: fixupPluginRules(filenamesPlugin),
       import: importPlugin,
       prettier: prettierPlugin,
@@ -67,6 +70,7 @@ export default [
     rules: {
       ...baseRules,
       ...stylisticRules,
+      ...barrelFilesRules,
       ...filenameRules,
       ...importRules,
       ...promiseRules,

package/src/configs/vitest.mjs

@@ -10,6 +10,8 @@ export default [
     languageOptions: {
       globals: {
         ...globalsVitest,
+        // needed to avoid "no-undef" errors in vitest test files
+        global: 'readonly',
       },
     },
     plugins: {

package/src/rules/barrel-files.mjs

@@ -0,0 +1,20 @@
+// only add rules related to barrel files
+// see: https://marvinh.dev/blog/speeding-up-javascript-ecosystem-part-7/
+
+export default {
+  // Avoid barrel files
+  // https://github.com/thepassle/eslint-plugin-barrel-files/blob/main/docs/rules/avoid-barrel-files.md
+  'barrel-files/avoid-barrel-files': 'off',
+
+  // Avoid importing barrel files
+  // https://github.com/thepassle/eslint-plugin-barrel-files/blob/main/docs/rules/avoid-importing-barrel-files.md
+  'barrel-files/avoid-importing-barrel-files': 'off',
+
+  // Avoid namespace imports from barrel files
+  // https://github.com/thepassle/eslint-plugin-barrel-files/blob/main/docs/rules/avoid-namespace-import.md
+  'barrel-files/avoid-namespace-import': 'off',
+
+  // Avoid re-export all from barrel files
+  // https://github.com/thepassle/eslint-plugin-barrel-files/blob/main/docs/rules/avoid-re-export-all.md
+  'barrel-files/avoid-re-export-all': 'error',
+};

package/test/__snapshots__/javascript.mjs.snap

@@ -75,10 +75,11 @@
   },
   "plugins": [
     "@",
-    "js:@eslint/js@9.39.1",
     "@stylistic",
+    "barrel-files:eslint-plugin-barrel-files@3.0.1",
     "filenames",
     "import",
+    "js:@eslint/js@9.39.1",
     "prettier:eslint-plugin-prettier@5.5.4",
     "promise",
   ],
@@ -421,6 +422,18 @@
       0,
       "as-needed",
     ],
+    "barrel-files/avoid-barrel-files": [
+      0,
+    ],
+    "barrel-files/avoid-importing-barrel-files": [
+      0,
+    ],
+    "barrel-files/avoid-namespace-import": [
+      0,
+    ],
+    "barrel-files/avoid-re-export-all": [
+      2,
+    ],
     "block-scoped-var": [
       2,
     ],

package/test/__snapshots__/typescript.mjs.snap

@@ -77,8 +77,9 @@
   },
   "plugins": [
     "@",
-    "@typescript-eslint:@typescript-eslint/eslint-plugin@8.48.1",
     "@stylistic",
+    "@typescript-eslint:@typescript-eslint/eslint-plugin@8.48.1",
+    "barrel-files:eslint-plugin-barrel-files@3.0.1",
     "filenames",
     "import",
     "prettier:eslint-plugin-prettier@5.5.4",
@@ -893,6 +894,18 @@
       0,
       "as-needed",
     ],
+    "barrel-files/avoid-barrel-files": [
+      0,
+    ],
+    "barrel-files/avoid-importing-barrel-files": [
+      0,
+    ],
+    "barrel-files/avoid-namespace-import": [
+      0,
+    ],
+    "barrel-files/avoid-re-export-all": [
+      2,
+    ],
     "block-scoped-var": [
       2,
     ],

package/test/__snapshots__/vitest.mjs.snap

@@ -13,6 +13,7 @@
       "describe": true,
       "expect": true,
       "expectTypeOf": true,
+      "global": "readonly",
       "it": true,
       "onTestFailed": true,
       "onTestFinished": true,