@opinionated-ts/config 0.1.0 → 1.0.0
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.
- package/README.md +48 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1 +1,48 @@
|
|
|
1
|
-
# config
|
|
1
|
+
# @opinionated-ts/config
|
|
2
|
+
|
|
3
|
+
Opinionated, reusable TypeScript tooling configurations focused on performance, code quality, and developer experience.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
bun add -D @opinionated-ts/config
|
|
9
|
+
|
|
10
|
+
# npm install -D @opinionated-ts/config
|
|
11
|
+
# pnpm add -D @opinionated-ts/config
|
|
12
|
+
# yarn add -D @opinionated-ts/config
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
Import the configurations you need:
|
|
18
|
+
|
|
19
|
+
<!-- prettier-ignore -->
|
|
20
|
+
```ts
|
|
21
|
+
import {
|
|
22
|
+
commitlintConfig,
|
|
23
|
+
cspellConfig,
|
|
24
|
+
oxfmtConfig,
|
|
25
|
+
oxlintConfig,
|
|
26
|
+
} from "@opinionated-ts/config";
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
<!-- prettier-ignore -->
|
|
30
|
+
Each configuration can be used directly as a recommended default or customized depending on the configuration system supported by each tool.
|
|
31
|
+
|
|
32
|
+
See the configuration guides for each tool:
|
|
33
|
+
|
|
34
|
+
- [Commitlint](./docs/commitlint.md)
|
|
35
|
+
- [CSpell](./docs/cspell.md)
|
|
36
|
+
- [Oxfmt](./docs/oxfmt.md)
|
|
37
|
+
- [Oxlint](./docs/oxlint.md)
|
|
38
|
+
|
|
39
|
+
## Philosophy
|
|
40
|
+
|
|
41
|
+
This package provides recommended, opinionated configurations designed to reduce project setup time and maintain consistent tooling across TypeScript projects.
|
|
42
|
+
|
|
43
|
+
The configurations prioritize:
|
|
44
|
+
|
|
45
|
+
- Performance
|
|
46
|
+
- Code quality
|
|
47
|
+
- Developer experience
|
|
48
|
+
- Modern tooling
|
package/package.json
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.1.0",
|
|
3
2
|
"name": "@opinionated-ts/config",
|
|
4
3
|
"description": "Opinionated, reusable TypeScript development configurations focused on performance, code quality and developer experience.",
|
|
5
4
|
"keywords": [
|
|
@@ -83,5 +82,6 @@
|
|
|
83
82
|
"bun": "^1.4.0",
|
|
84
83
|
"node": "^26.2.0"
|
|
85
84
|
},
|
|
86
|
-
"packageManager": "bun@1.4.0"
|
|
85
|
+
"packageManager": "bun@1.4.0",
|
|
86
|
+
"version": "1.0.0"
|
|
87
87
|
}
|