@dirstack/kodeks 1.0.2 → 1.0.4

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 (3) hide show
  1. package/README.md +11 -13
  2. package/configs/lefthook-oxlint.json +1 -1
  3. package/package.json +26 -2
package/README.md CHANGED
@@ -7,16 +7,14 @@ Shared linter configurations for TypeScript projects.
7
7
 
8
8
  Kodeks provides reusable, opinionated configurations for maintaining consistent code quality across TypeScript projects.
9
9
 
10
- ## Installation
11
-
12
- ```bash
13
- bun add -d @dirstack/kodeks
14
- ```
15
-
16
10
  ## Usage
17
11
 
18
12
  ### oxlint
19
13
 
14
+ ```bash
15
+ bun add -d @dirstack/kodeks oxlint
16
+ ```
17
+
20
18
  Create a `.oxlintrc.json` file in your project root:
21
19
 
22
20
  ```json
@@ -43,6 +41,10 @@ For TanStack projects, use the TanStack preset:
43
41
 
44
42
  ### oxfmt
45
43
 
44
+ ```bash
45
+ bun add -d @dirstack/kodeks oxfmt
46
+ ```
47
+
46
48
  Since oxfmt does not support configuration inheritance, you have two options:
47
49
 
48
50
  **Option 1: Reference via CLI flag**
@@ -65,10 +67,8 @@ cp ./node_modules/@dirstack/kodeks/configs/oxfmt.json ./.oxfmtrc.json
65
67
 
66
68
  ### Commitlint
67
69
 
68
- Requires `@commitlint/config-conventional` as a peer dependency:
69
-
70
70
  ```bash
71
- bun add -d @commitlint/config-conventional
71
+ bun add -d @dirstack/kodeks @commitlint/cli @commitlint/config-conventional
72
72
  ```
73
73
 
74
74
  Create a `commitlint.json` file in your project root:
@@ -81,10 +81,8 @@ Create a `commitlint.json` file in your project root:
81
81
 
82
82
  ### Semantic Release
83
83
 
84
- Requires `conventional-changelog-conventionalcommits` as a peer dependency:
85
-
86
84
  ```bash
87
- bun add -d semantic-release conventional-changelog-conventionalcommits
85
+ bun add -d @dirstack/kodeks semantic-release conventional-changelog-conventionalcommits
88
86
  ```
89
87
 
90
88
  Create a `release.json` file in your project root:
@@ -106,7 +104,7 @@ A dry-run variant is also available for CI validation:
106
104
  ### Lefthook
107
105
 
108
106
  ```bash
109
- bun add -d lefthook
107
+ bun add -d @dirstack/kodeks lefthook
110
108
  ```
111
109
 
112
110
  Create a `lefthook.json` file in your project root and extend the hooks you need:
package/configs/lefthook-oxlint.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "commands": {
6
6
  "lint:oxlint": {
7
7
  "glob": "*.{ts,tsx,js,jsx}",
8
- "run": "bunx oxlint --fix --no-errors-on-unmatched --files-ignore-unknown=true {staged_files}",
8
+ "run": "bunx oxlint --fix {staged_files}",
9
9
  "stage_fixed": true
10
10
  }
11
11
  }
package/package.json CHANGED
@@ -41,20 +41,44 @@
41
41
  "typescript": "^5.9.3"
42
42
  },
43
43
  "peerDependencies": {
44
+ "@commitlint/cli": ">=20",
44
45
  "@commitlint/config-conventional": ">=20",
45
- "conventional-changelog-conventionalcommits": ">=9"
46
+ "conventional-changelog-conventionalcommits": ">=9",
47
+ "lefthook": ">=2",
48
+ "oxfmt": ">=0.35",
49
+ "oxlint": ">=1",
50
+ "semantic-release": ">=25",
51
+ "typescript": ">=5"
46
52
  },
47
53
  "peerDependenciesMeta": {
54
+ "@commitlint/cli": {
55
+ "optional": true
56
+ },
48
57
  "@commitlint/config-conventional": {
49
58
  "optional": true
50
59
  },
51
60
  "conventional-changelog-conventionalcommits": {
52
61
  "optional": true
62
+ },
63
+ "lefthook": {
64
+ "optional": true
65
+ },
66
+ "oxfmt": {
67
+ "optional": true
68
+ },
69
+ "oxlint": {
70
+ "optional": true
71
+ },
72
+ "semantic-release": {
73
+ "optional": true
74
+ },
75
+ "typescript": {
76
+ "optional": true
53
77
  }
54
78
  },
55
79
  "engines": {
56
80
  "bun": ">=1.0.0"
57
81
  },
58
82
  "packageManager": "bun@1.3.9",
59
- "version": "1.0.2"
83
+ "version": "1.0.4"
60
84
  }