• 见 常见选项 接口.

Error - 如果出现创建或更新文件的问题,则丢出错误.

• 见 常见选项 接口.

• Error - 如果 tsconfig.json 文件无法读取或更新,则丢出错误 .

• 见 添加类型参考选项 接口.

以代码退出进程 1 失败.

添加数据 postinstall 您的脚本 package.json 一旦您的软件包安装在外部工程中, 文件将会执行脚本 .

{
  // ...
  "files": [
    // ...,
    "my-scripts" // ensure folder is published to `npm`
  ],
  "scripts": {
    // ...
    "postinstall": "node my-scripts/ts-setup.ts"
  }
}

在你身边 ts-setup.ts 文件仅导入脚本并附带几个选项执行.

// my-scripts/ts-setup.ts
import { addTypesReference } from '@alessiofrittoli/node-scripts/postinstall'
import packageJson from '../package.json'

addTypesReference({
  name: packageJson.name,
  outputFile: `${packageJson.name}.d.ts`, // optional
})

或者你可以静地通过一个 outputFile 以添加您的全部范围包.

// my-scripts/ts-setup.ts
import { addTypesReference } from '@alessiofrittoli/node-scripts/postinstall'
import packageJson from '../package.json'

addTypesReference({
  name: packageJson.name,
  outputFile: 'my-package-scope-env.d.ts',
})

// my-scripts/ts-setup.ts
import { addTypesReference } from '@alessiofrittoli/node-scripts/postinstall'
import packageJson from '../package.json'

addTypesReference({
  name: packageJson.name,
  types: [`${packageJson.name}/globals`, `${packageJson.name}/globals-2`],
  outputFile: `${packageJson.name}.d.ts`, // optional
})

1. 获取软件包
   • 试图加载和解析 package.json 文档.
   • 如果文件不可用或无效,则以代码"1"退出进程.
   • 获取该版本, 如无则用作倒置 --version 选项已提供.
2. 解析选项 :
   • 使用 getProcessOptions()。 。 。 .
   • 验证关键参数,例如: version 财务报告和审定财务报表 access。 。 。 .
3. 准备 Git 并构建 :
   • 将任何未承诺的更改与藏名相提并论(pre-release) (中文(简体) ).
   • 执行 npm run build 或者说 pnpm build 命令( 如果 pnpm (全球安装).
   • 创建 Git 标记为 v{version}
   • 按下指定的 Git 标记 origin 或到默认的 Git 仓库远程 .
4. 发布到 npm( 可选) :
   • 使用 npm publish 若为 --npm 已设置了旗帜.
5. 恢复 Stash :
   • 恢复在此过程中保存的隐藏更改 .
6. 读取日志 :
   • 如果 --verbose 已设置了旗帜.

使用函数参数

添加数据 release 您的脚本 package.json 文件可以方便地从终端运行.

{
  // ...
  "scripts": {
    // ...
    "release": "node my-scripts/release.ts"
  }
}

在你身边 release.ts 文件仅导入脚本并执行.

QQ 记得将此文件添加到 .npmignore 所以不会在你包里发表.

// my-scripts/release.ts
import { release } from '@alessiofrittoli/node-scripts/release'

release({
  verbose: true,
  npm: true,
  access: 'restricted',
})

使用 CLI 选项

添加数据 release 您的脚本 package.json 文件可以方便地从终端运行.

{
  // ...
  "scripts": {
    // ...
    "release": "node my-scripts/release.ts --verbose --npm --access restricted"
  }
}

在你身边 release.ts 文件仅导入脚本并执行.

QQ 记得将此文件添加到 .npmignore 所以不会在你包里发表.

// my-scripts/release.ts
import { release } from '@alessiofrittoli/node-scripts/release'

release()