release-it/lib/cli.js

Interactive release tool for Git repositories. Increment version, commit, tag, push, build, publish to npm. Supports to build and release to a distribution/component repository.

const log = require('./log'),
  pkg = require('../package.json'),
  version = pkg.version;

const helpText = [
  `Release It! v${version}`,
  '',
  'Usage: release-it <increment> [options]',
  '',
  'Use e.g. "release-it minor" directly as shorthand for "release-it --increment=minor".',
  '',
  '-c --config            Path to local configuration options [default: ".release.json"]',
  '-d --dry-run           Do not touch or write anything, but show the commands and interactivity',
  '-e --debug             Output exceptions',
  '-f --force             Allow empty Git commit, force tag.',
  '-g --github.release    Release to GitHub',
  '-h --help              Print this help',
  '-i --increment         Increment "major", "minor", "patch", or "pre*" version; or specify version [default: "patch"]',
  '-m --message           Commit message [default: "Release %s"]',
  '-n --non-interactive   No interaction (assume default answers to questions)',
  '   --prereleaseId      Identifier for pre-releases (e.g. "beta" in "1.0.0-beta.1")',
  '-p --npm.publish       Auto-publish to npm (only relevant in --non-interactive mode)',
  '   --npm.tag           Registers published package with given tag (default: "latest")',
  '-v --version           Print version number',
  '-V --verbose           Verbose output'
].join('\n');

module.exports = {
  version: function() {
    log.log(`v${version}`);
  },
  help: function() {
    log.log(helpText);
  }
};