使用Typescript和ES模块发布Node模块的方法

发布Node模块需要满足以下要求：

1. 代码必须是符合Node.js CommonJS规范的。

2. 需要编译工具把你的TypeScript代码编译成JavaScript。

3. 编译后的代码需要经过压缩和优化，最后才能发布到npm上。

4. 在代码中引用外部依赖需要使用ES模块而不能使用CommonJS。

在此，我们提供一份使用 TypeScript和ES模块发布Node模块的方式。

步骤1: 安装TypeScript转码工具

需要安装TypeScript编译器和@babel/preset-typescript预设来编译TypeScript代码：

npm install --save-dev typescript @babel/preset-typescript

步骤2: 配置TypeScript

在工程根目录下创建tsconfig.json文件，配置TypeScript编译器。

{
  "compilerOptions": {
    "target": "es6",
    "module": "esnext",
    "moduleResolution": "node",
    "declaration": true,
    "sourceMap": true,
    "outDir": "./dist",
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "resolveJsonModule": true,
    "noImplicitAny": true
  },
  "include": [
    "./src/**/*"
  ],
  "exclude": [
    "./node_modules",
    "./dist"
  ]
}

主要的参数说明：

• target: 转码成ES6规范
• module: 使用ES模块输出
• moduleResolution: 使用 Node 模块解析算法
• declaration: 生成声明文件 *.d.ts
• sourceMap: 生成文件对应的 sourceMap 文件
• outDir: 输出文件的目录
• esModuleInterop: 为 CommonJS 模块提供默认的 ES 模块方式
• forceConsistentCasingInFileNames: 允许使用相同大小写，但文件名必须准确
• resolveJsonModule: 允许导入 json 文件
• noImplicitAny: 禁止使用 any 类型

步骤3: 配置Babel

在工程的根目录下创建 .babelrc 文件，用于对ES模块进行转换，以便于在 Node.js v12 及以上版本中可以被正常使用。

{
  "presets": [
    [
      "@babel/preset-env",
      {
        "modules": false,
        "targets": {
          "node": "current"
        }
      }
    ],
    "@babel/preset-typescript"
  ]
}

步骤4: 配置npm脚本

在 package.json 中添加编译脚本。

{
  "scripts": {
    "build": "tsc",
    "prepublishOnly": "npm run build",
  }
}

步骤5: 使用ES模块

在项目中需要使用ES模块而不能使用CommonJS。可以通过以下方式引用：

// a.ts
export const foo = 'bar';

// b.ts
import { foo } from './a';

示例1 - 普通Node.js模块

假设我们已经编写了使用ES模块并经过TypeScript编译的calculator模块，它具有add、subtract和multiply方法。

使用该模块的用户可以通过以下NPM命令进行安装。

npm i @example/calculator

在该模块中的 package.json 必须保证以下两个属性设置正确。

{
  "type": "module",
  "main": "dist/index.js",
}

其中"type":"module"表示使用ES模块，"main":"dist/index.js"表示主入口文件，即在引用该模块时需要导入的文件。

示例2 - 提供命令行工具

假设我们已经编写的使用ES模块并经过TypeScript编译的cli工具，它在全局安装后可以通过命令行工具中的mycmd命令来执行。

我们需要在package.json中添加bin字段来指定命令行工具。

{
  "bin": {
    "mycmd": "dist/cli.js"
  }
}

需要保证命令行工具的入口文件cli.js中的shebang（Unix的脚本解释程序声明）和类型声明（解释程序执行的文件）的内容如下：

#!/usr/bin/env node

import { Command } from 'commander';

const program = new Command();

program
  .version('1.0.0')
  .description('This is my command-line tool')
  // add command or option here

program.parse(process.argv);

需要在package.json中添加cli依赖。

npm i commander

以上就是使用TypeScript和ES模块发布Node模块方法的完整攻略，期望对你有所帮助。