@bedrockio/eslint-plugin 1.0.0

package/README.md

@@ -0,0 +1,31 @@
+# @bedrockio/eslint-plugin
+
+Common ESLint plugin for Bedrock projects.
+
+## Installation
+
+You'll first need to install [ESLint](http://eslint.org):
+
+```
+$ npm i eslint --save-dev
+```
+
+Next, install `eslint-plugin-bedrock`:
+
+```
+$ npm install @bedrockio/eslint-plugin --save-dev
+```
+
+
+## Usage
+
+You can now extend from `recommended`, `react`, and `jest` configs.
+```json
+{
+    "extends": [
+        "plugin:bedrock/recommended",
+        "plugin:bedrock/jest",
+        "plugin:bedrock/react"
+    ]
+}
+```

package/index.js

@@ -0,0 +1,19 @@
+import { default as recommended } from './recommended.js';
+import { default as react } from './react.js';
+import { default as jest } from './jest.js';
+import { default as mdx } from './mdx.js';
+import { default as nodeImports } from './node-imports.js';
+import { default as webpackImports } from './webpack-imports.js';
+import { default as typescriptImports } from './typescript-imports.js';
+
+export default {
+  configs: {
+    mdx,
+    jest,
+    react,
+    recommended,
+    nodeImports,
+    webpackImports,
+    typescriptImports,
+  },
+};

package/jest.js

@@ -0,0 +1,23 @@
+import plugin from 'eslint-plugin-jest';
+import globals from 'globals';
+
+export default {
+  ...plugin.configs['flat/recommended'],
+  files: ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)'],
+  languageOptions: {
+    globals: {
+      ...globals.jest,
+    },
+  },
+  rules: {
+    'jest/expect-expect': [
+      'error',
+      {
+        assertFunctionNames: ['expect*', 'assert*'],
+      },
+    ],
+    'jest/no-focused-tests': 'off',
+    'jest/no-disabled-tests': 'off',
+    'jest/no-conditional-expect': 'off',
+  },
+};

package/mdx.js

@@ -0,0 +1,19 @@
+import mdx from 'eslint-plugin-mdx';
+
+const plugin = {
+  ...mdx.flat,
+  processor: mdx.createRemarkProcessor({
+    lintCodeBlocks: true,
+  }),
+  rules: {
+    ...mdx.flat.rules,
+    semi: 0,
+    'no-undef': 0,
+  },
+};
+
+Object.defineProperty(plugin, 'codeBlocks', {
+  value: mdx.flatCodeBlocks,
+});
+
+export default plugin;

package/node-imports.js

@@ -0,0 +1,37 @@
+import plugin from 'eslint-plugin-import';
+
+export default {
+  files: ['**/*.{js,jsx}'],
+  plugins: {
+    import: plugin,
+  },
+  rules: {
+    'import/no-unresolved': 'warn',
+    'import/no-named-as-default-member': 'off',
+    'import/order': [
+      'warn',
+      {
+        'newlines-between': 'always-and-inside-groups',
+        pathGroups: [
+          {
+            pattern: 'utils',
+            group: 'internal',
+          },
+          {
+            pattern: 'utils/**',
+            group: 'internal',
+          },
+        ],
+        groups: [
+          'builtin',
+          'external',
+          'internal',
+          ['parent', 'sibling'],
+          'index',
+          'object',
+          'type',
+        ],
+      },
+    ],
+  },
+};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@bedrockio/eslint-plugin",
+  "version": "1.0.0",
+  "description": "Common ESLint plugin for Bedrock projects.",
+  "license": "MIT",
+  "type": "module",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin"
+  ],
+  "main": "index.js",
+  "dependencies": {
+    "@eslint/compat": "^1.0.1",
+    "@eslint/js": "^9.2.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jest": "^28.5.0",
+    "eslint-plugin-mdx": "^3.1.5",
+    "eslint-plugin-react": "^7.34.1",
+    "globals": "^15.2.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=9",
+    "eslint-import-resolver-webpack": "^0.13.8"
+  },
+  "peerDependenciesMeta": {
+    "eslint-import-resolver-webpack": {
+      "optional": true
+    },
+    "eslint-plugin-react": {
+      "optional": true
+    },
+    "eslint-plugin-mdx": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "eslint": "^9.2.0",
+    "eslint-import-resolver-webpack": "^0.13.8"
+  },
+  "volta": {
+    "node": "20.12.2",
+    "yarn": "1.22.22"
+  }
+}

package/react.js

@@ -0,0 +1,32 @@
+import react from 'eslint-plugin-react';
+import globals from 'globals';
+
+// This dependency can be removed when this lands:
+// https://github.com/jsx-eslint/eslint-plugin-react/issues/3699
+import { fixupPluginRules } from '@eslint/compat';
+
+export default {
+  files: ['**/*.{js,jsx}'],
+  plugins: {
+    react: fixupPluginRules(react),
+  },
+  languageOptions: {
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true,
+      },
+    },
+    globals: {
+      ...globals.browser,
+    },
+  },
+  rules: {
+    ...react.configs['recommended'].rules,
+    ...react.configs['jsx-runtime'].rules,
+  },
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+};

package/recommended.js

@@ -0,0 +1,26 @@
+import js from '@eslint/js';
+import globals from 'globals';
+
+export default {
+  files: ['**/*.{js,jsx}'],
+  languageOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    globals: {
+      ...globals.node,
+      ...globals.browser,
+    },
+  },
+  rules: {
+    ...js.configs.recommended.rules,
+    semi: 'error',
+    'no-console': 'warn',
+    curly: ['error', 'multi-line', 'consistent'],
+    'no-unused-vars': [
+      'warn',
+      {
+        ignoreRestSiblings: true,
+      },
+    ],
+  },
+};

package/typescript-imports.js

@@ -0,0 +1,41 @@
+import plugin from 'eslint-plugin-import';
+
+const { parserOptions, ...rest } = plugin.configs.recommended;
+
+export default {
+  ...rest,
+  files: ['**/*.{ts,tsx}'],
+  plugins: {
+    import: plugin,
+  },
+  rules: {
+    'prefer-const': 'off',
+    'import/no-unresolved': 'warn',
+    'import/no-named-as-default-member': 'off',
+    'import/order': [
+      'warn',
+      {
+        'newlines-between': 'always-and-inside-groups',
+        pathGroups: [
+          {
+            pattern: 'utils',
+            group: 'internal',
+          },
+          {
+            pattern: 'utils/**',
+            group: 'internal',
+          },
+        ],
+        groups: [
+          'builtin',
+          'external',
+          'internal',
+          ['parent', 'sibling'],
+          'index',
+          'object',
+          'type',
+        ],
+      },
+    ],
+  },
+};

package/webpack-imports.js

@@ -0,0 +1,68 @@
+import plugin from 'eslint-plugin-import';
+
+const { parserOptions, ...rest } = plugin.configs.recommended;
+
+export default {
+  ...rest,
+  files: ['**/*.{js,jsx}'],
+  plugins: {
+    import: plugin,
+  },
+  rules: {
+    'import/no-unresolved': 'warn',
+    'import/no-named-as-default-member': 'off',
+    'import/order': [
+      'warn',
+      {
+        'newlines-between': 'always-and-inside-groups',
+        pathGroups: [
+          {
+            pattern: 'semantic',
+            group: 'external',
+          },
+          {
+            pattern: '+(stores|helpers|layouts)',
+            group: 'internal',
+            position: 'before',
+          },
+          {
+            pattern: '+(stores|helpers|layouts)/**',
+            group: 'internal',
+            position: 'before',
+          },
+          {
+            pattern: '+(screens|modals|components)',
+            group: 'internal',
+          },
+          {
+            pattern: '+(screens|modals|components)/**',
+            group: 'internal',
+          },
+          {
+            pattern: 'utils',
+            group: 'internal',
+            position: 'after',
+          },
+          {
+            pattern: 'utils/**',
+            group: 'internal',
+            position: 'after',
+          },
+        ],
+        groups: [
+          'builtin',
+          'unknown',
+          'external',
+          'internal',
+          ['parent', 'sibling'],
+          'index',
+          'object',
+          'type',
+        ],
+      },
+    ],
+  },
+  settings: {
+    'import/resolver': 'webpack',
+  },
+};