@apitree.cz/ts-config 0.2.3 → 0.2.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 (4) hide show
  1. package/README.md +17 -4
  2. package/app.json +4 -1
  3. package/nextjs.json +0 -3
  4. package/package.json +4 -4
package/README.md CHANGED
@@ -20,6 +20,21 @@ pnpm add --save-dev @apitree.cz/ts-config typescript
20
20
 
21
21
  Add one of the following configurations to your `tsconfig.json`:
22
22
 
23
+ ### Base
24
+
25
+ Suitable for general TypeScript projects.
26
+
27
+ ```json
28
+ {
29
+ "extends": "@apitree.cz/ts-config",
30
+ "include": [".eslintrc.cjs", "**/*.js", "**/*.ts"],
31
+ "exclude": ["build", "node_modules"]
32
+ }
33
+ ```
34
+
35
+ > **Note:** This configuration can be also used in monorepo root, however, be sure to change `include` array to only
36
+ > check the root files and not nested workspaces as each should have its own `tsconfig.json`.
37
+
23
38
  ### Library
24
39
 
25
40
  Suitable for distributable `npm` packages (both Node.js and React).
@@ -48,18 +63,16 @@ Suitable for distributable `npm` packages (Node.js only).
48
63
 
49
64
  ### App
50
65
 
51
- Suitable for stand-alone applications (both Node.js and React).
66
+ Suitable for SPAs (React).
52
67
 
53
68
  ```json
54
69
  {
55
70
  "extends": "@apitree.cz/ts-config/app",
56
- "include": [".eslintrc.cjs", "**/*.js", "**/*.ts"],
71
+ "include": [".eslintrc.cjs", "**/*.js", "**/*.ts", "**/*.tsx"],
57
72
  "exclude": ["build", "node_modules"]
58
73
  }
59
74
  ```
60
75
 
61
- > **Note:** If you are using React, you should also add `"**/*.tsx"` to the `include` array.
62
-
63
76
  ### Next.js
64
77
 
65
78
  Suitable for Next.js apps.
package/app.json CHANGED
@@ -2,6 +2,9 @@
2
2
  "$schema": "https://json.schemastore.org/tsconfig",
3
3
  "extends": "./base.json",
4
4
  "compilerOptions": {
5
- "jsx": "preserve"
5
+ "checkJs": true,
6
+ "jsx": "preserve",
7
+ "module": "esnext",
8
+ "moduleResolution": "bundler"
6
9
  }
7
10
  }
package/nextjs.json CHANGED
@@ -2,9 +2,6 @@
2
2
  "$schema": "https://json.schemastore.org/tsconfig",
3
3
  "extends": "./app.json",
4
4
  "compilerOptions": {
5
- "checkJs": true,
6
- "module": "esnext",
7
- "moduleResolution": "bundler",
8
5
  "target": "es2017"
9
6
  }
10
7
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@apitree.cz/ts-config",
3
- "version": "0.2.3",
3
+ "version": "0.2.4",
4
4
  "description": "TypeScript configuration for ApiTree projects.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -29,13 +29,13 @@
29
29
  "nextjs.json"
30
30
  ],
31
31
  "devDependencies": {
32
- "typescript": "^5.5.4"
32
+ "typescript": "^5.7.3"
33
33
  },
34
34
  "peerDependencies": {
35
- "typescript": "^5.5.2"
35
+ "typescript": "^5.7.3"
36
36
  },
37
37
  "scripts": {
38
- "cleanup": "rimraf .eslintcache .turbo node_modules",
38
+ "cleanup": "del .eslintcache .turbo node_modules",
39
39
  "fix": "run-p format:fix lint:fix",
40
40
  "format": "prettier --check \"./**/*.{json,md}\"",
41
41
  "format:fix": "pnpm run format --write",