@tofrankie/tsconfig 0.0.4 → 0.0.5

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/CHANGELOG.md +4 -0
  2. package/README.md +7 -7
  3. package/package.json +10 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Changelog
2
2
 
3
+ ## tsconfig@0.0.5 (2026-04-04)
4
+
5
+ - Update documentation
6
+
3
7
  ## tsconfig@0.0.4 (2026-03-31)
4
8
 
5
9
  - Update `node.lib.tsdown.json` preset: disable `declarationMap`
package/README.md CHANGED
@@ -2,12 +2,12 @@
2
2
 
3
3
  ![npm version](https://img.shields.io/npm/v/@tofrankie/tsconfig) ![node version](https://img.shields.io/node/v/@tofrankie/tsconfig) ![npm package license](https://img.shields.io/npm/l/@tofrankie/tsconfig) ![npm last update](https://img.shields.io/npm/last-update/@tofrankie/tsconfig)
4
4
 
5
- Shared [tsconfig](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) configuration.
5
+ A shared [TypeScript](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) `tsconfig.json` presets.
6
6
 
7
7
  > [!IMPORTANT]
8
- > Presets are not yet stable and may change.
8
+ > Before 1.0.0, releases may include breaking changes. Read the [CHANGELOG](CHANGELOG.md) before upgrading.
9
9
 
10
- ## Usage
10
+ ## Quick Start
11
11
 
12
12
  ```bash
13
13
  $ pnpm add typescript @tofrankie/tsconfig -D
@@ -15,16 +15,16 @@ $ pnpm add typescript @tofrankie/tsconfig -D
15
15
 
16
16
  Create a `tsconfig.json` in your project root:
17
17
 
18
- ```json
18
+ ```jsonc
19
19
  {
20
- "extends": "@tofrankie/tsconfig/react.vite.json"
21
- // other options...
20
+ "extends": "@tofrankie/tsconfig/react.vite.json",
21
+ // add compilerOptions, include, etc. as needed
22
22
  }
23
23
  ```
24
24
 
25
25
  ## Presets
26
26
 
27
- Use `@tofrankie/tsconfig/<filename>` in `extends`. If the last column of the table is not `-`, also add those packages to this project's devDependencies.
27
+ Use `@tofrankie/tsconfig/<filename>` in `extends`. When **Extra dependencies** is not `-`, add those packages to your project's `devDependencies`.
28
28
 
29
29
  | Preset | Purpose (how to choose) | Extra dependencies |
30
30
  | ---------------------- | -------------------------------------------------------- | ----------------------- |
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@tofrankie/tsconfig",
3
3
  "type": "module",
4
- "version": "0.0.4",
5
- "description": "Shared tsconfig configuration",
4
+ "version": "0.0.5",
5
+ "description": "A shared tsconfig configuration",
6
6
  "author": "Frankie <1426203851@qq.com>",
7
7
  "license": "MIT",
8
8
  "homepage": "https://github.com/tofrankie/config/tree/main/packages/tsconfig",
@@ -14,6 +14,14 @@
14
14
  "bugs": "https://github.com/tofrankie/config/issues",
15
15
  "keywords": [
16
16
  "tsconfig",
17
+ "typescript",
18
+ "typescript-config",
19
+ "node",
20
+ "react",
21
+ "tsdown",
22
+ "vite",
23
+ "vitest",
24
+ "vue",
17
25
  "tofrankie"
18
26
  ],
19
27
  "files": [