@teo-garcia/tsconfig-shared 0.2.0 → 0.2.1

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 (3) hide show
  1. package/LICENSE +24 -0
  2. package/README.md +24 -66
  3. package/package.json +13 -4
package/LICENSE ADDED
@@ -0,0 +1,24 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 teo-garcia
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
22
+
23
+
24
+
package/README.md CHANGED
@@ -8,78 +8,31 @@
8
8
  [![npm](https://img.shields.io/npm/v/@teo-garcia/tsconfig-shared?color=blue)](https://www.npmjs.com/package/@teo-garcia/tsconfig-shared)
9
9
  [![TypeScript](https://img.shields.io/badge/TypeScript-5-3178C6?logo=typescript&logoColor=white)](https://typescriptlang.org)
10
10
 
11
- Part of the [@teo-garcia/templates](https://github.com/teo-garcia/templates) ecosystem
11
+ Part of the [@teo-garcia/templates](https://github.com/teo-garcia/templates)
12
+ ecosystem
12
13
 
13
14
  </div>
14
15
 
15
16
  ---
16
17
 
17
- ## Features
18
+ ## Presets
18
19
 
19
- | Config | Target | Use Case |
20
- | ---------------- | ------ | -------------------------- |
21
- | **base** | ESNext | Common TypeScript settings |
22
- | **next** | ESNext | Next.js projects |
23
- | **react-router** | ESNext | React Router + Vite |
24
- | **nest** | ES2022 | NestJS server projects |
25
- | **vite-react** | ESNext | Vite + React SPA |
20
+ | Config | Target | Use Case |
21
+ | ---------------- | --------- | -------------------------- |
22
+ | **base** | Inherited | Common TypeScript settings |
23
+ | **next** | ES2017 | Next.js projects |
24
+ | **react-router** | ES2022 | React Router + Vite |
25
+ | **nest** | ES2023 | NestJS server projects |
26
+ | **vite-react** | ES2020 | Vite + React SPA |
27
+ | **expo** | ESNext | Expo / React Native |
28
+
29
+ ---
26
30
 
27
31
  ## Requirements
28
32
 
29
33
  - TypeScript 5+
30
34
 
31
- ## Quick Start
32
-
33
- ```bash
34
- # Install the package
35
- pnpm add -D @teo-garcia/tsconfig-shared
36
- ```
37
-
38
- ### Next.js
39
-
40
- ```json
41
- {
42
- "extends": "@teo-garcia/tsconfig-shared/next",
43
- "compilerOptions": {
44
- "paths": { "@/*": ["./app/*"] }
45
- }
46
- }
47
- ```
48
-
49
- ### React Router
50
-
51
- ```json
52
- {
53
- "extends": "@teo-garcia/tsconfig-shared/react-router",
54
- "compilerOptions": {
55
- "baseUrl": ".",
56
- "paths": { "@/*": ["./app/*"] }
57
- }
58
- }
59
- ```
60
-
61
- ### NestJS
62
-
63
- ```json
64
- {
65
- "extends": "@teo-garcia/tsconfig-shared/nest",
66
- "compilerOptions": {
67
- "paths": { "@/*": ["./src/*"] }
68
- }
69
- }
70
- ```
71
-
72
- ### Vite + React
73
-
74
- ```json
75
- {
76
- "extends": "@teo-garcia/tsconfig-shared/vite-react",
77
- "compilerOptions": {
78
- "baseUrl": ".",
79
- "paths": { "@/*": ["./src/*"] }
80
- }
81
- }
82
- ```
35
+ ---
83
36
 
84
37
  ## Exports
85
38
 
@@ -90,14 +43,19 @@ pnpm add -D @teo-garcia/tsconfig-shared
90
43
  | `@teo-garcia/tsconfig-shared/react-router` | React Router + Vite |
91
44
  | `@teo-garcia/tsconfig-shared/nest` | NestJS server |
92
45
  | `@teo-garcia/tsconfig-shared/vite-react` | Vite + React SPA |
46
+ | `@teo-garcia/tsconfig-shared/expo` | Expo / React Native |
47
+
48
+ ---
93
49
 
94
50
  ## Related Packages
95
51
 
96
- | Package | Description |
97
- | ------------------------------------------------------------------------------------------ | ------------------- |
98
- | [@teo-garcia/eslint-config-shared](https://github.com/teo-garcia/eslint-config-shared) | ESLint rules |
99
- | [@teo-garcia/prettier-config-shared](https://github.com/teo-garcia/prettier-config-shared) | Prettier formatting |
100
- | [@teo-garcia/vitest-config-shared](https://github.com/teo-garcia/vitest-config-shared) | Test configuration |
52
+ | Package | Description |
53
+ | ------------------------------------ | ------------------- |
54
+ | `@teo-garcia/eslint-config-shared` | ESLint rules |
55
+ | `@teo-garcia/prettier-config-shared` | Prettier formatting |
56
+ | `@teo-garcia/vitest-config-shared` | Test configuration |
57
+
58
+ ---
101
59
 
102
60
  ## License
103
61
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teo-garcia/tsconfig-shared",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "Shared TypeScript configurations for templates",
5
5
  "main": "tsconfig.base.json",
6
6
  "exports": {
@@ -32,17 +32,26 @@
32
32
  ],
33
33
  "author": "Teo Garcia",
34
34
  "license": "MIT",
35
- "packageManager": "pnpm@10.2.0",
35
+ "engines": {
36
+ "node": ">=24"
37
+ },
38
+ "packageManager": "pnpm@10.33.2",
39
+ "prettier": "@teo-garcia/prettier-config-shared",
36
40
  "repository": {
37
41
  "type": "git",
38
42
  "url": "git+https://github.com/teo-garcia/tsconfig-shared.git"
39
43
  },
40
44
  "scripts": {
41
- "check": "pnpm format:check",
45
+ "check": "pnpm format:check && pnpm smoke:consumer",
42
46
  "format": "prettier --write .",
43
- "format:check": "prettier --check ."
47
+ "format:check": "prettier --check .",
48
+ "prepare": "husky",
49
+ "smoke:consumer": "node scripts/consumer-smoke.mjs"
44
50
  },
45
51
  "devDependencies": {
52
+ "@teo-garcia/prettier-config-shared": "^0.2.9",
53
+ "husky": "^9.1.7",
54
+ "lint-staged": "^16.2.3",
46
55
  "prettier": "^3.8.1"
47
56
  }
48
57
  }