Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

@benmvp/cli Documentation

@benmvp/cli can be used in two ways. The primary way is as a CLI typically used within a package.json or with npx. Alternatively, you can interact with it via its Node API if it is to be used within a bigger CLI.

CLI docs

The CLI exposes the following commands:

  • benmvp create - Creates a new library set up with infrastructure using @benmvp/cli
  • benmvp test - Runs a one-time pass of typing, linting, unit tests & code coverage for the library
  • benmvp start - Runs the lib's tests in on-going watch mode during active development
  • benmvp build - Builds the library into the desired module formats at the specified location
  • benmvp integrate - Runs additional integration tests for the library

Node API docs

The Node API exposes the following functions:

  • create() - Creates a new library with the specified name set up with infrastructure using @benmvp/cli
  • test() - Runs a one-time pass of the specified modes of tests
  • start() - Runs the specified modes of tests in on-going watch mode during active development
  • build() - Builds the library into the desired module formats at the specified location
  • integrate() - Runs additional integration tests for the library
  • run() - Parses the specified array of CLI arguments to runs the desired command