@yuu1111/tsconfig 1.0.6 → 1.0.7

package/README.ja.md

@@ -12,9 +12,48 @@ bun add -D @yuu1111/tsconfig
 
 ## Usage
 
-`tsconfig.json` でpresetの1つをextendsする
+`tsconfig.json` でpresetを1つextendsし、presetが持たないpathをProjectで足す
 
-### Base
+```json
+{
+  "extends": "@yuu1111/tsconfig/base.json",
+  "include": ["src/**/*.ts"]
+}
+```
+
+## Presets
+
+| Preset | Extends | 用途 |
+|--------|---------|------|
+| `base` | — | 他のpresetが継承する厳格なbase |
+| `bun` | `base` | Bunのglobal型を足す |
+| `library` | `base` | declarationとsource mapを出してJavaScriptをemitする |
+| `declaration-only` | `library` | declaration fileだけを出す |
+| `react` | `base` | DOM型とJSX transformを足す |
+
+### base
+
+他のpresetはすべて `base` をextendsする
+emitせずに型検査だけを行い、emitはpresetまたはbundlerへ任せる
+
+| Option | 値 |
+|--------|-----|
+| `target` | `ESNext` |
+| `lib` | `["ESNext"]` |
+| `module` | `Preserve` |
+| `moduleResolution` | `bundler` |
+| `moduleDetection` | `force` |
+| `strict` | `true` |
+| `noEmit` | `true` |
+| `isolatedModules` | `true` |
+| `verbatimModuleSyntax` | `true` |
+| `esModuleInterop` | `true` |
+| `resolveJsonModule` | `true` |
+| `skipLibCheck` | `true` |
+| `forceConsistentCasingInFileNames` | `true` |
+| `noUncheckedIndexedAccess` | `true` |
+| `noFallthroughCasesInSwitch` | `true` |
+| `exactOptionalPropertyTypes` | `true` |
 
 ```json
 {
@@ -22,9 +61,10 @@ bun add -D @yuu1111/tsconfig
 }
 ```
 
-### Bun
+### bun
 
-利用Projectで `@types/bun` をinstallしてからBun presetをextendsする
+`types: ["bun"]` を足す
+利用Projectで `@types/bun` をinstallする
 
 ```json
 {
@@ -32,7 +72,16 @@ bun add -D @yuu1111/tsconfig
 }
 ```
 
-### Library
+### library
+
+emitを有効にし、declaration、declaration map、source mapを出す
+
+| Option | 値 |
+|--------|-----|
+| `noEmit` | `false` |
+| `declaration` | `true` |
+| `declarationMap` | `true` |
+| `sourceMap` | `true` |
 
 ```json
 {
@@ -45,9 +94,9 @@ bun add -D @yuu1111/tsconfig
 }
 ```
 
-### Declaration-only library
+### declaration-only
 
-bundlerがJavaScriptを出し、TypeScriptはdeclaration fileだけを出す場合にこのpresetを使う
+`library` をextendsし、bundlerがJavaScriptを出すbuild向けに `emitDeclarationOnly` を設定する
 
 ```json
 {
@@ -60,7 +109,9 @@ bundlerがJavaScriptを出し、TypeScriptはdeclaration fileだけを出す場
 }
 ```
 
-### React
+### react
+
+`lib` へ `DOM` と `DOM.Iterable` を足し、`jsx: "react-jsx"` を設定する
 
 ```json
 {
@@ -70,13 +121,3 @@ bundlerがJavaScriptを出し、TypeScriptはdeclaration fileだけを出す場
   }
 }
 ```
-
-## Presets
-
-| Preset | Use case |
-|--------|----------|
-| `base.json` | 厳格な共有base |
-| `bun.json` | Bun project |
-| `declaration-only.json` | declarationだけを出すlibrary build |
-| `library.json` | declarationとsource mapを出すlibrary build |
-| `react.json` | React（JSX + DOM型） |

package/README.md

@@ -12,9 +12,48 @@ bun add -D @yuu1111/tsconfig
 
 ## Usage
 
-Extend one of the presets in your `tsconfig.json`:
+Extend one preset in `tsconfig.json` and add the paths it leaves to the project.
 
-### Base
+```json
+{
+  "extends": "@yuu1111/tsconfig/base.json",
+  "include": ["src/**/*.ts"]
+}
+```
+
+## Presets
+
+| Preset | Extends | Use case |
+|--------|---------|----------|
+| `base` | — | Strict baseline shared by the other presets |
+| `bun` | `base` | Adds the Bun global types |
+| `library` | `base` | Emits JavaScript with declarations and source maps |
+| `declaration-only` | `library` | Emits declaration files only |
+| `react` | `base` | Adds the DOM types and the JSX transform |
+
+### base
+
+Every other preset extends `base`.
+It checks types without emitting, and leaves the emit to the preset or the bundler.
+
+| Option | Value |
+|--------|-------|
+| `target` | `ESNext` |
+| `lib` | `["ESNext"]` |
+| `module` | `Preserve` |
+| `moduleResolution` | `bundler` |
+| `moduleDetection` | `force` |
+| `strict` | `true` |
+| `noEmit` | `true` |
+| `isolatedModules` | `true` |
+| `verbatimModuleSyntax` | `true` |
+| `esModuleInterop` | `true` |
+| `resolveJsonModule` | `true` |
+| `skipLibCheck` | `true` |
+| `forceConsistentCasingInFileNames` | `true` |
+| `noUncheckedIndexedAccess` | `true` |
+| `noFallthroughCasesInSwitch` | `true` |
+| `exactOptionalPropertyTypes` | `true` |
 
 ```json
 {
@@ -22,9 +61,9 @@ Extend one of the presets in your `tsconfig.json`:
 }
 ```
 
-### Bun
+### bun
 
-Install `@types/bun` in the consuming project, then extend the Bun preset:
+Adds `types: ["bun"]`. Install `@types/bun` in the project.
 
 ```json
 {
@@ -32,7 +71,16 @@ Install `@types/bun` in the consuming project, then extend the Bun preset:
 }
 ```
 
-### Library
+### library
+
+Turns emit on and writes declarations, declaration maps, and source maps.
+
+| Option | Value |
+|--------|-------|
+| `noEmit` | `false` |
+| `declaration` | `true` |
+| `declarationMap` | `true` |
+| `sourceMap` | `true` |
 
 ```json
 {
@@ -45,10 +93,9 @@ Install `@types/bun` in the consuming project, then extend the Bun preset:
 }
 ```
 
-### Declaration-only library
+### declaration-only
 
-Use this preset when a bundler emits JavaScript and TypeScript only needs to emit
-declaration files.
+Extends `library` and sets `emitDeclarationOnly`, for a build where a bundler emits the JavaScript.
 
 ```json
 {
@@ -61,7 +108,9 @@ declaration files.
 }
 ```
 
-### React
+### react
+
+Adds `DOM` and `DOM.Iterable` to `lib` and sets `jsx: "react-jsx"`.
 
 ```json
 {
@@ -71,13 +120,3 @@ declaration files.
   }
 }
 ```
-
-## Presets
-
-| Preset | Use case |
-|--------|----------|
-| `base.json` | Strict shared base |
-| `bun.json` | Bun projects |
-| `declaration-only.json` | Declaration-only library builds |
-| `library.json` | Library builds with declarations and source maps |
-| `react.json` | React (JSX + DOM types) |

package/package.json

@@ -1,11 +1,11 @@
 {
 	"name": "@yuu1111/tsconfig",
-	"version": "1.0.6",
+	"version": "1.0.7",
 	"description": "Shared TypeScript configurations",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/yuu1111/configs.git",
-		"directory": "packages/tsconfig"
+		"directory": "packages/config/tsconfig"
 	},
 	"tsconfig": "./base.json",
 	"files": [