@mkappelhof/eslint-config-base 1.0.5 → 1.0.9

package/.eslintrc.yml

@@ -32,11 +32,11 @@ rules:
     - groups:
         - - '^react'
           - "^@?\\w"
-        - - '^(components|modules|utils)(/.*|$)'
-        - - "^\\u0000"
-        - - "^\\.\\.(?!/?$)"
+          - '^@(/.*|$)'
+          - "^\\u0000"
+          - "^\\.\\.(?!/?$)"
           - "^\\.\\./?$"
-        - - "^\\./(?=.*/)(?!/?$)"
+          - "^\\./(?=.*/)(?!/?$)"
           - "^\\.(?!/?$)"
           - "^\\./?$"
-        - - "^.+\\.?(css)$"
+          - "^.+\\.s?css$"

package/AGENTS.md

@@ -0,0 +1,22 @@
+# @mkappelhof/eslint-config-base — agent instructions
+
+These are the shared ESLint rules that `@mkappelhof/eslint-config-next`, `-react`, `-node` and `-remix` all build on. Projects don't use this package directly. Its rules apply to every project that uses one of those configs.
+
+## Commands
+
+- `pnpm eslint .` lints the project.
+- `pnpm eslint --fix <files>` applies auto-fixes, including import sorting.
+
+The task is not done while `pnpm eslint` reports errors in the files you changed.
+
+## Rules
+
+- **No `any`** (`@typescript-eslint/no-explicit-any`). Use `unknown` and narrow it, or write a proper type.
+- **Type-only imports use `import type`** (`@typescript-eslint/consistent-type-imports`).
+- **No unused variables.** Prefix intentionally unused arguments, variables or caught errors with `_` (`_event`, `_err`).
+- **No `console`** (`no-console`). Use the project's logger, or remove debug output before you finish.
+- **Arrow functions use a concise body when they only return a value** (`arrow-body-style: as-needed`): `const f = (x) => x * 2`, not `(x) => { return x * 2; }`.
+- **Imports are sorted** (`simple-import-sort`): React first, then packages, aliases (`@/…`), relative imports, and stylesheets last. Run `eslint --fix` to sort them. Do not sort by hand.
+- Formatting is handled by Prettier (`@mkappelhof/prettier-config`). ESLint does not check style.
+
+Do not disable rules with `eslint-disable` comments to make an error go away. If a disable is truly needed, scope it to one line and add a reason: `// eslint-disable-next-line <rule> -- <reason>`.

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @mkappelhof/eslint-config-base
 
+## 1.0.9
+
+### Patch Changes
+
+- 9665a73: Add an `AGENTS.md` with instructions for AI coding agents, and switch the install docs from yarn to pnpm.
+- Updated dependencies [9665a73]
+  - @mkappelhof/prettier-config@1.0.7
+
+## 1.0.8
+
+### Patch Changes
+
+- 4035554: Add biome config
+
+## 1.0.7
+
+### Patch Changes
+
+- 7a413a3: Add deployment to Github
+- Updated dependencies [7a413a3]
+  - @mkappelhof/prettier-config@1.0.6
+
+## 1.0.6
+
+### Patch Changes
+
+- 3d8ee7b: remove linebreakes between import statements
+
 ## 1.0.5
 
 ### Patch Changes

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Maurice
+
+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

@@ -5,3 +5,11 @@ Base ESLint configuration to extend from in other, more specified configurations
 - For Next.js projects use [@mkappelhof/eslint-config-next](https://www.npmjs.com/package/@mkappelhof/eslint-config-next)
 - For Node.js projects use [@mkappelhof/eslint-config-node](https://www.npmjs.com/package/@mkappelhof/eslint-config-node)
 - For React projects use [@mkappelhof/eslint-config-react](https://www.npmjs.com/package/@mkappelhof/eslint-config-react)
+
+## AI agents
+
+This package ships an `AGENTS.md` that describes the conventions this config enforces. Reference it from your project's `AGENTS.md`:
+
+```md
+- Follow `node_modules/@mkappelhof/eslint-config-base/AGENTS.md`
+```

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@mkappelhof/eslint-config-base",
-  "version": "1.0.5",
+  "version": "1.0.9",
   "main": "index.js",
   "license": "MIT",
   "repository": "git@github.com:mkappelhof/frontend-tools.git",
   "author": "Maurice Kappelhof <maurice@mauricekappelhof.nl>",
-  "scripts": {
-    "build": "rollup -c",
-    "test": "yaml-validator .eslintrc.yml"
-  },
   "dependencies": {
-    "@mkappelhof/prettier-config": "*",
     "@typescript-eslint/eslint-plugin": "6.3.0",
     "@typescript-eslint/parser": "6.3.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-prettier": "5.0.0",
     "eslint-plugin-simple-import-sort": "10.0.0",
-    "yaml-validator": "5.1.0"
+    "yaml-validator": "5.1.0",
+    "@mkappelhof/prettier-config": "1.0.7"
   },
   "peerDependencies": {
-    "eslint": "8.46.0",
+    "eslint": "9.27.0",
     "typescript": "5.1.6"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "test": "yaml-validator .eslintrc.yml"
   }
-}
+}