Installations

npm install common-bin-plus

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.14.2

NPM Version

6.14.16 Score

63.1

Supply Chain

91.8

Quality

80.9

Maintenance

100

Vulnerability

98.9

License

Pull Requests

Open

1

Total

6

Closed

0

Merged

5

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

1

JavaScript

JavaScript (100%)

Developer

node-modules

Download Statistics

Total Downloads

3,989

Last Day

13

Last Week

15

Last Month

35

Last Year

283

GitHub Statistics

4 Stars

11 Commits

1 Forks

13 Watchers

1 Branches

12 Contributors

Updated on Jul 12, 2023

Bundle Size

781.65 kB

Minified

295.10 kB

Minified + Gzipped

Bundlephobia

Maintainers

11

View All 12 Contributors

Package Meta Information

Latest Version

2.0.1

Package Id

common-bin-plus@2.0.1

Unpacked Size

11.80 kB

Size

4.28 kB

File Count

6

NPM Version

6.14.16

Node Version

16.14.2

Total Downloads

Cumulative downloads

Total Downloads

3,989

Last Day

0%

13

Compared to previous day

Last Week

650%

15

Compared to previous week

Last Month

25%

35

Compared to previous month

Last Year

-35.7%

283

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

5

common-bin consola enabled inquirer std-env

Dev Dependencies

9

assert-file autod coffee egg-bin egg-ci eslint eslint-config-egg mm typescript

common-bin-plus

advanced common-bin for cli usage

Installation

1npm i common-bin-plus --save

Write your own cli

see common-bin for more details.

Feature

Logger

https://github.com/unjs/consola

1this.logger.info('hello info level');
2this.logger.warn('hello warn level');
3this.logger.error(new Error('hello error level'));
4this.logger.debug('hello debug level');

debug log is disabled by default, you could enable it by:

command line argv: --verbose
process env: DEBUG=* or DEBUG=${cliName}
programmatically: logger.level = 'DEBUG'

Prompt

1const answers = await this.prompt([
2  {
3    type: 'input',
4    name: 'name',
5    message: 'What is your name:',
6  }, {
7    type: 'list',
8    name: 'type',
9    message: 'Choose a boilerplate:',
10    choices: [ 'empty', 'simple', 'plugin', 'framework' ],
11  },
12], {});
13
14this.logger.info(answers);

Unit Testing

Use coffee :

1const coffee = require('coffee');
2
3describe('test/index.test.js', () => {
4  it('should work', () => {
5    return coffee.fork('/path/to/cli')
6      // .debug()
7      .waitForPrompt()
8      .write('tz\n')
9      .writeKey('DOWN', 'ENTER')
10      .write('this is a desc\n')
11      .expect('stdout', /{ name: 'tz', type: 'simple' }/)
12      .expect('stdout', /{ description: 'this is a desc' }/)
13      .expect('code', 0)
14      .end();
15  });
16}):

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

3.3

/10

Last Scanned on 2025-05-05

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More