zirka 0.0.25
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 +76 -0
- package/dist/styleguide.cjs +1319 -0
- package/dist/styleguide.d.cts +30 -0
- package/dist/styleguide.d.ts +30 -0
- package/dist/styleguide.js +1296 -0
- package/package.json +70 -0
- package/types/@next__eslint-plugin-next/index.d.ts +18 -0
- package/types/eslint-plugin-eslint-comments__configs/index.d.ts +5 -0
- package/types/eslint-plugin-import/index.d.ts +7 -0
- package/typescript/base.json +18 -0
package/README.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# lintie
|
|
2
|
+
|
|
3
|
+
Shared ESLint, Prettier, and TypeScript config. Configs are loaded lazily — only the plugins you enable are imported.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm i -D lintie eslint prettier typescript
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
### ESLint — `eslint.config.ts`
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { styleguide, RuleSeverity } from 'lintie';
|
|
17
|
+
|
|
18
|
+
const { eslintConfig } = styleguide({
|
|
19
|
+
browser: RuleSeverity.Error,
|
|
20
|
+
typescript: RuleSeverity.Error,
|
|
21
|
+
react: RuleSeverity.Warn,
|
|
22
|
+
next: RuleSeverity.Default,
|
|
23
|
+
node: RuleSeverity.Off,
|
|
24
|
+
playwright: RuleSeverity.Off,
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
export default eslintConfig;
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Prettier — `prettier.config.js`
|
|
31
|
+
|
|
32
|
+
```js
|
|
33
|
+
import { styleguide } from 'lintie';
|
|
34
|
+
|
|
35
|
+
const { prettierConfig } = styleguide({
|
|
36
|
+
prettier: true, // or { tailwind: true } to enable Tailwind class sorting
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
export default prettierConfig;
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### TypeScript — `tsconfig.json`
|
|
43
|
+
|
|
44
|
+
```json
|
|
45
|
+
{
|
|
46
|
+
"extends": "lintie/typescript"
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Options
|
|
51
|
+
|
|
52
|
+
| Option | Type | Description |
|
|
53
|
+
| ------------------ | --------------------------- | ---------------------------------------- |
|
|
54
|
+
| `browser` | `RuleSeverity` | Browser globals + base JS rules |
|
|
55
|
+
| `node` | `RuleSeverity` | Node.js globals |
|
|
56
|
+
| `typescript` | `RuleSeverity` | TypeScript-ESLint rules |
|
|
57
|
+
| `react` | `RuleSeverity` | React + JSX-a11y rules |
|
|
58
|
+
| `next` | `RuleSeverity` | Next.js rules |
|
|
59
|
+
| `playwright` | `RuleSeverity` | Playwright test rules |
|
|
60
|
+
| `ignores` | `string[]` | Glob patterns to ignore |
|
|
61
|
+
| `additionalConfigs`| `Linter.Config[]` | Extra flat config entries |
|
|
62
|
+
| `prettier` | `true \| { tailwind?: boolean }` | Enable Prettier config |
|
|
63
|
+
|
|
64
|
+
### `RuleSeverity`
|
|
65
|
+
|
|
66
|
+
| Value | Behaviour |
|
|
67
|
+
| ----------- | ---------------------------------------------- |
|
|
68
|
+
| `"error"` | All rules set to `error` |
|
|
69
|
+
| `"warn"` | All rules set to `warn` |
|
|
70
|
+
| `"default"` | Rules use their recommended severity as-is |
|
|
71
|
+
| `"off"` | Config block skipped entirely (no import) |
|
|
72
|
+
|
|
73
|
+
## Requirements
|
|
74
|
+
|
|
75
|
+
- Node ≥ 22.16
|
|
76
|
+
- eslint ^9 · prettier ^3 · typescript ^5 (peer deps)
|