Merge pull request #2 from hemengke1997/dts

chore: add usage docs and only emit declaration on build
thomas-void0 · Dec 22, 2023 · cce2894 · cce2894
2 parents fc8c3b8 + 025b48f
commit cce2894
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -2,13 +2,32 @@
 
 t2t-tools is type conversion tool of typescript.
 
-# install
+## Install
 
-```shell
+```bash
 npm install t2t-tools -D
 ```
 
-# example
+## Usage
+
+Add to a d.ts declaration file
+```ts
+/// <reference types="t2t-tools" />
+```
+
+OR
+
+add `t2t-tools` to `compilerOptions.types` inside tsconfig.json
+
+```json
+{
+  "compilerOptions": {
+    "types": ["t2t-tools"]
+  }
+}
+```
+
+## Example
 
 ```ts
 import { Merge } from 't2t-tools'
@@ -18,7 +37,7 @@ type A = Merge<{ a: number; c: boolean }, { a: string; b: number }>
 // A = { a: string; b: number; c: boolean }
 ```
 
-# api
+## API
 
 |        方法名         |                         解释                          |
 | :-------------------: | :---------------------------------------------------: |

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,8 +2,10 @@
   "name": "t2t-tools",
   "version": "0.1.1",
   "description": "type conversion tool of typescript",
-  "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "files": [
+    "./dist/*.d.ts"
+  ],
   "repository": "https://github.com/thomas-void0/t2t-tools",
   "homepage": "https://github.com/thomas-void0/t2t-tools",
   "scripts": {

diff --git a/tsconfig.json b/tsconfig.json
@@ -14,6 +14,7 @@
     "pretty": true,
     "removeComments": false,
     "sourceMap": false,
-    "stripInternal": true
+    "stripInternal": true,
+    "emitDeclarationOnly": true
   }
 }