linted 12.1.1 → 12.1.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 (2) hide show
  1. package/README.md +24 -2
  2. package/package.json +2 -3
package/README.md CHANGED
@@ -28,7 +28,7 @@ Zero-config [**ESLint**](https://eslint.org/) flat config factory for (strict, a
28
28
 
29
29
  ### One-Arugment API
30
30
 
31
- - Scope (i.e. file to lint)
31
+ - Scope (i.e. files to lint)
32
32
  - *Optional:* [override](#full-control-via-per-scope-override) rules
33
33
 
34
34
  ### Two-Statement `eslint.config.js`
@@ -100,12 +100,34 @@ No need to remember each plugin's `parserOptions`; you won't have to do *this* j
100
100
  processor: "svelte/svelte"
101
101
  ```
102
102
 
103
+ ## Limitation
104
+
105
+ If linting `TypeScript` files, [`skipLibCheck`](https://www.typescriptlang.org/tsconfig/#skipLibCheck) must be disabled.
106
+
107
+ - This compromise was required to enable linting `jest` files.
108
+ - Installing `jest` even without the linter seems to break strict `TypeScript` projects (needs verification).
109
+ - Issue [#30](https://github.com/jimmy-zhening-luo/linted/issues/30) tracks investigating if feasible to enable `jest` linting without disabling `skipLibCheck`.
110
+
111
+ ### `tsconfig.json`
112
+
113
+ ```jsonc
114
+ {
115
+ "compilerOptions": {
116
+ "skipLibCheck": false,
117
+ },
118
+ }
119
+ ```
120
+
121
+ ### `tsc` CLI
122
+
123
+ `tsc --skipLibCheck`
124
+
103
125
  ## Install
104
126
 
105
127
  1. Install [`eslint`](https://npmjs.com/package/eslint) and [`linted`](https://npmjs.com/package/linted)
106
128
 
107
129
  ```bash
108
- npm i -D eslint linted
130
+ npm i -D eslint@^8.57 linted@^12.1
109
131
  ```
110
132
 
111
133
  1. Create `eslint.config.js` in your root directory.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "linted",
3
- "version": "12.1.1",
4
- "description": "Zero-config ESLint flat config factory for (strict, agglutinative) entire-stack formatting and linting: TypeScript, JavaScript, Svelte, HTML, (Tailwind) CSS, Jest, JSON/5/C, and sadly YAML.",
3
+ "version": "12.1.4",
4
+ "description": "Zero-config ESLint flat config factory for (strict, agglutinative) entire-stack formatting and linting: TypeScript, JavaScript, Svelte, HTML, (Tailwind) CSS, Jest, JSON(C), and sadly YAML.",
5
5
  "keywords": [
6
6
  "eslint",
7
7
  "eslint-config",
@@ -19,7 +19,6 @@
19
19
  "jest",
20
20
  "json",
21
21
  "jsonc",
22
- "json5",
23
22
  "yaml"
24
23
  ],
25
24
  "license": "MIT",