@bb-cli/base

模块

语气 数字 : object

基于 指挥官 加上一些添加和覆盖.

错误 数字 : object

创建命令错误对象的新实例, 确保从错误类中正确延伸.

日志 数字 : object

基于默认的共享日志系统 npmlog 数据 系统.

嘘 数字 : object

可移植( Windows/Linux/OS X) Unix shell 命令的执行 基于 贝壳js

欧 数字 : object

终端用户界面(Prompting / Styles / Spinners / 进步)

倾斜 数字 : object

一套公用事业.

职能

文件Exists( 文件) ⇒ boolean

cli: (中文(简体) ) object

基于 指挥官 加上一些添加和覆盖.

链接数字 : https://github.com/tj/commander.js/ 页面存档备份,存于互联网档案馆
示例
创建带有3个子命令的主命令 :

import { cli } from '@bb-cli/base';

cli.version('0.0.1')
  .command('install [...packages]', 'install one or more packages')
  .command('search [query]', 'search with optional query')
  .command('list', 'list packages installed', {isDefault: true})
  .parse(process.argv);

创建 install 子命令 :

import { cli } from '@bb-cli/base';

cli
  .description('Install package from registry')
  .arguments('[...packages]', 'install one or more packages')
  .option('-f, --force [force]', 'force installation ', false)
  .option('-r, --registry [registry]', 'registry host ')
  .alias('i')
  .man( path.resolve(__dirname, '../../man/install.md'))
  .parse(process.argv);

let packages = cli.args; // get the packages as variadic arguments
let force = cli.force  // get the force option

错误 : object

创建命令错误对象的新实例, 确保从错误类中正确延伸.

示例
设置日志头 :

import { error } from '@bb-cli/base';

const out = sh.exec('ls', { silent: true });
if (out.code !== 0) {
  throw error({
    type: 'Shell.Exec',
    code: out.code,
    message: out.stderr.trim(),
  });
}

日志 : object

基于默认的共享日志系统 npmlog 数据 系统.

链接数字 : https://github.com/npm/npmlog (英语)
示例
设置日志头 :

import { log } from '@bb-cli/base';
import { name as packageName } from './package.json';
log.heading = `[${packageName}]`;

基本命令 :

log.silly(prefix, message, ...)
log.verbose(prefix, message, ...)
log.info(prefix, message, ...)
log.http(prefix, message, ...)
log.warn(prefix, message, ...)
log.error(prefix, message, ...)

建立全球域 LOG LEVEL:

LOG_LEVEL=verbose bb-my-command

嘘: object

可移植( Windows/Linux/OS X) Unix shell 命令的执行 基于 贝壳js

链接数字 : https://github.com/shelljs/shelljs (英语)
示例
基本示例

import { sh } from '@bb-cli/base';
sh.ls(`./`)
// or
sh.exec(`ls ./`, function(exitCode, stdOut, stdErr) {
    log.verbose('cmd exitcode:', exitCode);
    log.verbose('cmd output:', stdOut);
    log.verbose('cmd stderr:', stdErr);
});

ui: object

终端用户界面(Prompting / Styles / Spinners / 进步)

• 欧 数字 : object
  • 即时 ⇒ Promise
  • 颜色 数字 : object
    • 默认主题 数字 : enum

{\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}我马上来 Promise

创建自控 询问者 模块通过 inquirer.createPromptModule 方法.

仁爱: 静态常数 ui
访问 : 公开
链接数字 : https://github.com/sboudrias/Inquirer.js (英语)

示例
基本实例:

import { ui } from '@bb-cli/base';
const questions = [{
  type: 'input',
  name: 'name',
  message: 'Who are you?',
  default: 'Guest',
  validate: value => true,
  filter: value => value,
}];

ui.prompt(questions).then( answers => {
    // do something with the answers here.
})

颜色 : object

基于颜色样式的控制台 颜色

仁爱: 静态常数 ui
访问 : 公开
链接数字 : https://github.com/Marak/colors.js (英语)
示例
基本实例:

import { ui } from '@bb-cli/base';
let logInfo = ui.colors.info('Some info style output');
log.verbose(`Show ${logInfo}`);

自定义标题样式 :

let logHead = ui.colors.heading('Some bold white heading');
log.info(logHead);

颜色。 默认主题 : enum

颜色默认样式

仁爱静态圆柱形 colors
属性

无效 : object

一套公用事业.

• 倾斜 数字 : object
  • .md2html (mdStr) (中文(简体) ) ⇒ string
  • md2 学期( mdStr) ⇒ string

utils.md2html (mdStr) string

将下标记转换为 html 输出

仁爱:静态方法 utils
回返数字 : string - html 字符串

示例
基本示例

const htmlStr = utils.md2html(fs.readFileSync('some-markdown-file.md', 'utf8').toString());

utils.md2term(mdStr) string

仁爱:静态方法 utils
待办

• 让它用颜色代替安西风格

示例
基本示例

const termMdOut = utils.md2term(fs.readFileSync('some-markdown-file.md', 'utf8').toString());

文件Exists( 文件) {} boolean

仁爱:全球职能