@bedrockio/eslint-plugin 1.1.2 → 1.1.4

package/README.md

@@ -1,31 +1,95 @@
 # @bedrockio/eslint-plugin
 
-Common ESLint plugin for Bedrock projects.
+Common ESLint plugin for Bedrock projects. Note that this package uses flat config new to ESLint v9.
 
-## Installation
+- [Install](#install)
+- [Usage](#usage)
+- [VSCode](#vscode)
 
-You'll first need to install [ESLint](http://eslint.org):
+## Install
+
+Install both [ESLint](http://eslint.org) and this plugin:
 
 ```
-$ npm i eslint --save-dev
+$ npm install eslint @bedrockio/eslint-plugin --save-dev
 ```
 
-Next, install `eslint-plugin-bedrock`:
+## Usage
+
+You can now use the exported modules in a flat ESLint config:
 
-```
-$ npm install @bedrockio/eslint-plugin --save-dev
+```js
+import { recommended, react, jest } from '@bedrockio/eslint-plugin';
+
+export default [
+  jest,
+  react,
+  recommended,
+  {
+    // In most cases this won't be needed, however
+    // note that to scope rules to different files,
+    // configs will overwrite each other unless exported
+    // as an array so need to deep merge them together.
+    files: ['src/**/*.js'],
+    languageOptions: {
+      // Custom language options like babel transforms
+      // etc. Note that the exported react plugin is
+      // already set up to parse JSX. This complex
+      // setup is only if you have mixed environments
+      // in the same project.
+    },
+    plugins: {
+      ...react.plugins,
+      ...recommended.plugins,
+    },
+    settings: {
+      ...react.settings,
+      ...recommended.settings,
+    },
+    rules: {
+      ...react.rules,
+      ...recommended.rules,
+    },
+  },
+];
 ```
 
+## VSCode
 
-## Usage
+Although not part of linting, getting intellisense in VSCode to work properly in a project is a pain. To make it work nicely add this to your project:
 
-You can now extend from `recommended`, `react`, and `jest` configs.
-```json
+```jsonc
+// jsconfig.json
 {
-    "extends": [
-        "plugin:bedrock/recommended",
-        "plugin:bedrock/jest",
-        "plugin:bedrock/react"
-    ]
+  "compilerOptions": {
+    // - import from "../../components"
+    // + import from "components"
+    "baseUrl": "./src",
+    // Support JSX if needed
+    "jsx": "react-jsx",
+    "checkJs": false,
+    // Makes package imports behave better.
+    "module": "nodenext",
+    // Helps with some commonjs modules.
+    "allowSyntheticDefaultImports": true
+  },
+  // Skip parsing useless files.
+  "exclude": ["dist", "build", "node_modules"]
 }
-```
+```
+
+Another annoyance is module resolution for specific packages (specifically lodash and react-router):
+
+```js
+// You can simply import "react-router-dom"
+// but the intellisense isn't aware of this.
+import { Link } from 'react-router-dom/cjs/react-router-dom.min';
+```
+
+To fix these kind of errors simply import the appropriate types:
+
+```bash
+npm install --save-dev @types/lodash
+npm install --save-dev @types/react-router-dom
+# ...etc
+```

package/dist/cjs/mdx.js

@@ -10,6 +10,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
 const plugin = {
   ...mdx.flat,
   files: ['**/*.mdx'],
+  ignores: ['node_modules/**/*', 'dist/**/*', '**/*.d.ts'],
   processor: mdx.createRemarkProcessor({
     lintCodeBlocks: true
   }),

package/dist/cjs/node-imports.js

@@ -4,12 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _eslintPluginImport = _interopRequireDefault(require("eslint-plugin-import"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+var plugin = _interopRequireWildcard(require("eslint-plugin-import"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 var _default = exports.default = {
   files: ['**/*.{js,jsx}'],
+  ignores: ['node_modules/**/*', 'dist/**/*', '**/*.d.ts'],
   plugins: {
-    import: _eslintPluginImport.default
+    import: plugin
   },
   rules: {
     'import/no-unresolved': 'warn',
@@ -25,5 +27,12 @@ var _default = exports.default = {
       }],
       groups: ['builtin', 'external', 'internal', ['parent', 'sibling'], 'index', 'object', 'type']
     }]
+  },
+  settings: {
+    'import/resolver': {
+      node: {
+        moduleDirectory: ['node_modules', 'src']
+      }
+    }
   }
 };

package/dist/cjs/react.js

@@ -8,6 +8,7 @@ var _eslintPluginReact = _interopRequireDefault(require("eslint-plugin-react"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 var _default = exports.default = {
   files: ['**/*.{js,jsx,ts,tsx}'],
+  ignores: ['node_modules/**/*', 'dist/**/*', '**/*.d.ts'],
   plugins: {
     react: _eslintPluginReact.default
   },

package/dist/cjs/webpack-imports.js

@@ -7,17 +7,16 @@ exports.default = void 0;
 var plugin = _interopRequireWildcard(require("eslint-plugin-import"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
-const {
-  parserOptions,
-  ...rest
-} = plugin.configs.recommended;
 var _default = exports.default = {
-  ...rest,
-  files: ['**/*.{js,jsx}'],
-  plugins: {
-    import: plugin
+  ...plugin.flatConfigs.recommended,
+  files: ['**/*.{js,jsx,ts,tsx}'],
+  ignores: ['node_modules/**/*', 'dist/**/*', '**/*.d.ts'],
+  languageOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module'
   },
   rules: {
+    ...plugin.flatConfigs.recommended.rules,
     'import/no-unresolved': ['warn', {
       // package.json "style" may be used here which
       // will resolve for webpack but not within the
@@ -31,33 +30,18 @@ var _default = exports.default = {
         pattern: 'semantic',
         group: 'external'
       }, {
-        pattern: '+(stores|helpers|layouts)',
+        pattern: '+(stores|helpers|layouts|@stores|@helpers|@layouts){,/**}',
         group: 'internal',
         position: 'before'
       }, {
-        pattern: '+(stores|helpers|layouts)/**',
-        group: 'internal',
-        position: 'before'
-      }, {
-        pattern: '+(screens|modals|components)',
+        pattern: '+(screens|modals|components|@screens|@modals|@components){,/**}',
         group: 'internal'
       }, {
-        pattern: '+(screens|modals|components)/**',
-        group: 'internal'
-      }, {
-        pattern: 'utils',
+        pattern: '+(utils|@utils){,/**}',
         group: 'internal',
         position: 'after'
       }, {
-        pattern: 'utils/**',
-        group: 'internal',
-        position: 'after'
-      }, {
-        pattern: 'assets',
-        group: 'sibling',
-        position: 'after'
-      }, {
-        pattern: 'assets/**',
+        pattern: '+(assets|@assets){,**}',
         group: 'sibling',
         position: 'after'
       }],
@@ -67,10 +51,10 @@ var _default = exports.default = {
   settings: {
     'import/resolver': {
       webpack: {
-        config: 'webpack.config.js'
+        config: './webpack.config.js'
       },
       node: {
-        extensions: ['.mjs', '.js', '.jsx', '.json']
+        moduleDirectory: ['node_modules', 'src']
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/eslint-plugin",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "Common ESLint plugin for Bedrock projects.",
   "license": "MIT",
   "type": "module",

package/src/mdx.js

@@ -3,6 +3,7 @@ import * as mdx from 'eslint-plugin-mdx';
 const plugin = {
   ...mdx.flat,
   files: ['**/*.mdx'],
+  ignores: ['node_modules/**/*', 'dist/**/*', '**/*.d.ts'],
   processor: mdx.createRemarkProcessor({
     lintCodeBlocks: true,
   }),

package/src/node-imports.js

@@ -1,7 +1,8 @@
-import plugin from 'eslint-plugin-import';
+import * as plugin from 'eslint-plugin-import';
 
 export default {
   files: ['**/*.{js,jsx}'],
+  ignores: ['node_modules/**/*', 'dist/**/*', '**/*.d.ts'],
   plugins: {
     import: plugin,
   },
@@ -34,4 +35,11 @@ export default {
       },
     ],
   },
+  settings: {
+    'import/resolver': {
+      node: {
+        moduleDirectory: ['node_modules', 'src'],
+      },
+    },
+  },
 };

package/src/react.js

@@ -2,6 +2,7 @@ import react from 'eslint-plugin-react';
 
 export default {
   files: ['**/*.{js,jsx,ts,tsx}'],
+  ignores: ['node_modules/**/*', 'dist/**/*', '**/*.d.ts'],
   plugins: {
     react,
   },

package/src/webpack-imports.js

@@ -1,14 +1,15 @@
 import * as plugin from 'eslint-plugin-import';
 
-const { parserOptions, ...rest } = plugin.configs.recommended;
-
 export default {
-  ...rest,
-  files: ['**/*.{js,jsx}'],
-  plugins: {
-    import: plugin,
+  ...plugin.flatConfigs.recommended,
+  files: ['**/*.{js,jsx,ts,tsx}'],
+  ignores: ['node_modules/**/*', 'dist/**/*', '**/*.d.ts'],
+  languageOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
   },
   rules: {
+    ...plugin.flatConfigs.recommended.rules,
     'import/no-unresolved': [
       'warn',
       {
@@ -29,40 +30,23 @@ export default {
             group: 'external',
           },
           {
-            pattern: '+(stores|helpers|layouts)',
-            group: 'internal',
-            position: 'before',
-          },
-          {
-            pattern: '+(stores|helpers|layouts)/**',
+            pattern:
+              '+(stores|helpers|layouts|@stores|@helpers|@layouts){,/**}',
             group: 'internal',
             position: 'before',
           },
           {
-            pattern: '+(screens|modals|components)',
-            group: 'internal',
-          },
-          {
-            pattern: '+(screens|modals|components)/**',
+            pattern:
+              '+(screens|modals|components|@screens|@modals|@components){,/**}',
             group: 'internal',
           },
           {
-            pattern: 'utils',
+            pattern: '+(utils|@utils){,/**}',
             group: 'internal',
             position: 'after',
           },
           {
-            pattern: 'utils/**',
-            group: 'internal',
-            position: 'after',
-          },
-          {
-            pattern: 'assets',
-            group: 'sibling',
-            position: 'after',
-          },
-          {
-            pattern: 'assets/**',
+            pattern: '+(assets|@assets){,**}',
             group: 'sibling',
             position: 'after',
           },
@@ -83,10 +67,10 @@ export default {
   settings: {
     'import/resolver': {
       webpack: {
-        config: 'webpack.config.js',
+        config: './webpack.config.js',
       },
       node: {
-        extensions: ['.mjs', '.js', '.jsx', '.json'],
+        moduleDirectory: ['node_modules', 'src'],
       },
     },
   },