@mkappelhof/eslint-config-remix 1.0.2 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/AGENTS.md +16 -0
  2. package/CHANGELOG.md +37 -0
  3. package/LICENSE +21 -0
  4. package/README.md +9 -1
  5. package/package.json +11 -11
package/AGENTS.md ADDED
@@ -0,0 +1,16 @@
1
+ # @mkappelhof/eslint-config-remix — agent instructions
2
+
3
+ This project lints with `@mkappelhof/eslint-config-remix`. All rules from these packages also apply:
4
+
5
+ - `@mkappelhof/eslint-config-base`: read `node_modules/@mkappelhof/eslint-config-base/AGENTS.md`
6
+ - `@mkappelhof/eslint-config-react`: read `node_modules/@mkappelhof/eslint-config-react/AGENTS.md`
7
+
8
+ ## Commands
9
+
10
+ - `pnpm eslint .` lints the project.
11
+ - `pnpm eslint --fix <files>` applies auto-fixes.
12
+
13
+ ## Remix / React Router conventions
14
+
15
+ - Route modules may export several things (`loader`, `action`, `meta`, a default component). The one-component-per-file rule (`react/no-multi-comp`) still applies, so put extra components in their own files.
16
+ - Use the framework's `<Link>` / `<NavLink>` for internal navigation, not a plain `<a href="/…">`.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,42 @@
1
1
  # @mkappelhof/eslint-config-remix
2
2
 
3
+ ## 1.0.6
4
+
5
+ ### Patch Changes
6
+
7
+ - eb2577f: Add new configs
8
+ - Updated dependencies [eb2577f]
9
+ - @mkappelhof/eslint-config-react@1.0.9
10
+
11
+ ## 1.0.5
12
+
13
+ ### Patch Changes
14
+
15
+ - 9665a73: Add an `AGENTS.md` with instructions for AI coding agents, and switch the install docs from yarn to pnpm.
16
+ - Updated dependencies [9665a73]
17
+ - @mkappelhof/prettier-config@1.0.7
18
+ - @mkappelhof/eslint-config-base@1.0.9
19
+ - @mkappelhof/eslint-config-react@1.0.8
20
+
21
+ ## 1.0.4
22
+
23
+ ### Patch Changes
24
+
25
+ - 4035554: Add biome config
26
+ - Updated dependencies [4035554]
27
+ - @mkappelhof/eslint-config-base@1.0.8
28
+ - @mkappelhof/eslint-config-react@1.0.7
29
+
30
+ ## 1.0.3
31
+
32
+ ### Patch Changes
33
+
34
+ - 7a413a3: Add deployment to Github
35
+ - Updated dependencies [7a413a3]
36
+ - @mkappelhof/eslint-config-base@1.0.7
37
+ - @mkappelhof/eslint-config-react@1.0.6
38
+ - @mkappelhof/prettier-config@1.0.6
39
+
3
40
  ## 1.0.2
4
41
 
5
42
  ### Patch Changes
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Maurice
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -10,7 +10,7 @@ This ESLint configuration is for projects that use Remix.
10
10
 
11
11
  Add the configuration as a dev dependency:
12
12
 
13
- `yarn add @mkappelhof/eslint-config-remix`
13
+ `pnpm add -D @mkappelhof/eslint-config-remix`
14
14
 
15
15
  Then create a `.eslintrc.js` config file with the following content:
16
16
 
@@ -19,3 +19,11 @@ module.exports = {
19
19
  extends: ['@mkappelhof/eslint-config-remix'],
20
20
  };
21
21
  ```
22
+
23
+ ## AI agents
24
+
25
+ This package ships an `AGENTS.md` that describes the conventions this config enforces. Reference it from your project's `AGENTS.md`:
26
+
27
+ ```md
28
+ - Follow `node_modules/@mkappelhof/eslint-config-remix/AGENTS.md`
29
+ ```
package/package.json CHANGED
@@ -1,21 +1,17 @@
1
1
  {
2
2
  "name": "@mkappelhof/eslint-config-remix",
3
- "version": "1.0.2",
3
+ "version": "1.0.6",
4
4
  "main": "index.js",
5
5
  "license": "MIT",
6
6
  "repository": "git@github.com:mkappelhof/frontend-tools.git",
7
7
  "author": "Maurice Kappelhof <maurice@mauricekappelhof.nl>",
8
- "scripts": {
9
- "build": "rollup -c",
10
- "test": "yaml-validator .eslintrc.yml"
11
- },
12
8
  "dependencies": {
13
- "@mkappelhof/eslint-config-base": "*",
14
- "@mkappelhof/eslint-config-react": "*",
15
- "@mkappelhof/prettier-config": "*",
16
9
  "eslint-config-next": "13.4.13",
17
10
  "eslint-plugin-react": "7.33.1",
18
- "yaml-validator": "5.1.0"
11
+ "yaml-validator": "5.1.0",
12
+ "@mkappelhof/eslint-config-react": "1.0.9",
13
+ "@mkappelhof/eslint-config-base": "1.0.9",
14
+ "@mkappelhof/prettier-config": "1.0.7"
19
15
  },
20
16
  "peerDependencies": {
21
17
  "eslint": "8.46.0",
@@ -28,5 +24,9 @@
28
24
  "remix.js",
29
25
  "remix.run",
30
26
  "typescript"
31
- ]
32
- }
27
+ ],
28
+ "scripts": {
29
+ "build": "rollup -c",
30
+ "test": "yaml-validator .eslintrc.yml"
31
+ }
32
+ }