feat: 新增类型文件

.github/workflows/npm-publish.yml

@@ -14,21 +14,27 @@ jobs:
         with:
           submodules: recursive
 
-      - name: Setup Node.js
+      - name: 设置 Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: 16
+          node-version: 20
           registry-url: "https://registry.npmjs.org/"
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
 
-      - name: Install protobufjs globally
+      - name: 全局安装 typescript
+        run: npm install -g typescript
+
+      - name: 编译index.ts
+        run: tsc
+
+      - name: 全局安装 protobufjs-cli
         run: npm install -g protobufjs-cli
 
-      - name: Build
+      - name: 编译 proto
         run: npm run build
 
-      - name: Publish to NPM
+      - name: 推送到 npm
         run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -2,3 +2,5 @@ node_modules/
 package-lock.json
 protos/compiled.d.ts
 protos/compiled.js
+pnpm-lock.yaml
+index.d.ts

index.js → index.ts

@@ -3,6 +3,9 @@ import { fileURLToPath } from 'url'
 import protobufjs from 'protobufjs'
 
 const filePath = fileURLToPath(import.meta.url)
+/**
+ * - proto 文件路径
+ */
 const proto = path.dirname(filePath) + '/kritor/protos'
 
 export { protobufjs, proto }

package.json

@@ -4,13 +4,23 @@
   "type": "module",
   "main": "index.js",
   "author": "CalmLexi",
+  "description": "Kritor Proto for Node.js",
+  "homepage": "https://github.com/KarinJS/node-kritor",
+  "bugs": {
+    "url": "https://github.com/KarinJS/node-kritor/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KarinJS/node-kritor.git"
+  },
   "dependencies": {
     "protobufjs": "^7.3.0"
   },
   "files": [
     "protos/",
     "kritor/",
     "index.js",
+    "index.d.ts",
     ".gitmodules",
     "package.json"
   ],

tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "nodenext",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": ".",
+    "typeRoots": ["./node_modules/@types"],
+    "types": ["node"]
+  },
+  "include": ["index.ts"],
+  "exclude": ["node_modules", "dist"]
+}