@agogpixel/cavy v0.1.1

@agogpixel/cavy

Opinionated tool for NPM package development.

• @agogpixel/cavy
• Usage
• Commands

Usage

$ npm install -g @agogpixel/cavy
$ cavy COMMAND
running command...
$ cavy (-v|--version|version)
@agogpixel/cavy/0.1.1 linux-x64 node-v14.19.0
$ cavy --help [COMMAND]
USAGE
  $ cavy COMMAND
...

Commands

• cavy clean [...]
• cavy copy [...]
• cavy help [COMMAND]
• cavy lint [...]
• cavy pack [...]
• cavy publish [...]

cavy clean [...]

run clean commands

USAGE
  $ cavy clean [...]

ARGUMENTS
  ...  commands to execute (from cavy config file); executed in order provided on cli; mutually exclusive with --all

OPTIONS
  -a, --all            execute all commands in the order they are specified in cavy config file; required if no commands
                       provided

  -c, --config=config  [default: .cavy] path to cavy config file

  -f, --[no-]force     [default: true] execute clean commands using 'force'

  -h, --help           show CLI help

  -q, --quiet          suppress output

  -v, --verbose        verbose output

EXAMPLES
  $ cavy clean --all
  $ cavy clean --all --no-force
  $ cavy clean myCavyCleanCommandName --quiet

See code: lib/commands/clean.js

cavy copy [...]

copy package.json from src directory to dst directory, with redactions

USAGE
  $ cavy copy [...]

ARGUMENTS
  ...  commands to execute (from cavy config file); executed in order provided on cli; mutually exclusive with --all

OPTIONS
  -a, --all            execute all commands in the order they are specified in cavy config file; required if no commands
                       provided

  -c, --config=config  [default: .cavy] path to cavy config file

  -f, --force          execute copy commands even if src & dst directories are the same

  -h, --help           show CLI help

  -q, --quiet          suppress output

  -v, --verbose        verbose output

EXAMPLES
  $ cavy copy --all
  $ cavy copy --all --force
  $ cavy copy myCavyCopyCommandName --quiet

See code: lib/commands/copy.js

cavy help [COMMAND]

display help for cavy

USAGE
  $ cavy help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

cavy lint [...]

run lint commands

USAGE
  $ cavy lint [...]

ARGUMENTS
  ...  commands to execute (from cavy config file); executed in order provided on cli; mutually exclusive with --all

OPTIONS
  -a, --all            execute all commands in the order they are specified in cavy config file; required if no commands
                       provided

  -c, --config=config  [default: .cavy] path to cavy config file

  -h, --help           show CLI help

  -q, --quiet          suppress output

  -v, --verbose        verbose output

  -x, --fix            execute lint commands using 'fix' definitions

EXAMPLES
  $ cavy lint --all
  $ cavy lint --all --fix
  $ cavy lint myCavyLintCommandName --quiet

See code: lib/commands/lint.js

cavy pack [...]

create package tarball

USAGE
  $ cavy pack [...]

ARGUMENTS
  ...  commands to execute (from cavy config file); executed in order provided on cli; mutually exclusive with --all

OPTIONS
  -a, --all            execute all commands in the order they are specified in cavy config file; required if no commands
                       provided

  -c, --config=config  [default: .cavy] path to cavy config file

  -h, --help           show CLI help

  -q, --quiet          suppress output

  -r, --release        do not append devPostfix value to version property in package.json

  -v, --verbose        verbose output

EXAMPLES
  $ cavy pack --all
  $ cavy pack myCavyPackCommandName --quiet

See code: lib/commands/pack.js

cavy publish [...]

publish package tarball

USAGE
  $ cavy publish [...]

ARGUMENTS
  ...  commands to execute (from cavy config file); executed in order provided on cli; mutually exclusive with --all

OPTIONS
  -a, --all            execute all commands in the order they are specified in cavy config file; required if no commands
                       provided

  -c, --config=config  [default: .cavy] path to cavy config file

  -h, --help           show CLI help

  -q, --quiet          suppress output

  -v, --verbose        verbose output

EXAMPLES
  $ cavy publish --all
  $ cavy pack myCavyPublishCommandName --quiet

See code: lib/commands/publish.js