@singlepixellab/eslint-config 1.0.0

package/.editorconfig

@@ -0,0 +1,11 @@
+# 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/.eslintrc

@@ -0,0 +1,3 @@
+// This empty file is added because of an issue with eslint-plugin-import,
+// remove it when the below issue is fixed
+// https://github.com/import-js/eslint-plugin-import/issues/3079

package/.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+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

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

package/.vscode/settings.json

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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Single Pixel Lab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,22 @@
+# @singlepixellab/eslint-config
+
+The ESLint rules and configs used by Single Pixel Lab.
+
+## Usage
+
+1. Install package
+   ```
+   npm install -dev @singlepixellab/eslint-config
+   ```
+
+## VS Code
+
+- Install [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) for VS Code: `dbaeumer.vscode-eslint`
+- To run ESLint fix command (i.e. eslint --fix) whenever a file is saved, add the following config in the `settings.json` file:
+  ```
+  {
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": "explicit"
+    },
+  }
+  ```

package/eslint.config.js

@@ -0,0 +1,30 @@
+import ignores from "./rules/ignores.js";
+import core from "./rules/core.js";
+import imports from "./rules/imports.js";
+import react from "./rules/react.js";
+import prettier from "./rules/prettier.js";
+import jsdoc from "./rules/jsdoc.js";
+import styles from "./rules/styles.js";
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  // Global ignores should always be first
+  ...ignores,
+
+  ...core,
+
+  // styles: @stylistic/eslint-plugin
+  ...styles,
+
+  // eslint-plugin-import
+  ...imports,
+
+  // eslint-plugin-jsdoc
+  ...jsdoc,
+
+  // eslint-plugin-react, eslint-plugin-react-hooks etc
+  ...react,
+
+  // Prettier should be last to have the opportunity to override other configs
+  ...prettier,
+];

package/index.js

@@ -0,0 +1,20 @@
+import config from "./eslint.config";
+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,
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@singlepixellab/eslint-config",
+  "version": "1.0.0",
+  "description": "The ESLint rules and configs used by Single Pixel Lab",
+  "author": "Single Pixel Lab",
+  "keywords": [
+    "eslint",
+    "eslintconfig",
+    "eslint-config",
+    "lint"
+  ],
+  "license": "MIT",
+  "private": false,
+  "homepage": "https://github.com/singlepixellab/eslint-config#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/singlepixellab/eslint-config.git"
+  },
+  "bugs": {
+    "url": "https://github.com/singlepixellab/eslint-config/issues"
+  },
+  "main": "index.js",
+  "type": "module",
+  "prettier": "@singlepixellab/prettier-config",
+  "peerDependencies": {
+    "eslint": ">= 9"
+  },
+  "scripts": {
+    "format": "prettier --cache --write .",
+    "format:check": "prettier --cache --check .",
+    "lint": "eslint .",
+    "inspect": "eslint --inspect-config"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.32.0",
+    "@singlepixellab/prettier-config": "^1.0.0",
+    "@stylistic/eslint-plugin": "^5.2.2",
+    "eslint": "^9.32.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsdoc": "^51.4.1",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-prettier": "^5.5.3",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "globals": "^16.3.0",
+    "prettier": "^3.6.2"
+  }
+}