代工发布基地

代工厂发布命令的CLI 基础

这是为了尽可能轻松地创建代工厂-发布-规范集成。

入门

安装模块： npm install foundry-release-base

// Inside of `my-release-command.js`
// Define our command
var FoundryReleaseBase = require('foundry-release-base');
var pkg = require('./package.json');
var myReleaseCommand = new FoundryReleaseBase({
    // Define action to run on `my-release-plugin update-files`
    updateFiles: function (params) { // params = {version, message}
        // Update files for release
    },
    // Define action to run on `my-release-plugin commit`
    commit: function (params) { // params = {version, message}
        // Commit changes to files
    },
    // Define action to run on `my-release-plugin register`
    register: function (params) { // params = {version, message}
        // Register our package to its repository
    },
    // Define action to run on `my-release-plugin publish`
    publish: function (params) { // params = {version, message}
        // Publish our package to its repository
    }
});
myReleaseCommand.version(pkg.version);
 
// Parse CLI arguments
myReleaseCommand.parse(process.argv);

CLI 的用法：

# Invoke each of the respective functions from above 
node my-release-command.js update-files "1.0.0" "Release 1.0.0"
node my-release-command.js commit "1.0.0" "Release 1.0.0"
node my-release-command.js register "1.0.0" "Release 1.0.0"
node my-release-command.js publish "1.0.0" "Release 1.0.0"

文档

foundry-release-base公开FoundryReleaseBase通过其module.exports。

`FoundryReleaseBase(params)`

FoundryReleaseBase是一个构造函数，从继承Command自commander.js。

params Object– 方法和选项的容器
- updateFiles Function– 作为其发布的一部分更新包文件的可选函数
  - 例如，这可以更新package.json一个npm版本
  - 函数签名应该匹配 function (params, cb)
    - params Object– 发布信息的容器
      - version String– 当前版本的语义版本
      - message String– 提供有关发布信息的主题
    - cb Function–FoundryReleaseBase任务完成时
      通知错误优先回调
      - 函数签名会function (err)，其中err或者是一个Error或null
      - 在非错误回调时，我们将以 0 退出代码退出
      - 在错误回调时，我们将抛出Error导致非零退出代码的
- updateFilesDescription String– 用于update-files命令的可选描述--help
- commit Function– 可选功能，可在发布时保存对文件的更改
  - 例如，这可以git commit为git发布而运行
  - 函数签名将与 updateFiles
- commitDescription String– 用于commit命令的可选描述--help
- register Function– 将包注册到其存储库作为其发布的一部分的可选函数
  - 例如，这可以bower register为bower发布而运行
  - 函数签名将与 updateFiles
- registerDescription String– 用于register命令的可选描述--help
- 发布Function– 将包作为其发布的一部分发布到其存储库的可选函数
  - 例如，这可以npm publish为npm发布而运行
  - 函数签名将与 updateFiles
- publishDescription String– 用于publish命令的可选描述--help

`foundryReleaseBase.*`

FoundryReleaseBase继承Command自commander.js。因此，我们支持commander.js提供的所有方法。这包括.version()，.parse()。请参阅commander.js的文档了解更多信息。

// Add support for running `--version` on CLI
var pkg = require('./package.json');
myReleaseCommand.version(pkg.version);
 
// Interpret CLI argument
myReleaseCommand.parse(process.argv);