@temboplus/tsconfig 0.2.0 → 0.3.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.
Files changed (7) hide show
  1. package/README.md +60 -12
  2. package/package.json +72 -69
  3. package/tsconfig.build.json +2 -2
  4. package/tsconfig.cjs.json +1 -1
  5. package/tsconfig.esm.json +1 -1
  6. package/tsconfig.nestjs.json +2 -2
  7. package/tsconfig.types.json +1 -1
package/README.md CHANGED
@@ -11,10 +11,10 @@ Base TypeScript configuration files for TemboPlus applications and packages
11
11
 
12
12
  ## Requirements
13
13
 
14
- - [NodeJS v22.15.0+](https://nodejs.org)
15
- - [npm v10.9.2+](https://www.npmjs.com/)
16
- - [typescript v5.8.3+](https://www.typescriptlang.org)
17
- - [tslib v2.8.1+](https://github.com/microsoft/tslib), [For optimized bundles](https://www.typescriptlang.org/tsconfig/#importHelpers)
14
+ - [NodeJS v24.13.0+](https://nodejs.org)
15
+ - [npm v11.6.2+](https://www.npmjs.com/)
16
+ - [typescript v5.9.3+](https://www.typescriptlang.org)
17
+ - [tslib v2.8.1+](https://github.com/microsoft/tslib), [for optimized bundles](https://www.typescriptlang.org/tsconfig/#importHelpers)
18
18
 
19
19
  ## Installation
20
20
 
@@ -35,7 +35,7 @@ Extend the desired config in your `tsconfig.json` or project-specific config fil
35
35
  "$schema": "https://json.schemastore.org/tsconfig",
36
36
  "extends": ["@temboplus/tsconfig/base.json"],
37
37
  // overrides + other configurations
38
- "exclude": ["**/dist", "**/node_modules"],
38
+ // see: https://www.typescriptlang.org/tsconfig/
39
39
  }
40
40
  ```
41
41
 
@@ -48,15 +48,17 @@ Extend the desired config in your `tsconfig.json` or project-specific config fil
48
48
  {
49
49
  "$schema": "https://json.schemastore.org/tsconfig",
50
50
  "extends": ["@temboplus/tsconfig/build.json"],
51
- // overrides + other configurations
52
51
  "include": ["src"],
53
52
  "exclude": [
54
53
  "**/dist",
55
54
  "**/node_modules",
56
55
  "**/test",
56
+ "**/*fixtures.ts",
57
57
  "**/*spec.ts",
58
58
  "**/*test.ts",
59
59
  ],
60
+ // overrides + other configurations
61
+ // see: https://www.typescriptlang.org/tsconfig/
60
62
  }
61
63
  ```
62
64
 
@@ -67,15 +69,17 @@ Extend the desired config in your `tsconfig.json` or project-specific config fil
67
69
  {
68
70
  "$schema": "https://json.schemastore.org/tsconfig",
69
71
  "extends": ["@temboplus/tsconfig/cjs.json"],
70
- // overrides + other configurations
71
72
  "include": ["src"],
72
73
  "exclude": [
73
74
  "**/dist",
74
75
  "**/node_modules",
75
76
  "**/test",
77
+ "**/*fixtures.ts",
76
78
  "**/*spec.ts",
77
79
  "**/*test.ts",
78
80
  ],
81
+ // overrides + other configurations
82
+ // see: https://www.typescriptlang.org/tsconfig/
79
83
  }
80
84
  ```
81
85
 
@@ -86,15 +90,17 @@ Extend the desired config in your `tsconfig.json` or project-specific config fil
86
90
  {
87
91
  "$schema": "https://json.schemastore.org/tsconfig",
88
92
  "extends": ["@temboplus/tsconfig/esm.json"],
89
- // overrides + other configurations
90
93
  "include": ["src"],
91
94
  "exclude": [
92
95
  "**/dist",
93
96
  "**/node_modules",
94
97
  "**/test",
98
+ "**/*fixtures.ts",
95
99
  "**/*spec.ts",
96
100
  "**/*test.ts",
97
101
  ],
102
+ // overrides + other configurations
103
+ // see: https://www.typescriptlang.org/tsconfig/
98
104
  }
99
105
  ```
100
106
 
@@ -105,15 +111,17 @@ Extend the desired config in your `tsconfig.json` or project-specific config fil
105
111
  {
106
112
  "$schema": "https://json.schemastore.org/tsconfig",
107
113
  "extends": ["@temboplus/tsconfig/types.json"],
108
- // overrides + other configurations
109
114
  "include": ["src"],
110
115
  "exclude": [
111
116
  "**/dist",
112
117
  "**/node_modules",
113
118
  "**/test",
119
+ "**/*fixtures.ts",
114
120
  "**/*spec.ts",
115
121
  "**/*test.ts",
116
122
  ],
123
+ // overrides + other configurations
124
+ // see: https://www.typescriptlang.org/tsconfig/
117
125
  }
118
126
  ```
119
127
 
@@ -127,6 +135,7 @@ Extend the desired config in your `tsconfig.json` or project-specific config fil
127
135
  "$schema": "https://json.schemastore.org/tsconfig",
128
136
  "extends": ["@temboplus/tsconfig/test.json"],
129
137
  // overrides + other configurations
138
+ // see: https://www.typescriptlang.org/tsconfig/
130
139
  }
131
140
  ```
132
141
 
@@ -138,6 +147,7 @@ Extend the desired config in your `tsconfig.json` or project-specific config fil
138
147
  "$schema": "https://json.schemastore.org/tsconfig",
139
148
  "extends": ["@temboplus/tsconfig/jest.json"],
140
149
  // overrides + other configurations
150
+ // see: https://www.typescriptlang.org/tsconfig/
141
151
  }
142
152
  ```
143
153
 
@@ -149,19 +159,57 @@ Extend the desired config in your `tsconfig.json` or project-specific config fil
149
159
  "$schema": "https://json.schemastore.org/tsconfig",
150
160
  "extends": ["@temboplus/tsconfig/vitest.json"],
151
161
  // overrides + other configurations
162
+ // see: https://www.typescriptlang.org/tsconfig/
152
163
  }
153
164
  ```
154
165
 
155
166
  ### [NestJS](https://nestjs.com) Configurations
156
167
 
157
- ### Base Build (CommonJS & nodenext)
168
+ #### Base Configuration (CommonJS & nodenext)
158
169
 
159
170
  ```jsonc
160
- // tsconfig.json or tsconfig.nestjs.json
171
+ // tsconfig.json
161
172
  {
162
173
  "$schema": "https://json.schemastore.org/tsconfig",
163
174
  "extends": ["@temboplus/tsconfig/nestjs.json"],
175
+ "include": ["src", "test"],
176
+ "exclude": [
177
+ "**/dist",
178
+ "**/docs",
179
+ "**/logs",
180
+ "**/node_modules",
181
+ "**/out",
182
+ "**/scripts",
183
+ "**/tmp",
184
+ ],
185
+ // overrides + other configurations
186
+ // see: https://www.typescriptlang.org/tsconfig/
187
+ }
188
+ ```
189
+
190
+ #### Build Configuration (CommonJS & nodenext)
191
+
192
+ ```jsonc
193
+ // tsconfig.build.json
194
+ {
195
+ "$schema": "https://json.schemastore.org/tsconfig",
196
+ "extends": ["./tsconfig.json"],
197
+ "exclude": [
198
+ "**/build",
199
+ "**/coverage",
200
+ "**/dist",
201
+ "**/docs",
202
+ "**/logs",
203
+ "**/node_modules",
204
+ "**/out",
205
+ "**/scripts",
206
+ "**/tmp",
207
+ "**/*fixtures.ts",
208
+ "**/*spec.ts",
209
+ "**/*test.ts",
210
+ ],
164
211
  // overrides + other configurations
212
+ // see: https://www.typescriptlang.org/tsconfig/
165
213
  }
166
214
  ```
167
215
 
@@ -190,7 +238,7 @@ We welcome contributions! Here's how to get started:
190
238
  4. **Create a Feature Branch**
191
239
 
192
240
  ```sh
193
- git checkout -b feature/<your-feature-name> main
241
+ git checkout -b feature/ < your-feature-name > main
194
242
  ```
195
243
 
196
244
  5. **Make Your Changes & Run Checks**
package/package.json CHANGED
@@ -1,18 +1,33 @@
1
1
  {
2
2
  "name": "@temboplus/tsconfig",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "Base TypeScript configuration files for TemboPlus applications and packages",
5
- "files": [
6
- "tsconfig.base.json",
7
- "tsconfig.build.json",
8
- "tsconfig.cjs.json",
9
- "tsconfig.esm.json",
10
- "tsconfig.jest.json",
11
- "tsconfig.nestjs.json",
12
- "tsconfig.test.json",
13
- "tsconfig.types.json",
14
- "tsconfig.vitest.json"
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/TemboPlus-Inc/temboplus-tsconfig.git"
8
+ },
9
+ "homepage": "https://github.com/TemboPlus-Inc/temboplus-tsconfig",
10
+ "bugs": {
11
+ "url": "https://github.com/TemboPlus-Inc/temboplus-tsconfig/issues",
12
+ "email": "engineering@temboplus.com"
13
+ },
14
+ "author": {
15
+ "name": "temboplus",
16
+ "email": "engineering@temboplus.com",
17
+ "url": "https://github.com/TemboPlus-Inc"
18
+ },
19
+ "contributors": [
20
+ {
21
+ "name": "lykmapipo",
22
+ "email": "lallyelias87@gmail.com",
23
+ "url": "https://github.com/lykmapipo"
24
+ }
15
25
  ],
26
+ "license": "MIT",
27
+ "engines": {
28
+ "node": ">=22.0.0",
29
+ "npm": ">=10.9.2"
30
+ },
16
31
  "exports": {
17
32
  "./base.json": "./tsconfig.base.json",
18
33
  "./build.json": "./tsconfig.build.json",
@@ -24,6 +39,26 @@
24
39
  "./types.json": "./tsconfig.types.json",
25
40
  "./vitest.json": "./tsconfig.vitest.json"
26
41
  },
42
+ "files": [
43
+ "tsconfig.base.json",
44
+ "tsconfig.build.json",
45
+ "tsconfig.cjs.json",
46
+ "tsconfig.esm.json",
47
+ "tsconfig.jest.json",
48
+ "tsconfig.nestjs.json",
49
+ "tsconfig.test.json",
50
+ "tsconfig.types.json",
51
+ "tsconfig.vitest.json"
52
+ ],
53
+ "keywords": [
54
+ "tembo",
55
+ "temboplus",
56
+ "typescript",
57
+ "tsc",
58
+ "tsconfig",
59
+ "ts",
60
+ "config"
61
+ ],
27
62
  "scripts": {
28
63
  "check": "npm-run-all format:check lint:check spell:check type:check",
29
64
  "clean": "npm-run-all clean:*",
@@ -40,11 +75,13 @@
40
75
  "format:check:js": "prettier --check \"./**/*.{js,mjs}\"",
41
76
  "format:check:json": "prettier --check \"./**/*.json\"",
42
77
  "format:check:md": "prettier --check \"./**/*.md\"",
78
+ "format:check:sh": "prettier --check \"./**/*.sh\"",
43
79
  "format:check:yaml": "prettier --check \"./**/*.{yaml,yml}\"",
44
80
  "format:fix": "npm-run-all format:fix:*",
45
81
  "format:fix:js": "prettier --write \"./**/*.{js,mjs}\"",
46
82
  "format:fix:json": "prettier --write \"./**/*.json\"",
47
83
  "format:fix:md": "prettier --write \"./**/*.md\"",
84
+ "format:fix:sh": "prettier --write \"./**/*.sh\"",
48
85
  "format:fix:yaml": "prettier --write \"./**/*.{yaml,yml}\"",
49
86
  "lint:check": "npm-run-all lint:check:*",
50
87
  "lint:check:js": "eslint \"./**/*.{js,mjs}\"",
@@ -57,14 +94,15 @@
57
94
  "lint:fix:md": "eslint --fix \"./**/*.md\"",
58
95
  "lint:fix:yaml": "eslint --fix \"./**/*.{yaml,yml}\"",
59
96
  "prepare": "husky",
97
+ "release": "release-it",
60
98
  "release:dry-run": "release-it --dry-run",
61
99
  "release:version": "release-it --release-version",
62
- "release": "release-it",
63
100
  "security:check": "npm audit --audit-level=high",
64
101
  "security:fix": "npm audit fix --audit-level=high",
65
102
  "spell:check": "npm-run-all spell:check:*",
66
103
  "spell:check:json": "cspell lint \"./**/*.json\"",
67
104
  "spell:check:md": "cspell lint \"./**/*.md\"",
105
+ "spell:check:sh": "cspell lint \"./**/*.sh\"",
68
106
  "test": "npm-run-all test:*",
69
107
  "test:jest": "jest",
70
108
  "test:vitest": "vitest run --coverage --exclude=**/jest.spec.ts --typecheck.enabled --typecheck.tsconfig=./tsconfig.vitest.json",
@@ -77,42 +115,16 @@
77
115
  "type:check:nestjs": "tsc -p tsconfig.nestjs.json --noEmit",
78
116
  "type:check:test": "tsc -p tsconfig.test.json --noEmit",
79
117
  "type:check:types": "tsc -p tsconfig.types.json --noEmit",
80
- "type:check:vitest": "tsc -p tsconfig.vitest.json --noEmit"
81
- },
82
- "repository": {
83
- "type": "git",
84
- "url": "https://github.com/TemboPlus-Inc/temboplus-tsconfig.git"
85
- },
86
- "keywords": [
87
- "tembo",
88
- "temboplus",
89
- "typescript",
90
- "tsc",
91
- "tsconfig",
92
- "ts",
93
- "config"
94
- ],
95
- "author": {
96
- "name": "temboplus",
97
- "email": "engineering@temboplus.com",
98
- "url": "https://github.com/TemboPlus-Inc"
99
- },
100
- "contributors": [
101
- {
102
- "name": "lykmapipo",
103
- "email": "lallyelias87@gmail.com",
104
- "url": "https://github.com/lykmapipo"
105
- }
106
- ],
107
- "license": "MIT",
108
- "bugs": {
109
- "url": "https://github.com/TemboPlus-Inc/temboplus-tsconfig/issues",
110
- "email": "engineering@temboplus.com"
111
- },
112
- "homepage": "https://github.com/TemboPlus-Inc/temboplus-tsconfig",
113
- "engines": {
114
- "node": ">=22.0.0",
115
- "npm": ">=10.9.2"
118
+ "type:check:vitest": "tsc -p tsconfig.vitest.json --noEmit",
119
+ "type:showconfig:base": "tsc -p tsconfig.base.json --showConfig",
120
+ "type:showconfig:build": "tsc -p tsconfig.build.json --showConfig",
121
+ "type:showconfig:cjs": "tsc -p tsconfig.cjs.json --showConfig",
122
+ "type:showconfig:esm": "tsc -p tsconfig.esm.json --showConfig",
123
+ "type:showconfig:jest": "tsc -p tsconfig.jest.json --showConfig",
124
+ "type:showconfig:nestjs": "tsc -p tsconfig.nestjs.json --showConfig",
125
+ "type:showconfig:test": "tsc -p tsconfig.test.json --showConfig",
126
+ "type:showconfig:types": "tsc -p tsconfig.types.json --showConfig",
127
+ "type:showconfig:vitest": "tsc -p tsconfig.vitest.json --showConfig"
116
128
  },
117
129
  "dependencies": {
118
130
  "@tsconfig/node22": ">=22.0.5",
@@ -121,36 +133,38 @@
121
133
  "tslib": ">=2.8.1"
122
134
  },
123
135
  "devDependencies": {
124
- "@commitlint/cli": "^20.3.1",
125
- "@commitlint/config-conventional": "^20.3.1",
136
+ "@commitlint/cli": "^20.4.0",
137
+ "@commitlint/config-conventional": "^20.4.0",
126
138
  "@eslint/markdown": "^7.5.1",
127
139
  "@jest/globals": "^30.2.0",
128
140
  "@release-it/conventional-changelog": "<=10.0.1",
129
- "@vitest/coverage-v8": "^4.0.17",
141
+ "@vitest/coverage-v8": "^4.0.18",
130
142
  "conventional-commits-parser": "^6.2.1",
131
- "cspell": "^9.6.0",
143
+ "cspell": "^9.6.2",
132
144
  "eslint": "^9.39.2",
133
145
  "eslint-config-flat-gitignore": "^2.1.0",
134
146
  "eslint-config-prettier": "^10.1.8",
135
147
  "eslint-plugin-import-x": "^4.16.1",
136
- "eslint-plugin-jsdoc": "^62.3.0",
148
+ "eslint-plugin-jsdoc": "^62.5.0",
137
149
  "eslint-plugin-jsonc": "^2.21.0",
138
- "eslint-plugin-perfectionist": "^5.3.1",
150
+ "eslint-plugin-perfectionist": "^5.4.0",
139
151
  "eslint-plugin-prettier": "^5.5.5",
140
152
  "eslint-plugin-unicorn": "^62.0.0",
141
153
  "eslint-plugin-yml": "^3.0.0",
142
154
  "husky": "^9.1.7",
143
155
  "jest": "^30.2.0",
144
- "npm-check-updates": "^19.3.1",
156
+ "npm-check-updates": "^19.3.2",
145
157
  "npm-run-all": "^4.1.5",
146
- "prettier": "^3.8.0",
158
+ "prettier": "^3.8.1",
159
+ "prettier-plugin-pkg": "^0.21.2",
160
+ "prettier-plugin-sh": "^0.18.0",
147
161
  "release-it": "<=19.0.0",
148
162
  "rimraf": "^6.1.2",
149
163
  "ts-jest": "^29.4.6",
150
164
  "ts-node": "^10.9.2",
151
165
  "typescript": "^5.9.3",
152
- "typescript-eslint": "^8.53.1",
153
- "vitest": "^4.0.17"
166
+ "typescript-eslint": "^8.54.0",
167
+ "vitest": "^4.0.18"
154
168
  },
155
169
  "publishConfig": {
156
170
  "access": "public"
@@ -160,17 +174,6 @@
160
174
  "@commitlint/config-conventional"
161
175
  ]
162
176
  },
163
- "cspell": {
164
- "version": "0.2",
165
- "language": "en",
166
- "words": [
167
- "tembo",
168
- "temboplus",
169
- "lykmapipo",
170
- "infile"
171
- ],
172
- "useGitignore": true
173
- },
174
177
  "jest": {
175
178
  "transform": {
176
179
  "^.+\\.tsx?$": [
package/tsconfig.build.json CHANGED
@@ -10,11 +10,11 @@
10
10
  "experimentalDecorators": true,
11
11
  "importHelpers": true,
12
12
  "noEmit": false,
13
- "outDir": "dist",
13
+ "outDir": "${configDir}/dist",
14
14
  "removeComments": false,
15
15
  "skipLibCheck": false,
16
16
  "sourceMap": true,
17
17
  "stripInternal": true
18
18
  },
19
- "include": ["src"]
19
+ "include": ["${configDir}/src"]
20
20
  }
package/tsconfig.cjs.json CHANGED
@@ -6,6 +6,6 @@
6
6
  "compilerOptions": {
7
7
  "module": "CommonJS",
8
8
  "moduleResolution": "node10",
9
- "outDir": "dist/cjs"
9
+ "outDir": "${configDir}/dist/cjs"
10
10
  }
11
11
  }
package/tsconfig.esm.json CHANGED
@@ -4,6 +4,6 @@
4
4
  "_version": "0.1.0",
5
5
  "extends": ["./tsconfig.build.json"],
6
6
  "compilerOptions": {
7
- "outDir": "dist/esm"
7
+ "outDir": "${configDir}/dist/esm"
8
8
  }
9
9
  }
package/tsconfig.nestjs.json CHANGED
@@ -4,12 +4,12 @@
4
4
  "_version": "0.1.0",
5
5
  "extends": ["./tsconfig.cjs.json"],
6
6
  "compilerOptions": {
7
- "baseUrl": "./",
7
+ "baseUrl": "${configDir}",
8
8
  "incremental": true,
9
9
  "lib": ["ES2023"],
10
10
  "module": "nodenext",
11
11
  "moduleResolution": "nodenext",
12
- "outDir": "dist",
12
+ "outDir": "${configDir}/dist",
13
13
  "removeComments": true,
14
14
  "target": "ES2023"
15
15
  }
package/tsconfig.types.json CHANGED
@@ -7,6 +7,6 @@
7
7
  "declaration": true,
8
8
  "declarationMap": true,
9
9
  "emitDeclarationOnly": true,
10
- "outDir": "dist/types"
10
+ "outDir": "${configDir}/dist/types"
11
11
  }
12
12
  }