@singlepixellab/eslint-config 1.2.1 → 2.0.1

package/README.md

@@ -2,12 +2,65 @@
 
 The ESLint rules and configs used by Single Pixel Lab.
 
+## Requirements
+
+- Node.js ≥ 18
+- ESLint ≥ 9
+
 ## Usage
 
-1. Install package
-   ```
-   npm install -dev @singlepixellab/eslint-config eslint
-   ```
+Install package
+
+```
+npm install -dev @singlepixellab/eslint-config eslint
+```
+
+This package provides a default configuration as well as modular rule sets that can be composed as needed.
+
+### Default configuration
+
+You can use the full configuration directly:
+
+```js
+import config from "@singlepixellab/eslint-config";
+
+export default config;
+```
+
+### Modular configurations
+
+Each rule set can also be imported individually using subpath exports.
+
+```js
+import react from "@singlepixellab/eslint-config/react";
+import styles from "@singlepixellab/eslint-config/styles";
+
+export default [...styles, ...react];
+```
+
+Available modules:
+
+| Module   | Import                                   | Description                    |
+| -------- | ---------------------------------------- | ------------------------------ |
+| Core     | `@singlepixellab/eslint-config/core`     | Base ESLint rules              |
+| Ignore   | `@singlepixellab/eslint-config/ignores`  | Default ignore patterns        |
+| Import   | `@singlepixellab/eslint-config/imports`  | Import ordering and validation |
+| JSDoc    | `@singlepixellab/eslint-config/jsdoc`    | JSDoc linting                  |
+| Prettier | `@singlepixellab/eslint-config/prettier` | Prettier integration           |
+| React    | `@singlepixellab/eslint-config/react`    | React and Hooks rules          |
+| Style    | `@singlepixellab/eslint-config/styles`   | Stylistic rules                |
+
+### Named exports
+
+Alternatively, the same configurations can be imported from the package entry.
+
+```js
+import { reactConfig, stylesConfig } from "@singlepixellab/eslint-config";
+
+export default [...stylesConfig, ...reactConfig];
+```
+
+Named exports are provided for convenience, while subpath imports are generally recommended for clarity and tree-shaking.
 
 ## VS Code
 

package/eslint.config.js

@@ -11,9 +11,6 @@ export default [
   // Global ignores should always be first
   ...ignores,
 
-  // styles: @stylistic/eslint-plugin
-  ...styles,
-
   // eslint-plugin-import
   ...imports,
 
@@ -25,6 +22,9 @@ export default [
 
   ...core,
 
+  // styles: @stylistic/eslint-plugin
+  ...styles,
+
   // Prettier should be last to have the opportunity to override other configs
   ...prettier,
 ];

package/index.js

@@ -1,20 +1,11 @@
 import config from "./eslint.config.js";
-import core from "./rules/core.js";
-import ignores from "./rules/ignores.js";
-import imports from "./rules/imports.js";
-import jsdoc from "./rules/jsdoc.js";
-import prettier from "./rules/prettier.js";
-import react from "./rules/react.js";
-import styles from "./rules/styles.js";
 
 export default config;
 
-export const configs = {
-  core,
-  ignores,
-  imports,
-  jsdoc,
-  prettier,
-  react,
-  styles,
-};
+export { default as coreConfig } from "./rules/core.js";
+export { default as ignoresConfig } from "./rules/ignores.js";
+export { default as importsConfig } from "./rules/imports.js";
+export { default as jsdocConfig } from "./rules/jsdoc.js";
+export { default as prettierConfig } from "./rules/prettier.js";
+export { default as reactConfig } from "./rules/react.js";
+export { default as stylesConfig } from "./rules/styles.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singlepixellab/eslint-config",
-  "version": "1.2.1",
+  "version": "2.0.1",
   "description": "The ESLint rules and configs used by Single Pixel Lab",
   "author": "Single Pixel Lab",
   "keywords": [
@@ -19,9 +19,42 @@
   "bugs": {
     "url": "https://github.com/singlepixellab/eslint-config/issues"
   },
-  "main": "index.js",
   "type": "module",
   "prettier": "@singlepixellab/prettier-config",
+  "files": [
+    "index.js",
+    "eslint.config.js",
+    "rules"
+  ],
+  "exports": {
+    ".": {
+      "import": "./index.js"
+    },
+    "./core": {
+      "import": "./rules/core.js"
+    },
+    "./ignores": {
+      "import": "./rules/ignores.js"
+    },
+    "./imports": {
+      "import": "./rules/imports.js"
+    },
+    "./jsdoc": {
+      "import": "./rules/jsdoc.js"
+    },
+    "./prettier": {
+      "import": "./rules/prettier.js"
+    },
+    "./react": {
+      "import": "./rules/react.js"
+    },
+    "./styles": {
+      "import": "./rules/styles.js"
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
   "peerDependencies": {
     "eslint": ">= 9"
   },
@@ -32,20 +65,20 @@
     "inspect": "eslint --inspect-config"
   },
   "devDependencies": {
-    "@singlepixellab/prettier-config": "^1.1.0",
-    "eslint": "^9.32.0",
-    "prettier": "^3.6.2"
+    "@singlepixellab/prettier-config": "^1.2.0",
+    "eslint": "^9.39.4",
+    "prettier": "^3.8.1"
   },
   "dependencies": {
-    "@eslint/js": "^9.32.0",
-    "@stylistic/eslint-plugin": "^5.2.2",
+    "@eslint/js": "^9.39.4",
+    "@stylistic/eslint-plugin": "^5.10.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jsdoc": "^52.0.2",
+    "eslint-plugin-jsdoc": "^62.7.1",
     "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-prettier": "^5.5.3",
+    "eslint-plugin-prettier": "^5.5.5",
     "eslint-plugin-react": "^7.37.5",
-    "eslint-plugin-react-hooks": "^5.2.0",
-    "globals": "^16.3.0"
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "globals": "^17.4.0"
   }
 }

package/rules/react.js

@@ -53,19 +53,16 @@ export default [
       "react/jsx-boolean-value": ["error", "never", { always: [] }],
 
       // Validate closing bracket location in JSX
-      "react/jsx-closing-bracket-location": ["error", "tag-aligned"],
+      "react/jsx-closing-bracket-location": "off",
 
       // Validate closing tag location in JSX
-      "react/jsx-closing-tag-location": "error",
+      "react/jsx-closing-tag-location": "off",
 
       // Enforce or disallow spaces inside of curly braces in JSX attributes
-      "react/jsx-curly-spacing": [
-        "error",
-        { when: "never", allowMultiline: true },
-      ],
+      "react/jsx-curly-spacing": "off",
 
       // Enforce or disallow spaces around equal sign
-      "react/jsx-equals-spacing": ["warn", "never"],
+      "react/jsx-equals-spacing": "off",
 
       // No jsx extension
       // https://github.com/facebook/create-react-app/issues/87#issuecomment-234627904
@@ -78,13 +75,10 @@ export default [
       "react/jsx-handler-names": "off",
 
       // Validate props indentation in JSX
-      "react/jsx-indent-props": ["error", 2],
+      "react/jsx-indent-props": "off",
 
       // Limit maximum of props on a single line in JSX
-      "react/jsx-max-props-per-line": [
-        "error",
-        { maximum: 1, when: "multiline" },
-      ],
+      "react/jsx-max-props-per-line": "off",
 
       // Prevent usage of .bind() in JSX props
       "react/jsx-no-bind": [

package/.editorconfig

@@ -1,11 +0,0 @@
-# https://editorconfig.org
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-tab_width = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true

package/.github/workflows/publish.yml

@@ -1,21 +0,0 @@
-name: Publish Package to npmjs
-on:
-  release:
-    types: [published]
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-    steps:
-      - uses: actions/checkout@v4
-      # Setup .npmrc file to publish to npm
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-      - run: npm ci
-      - run: npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.vscode/extensions.json

@@ -1,7 +0,0 @@
-{
-  "recommendations": [
-    "EditorConfig.EditorConfig",
-    "esbenp.prettier-vscode",
-    "dbaeumer.vscode-eslint"
-  ]
-}

package/.vscode/settings.json

@@ -1,8 +0,0 @@
-{
-  "search.exclude": {
-    "**/package-lock.json": true
-  },
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": "explicit"
-  }
-}