Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 1.62 KB

README.md

File metadata and controls

93 lines (62 loc) · 1.62 KB
Raw

DSComponent

A command line utility to assist in the creation of DS Boilerplate components. Create a new component in your projects components directory with Twig, Sass, and optional JS ready to go.

Usage

$ dscomponent <component-name> [options]

Install

# clone this repo
$ git clone git@github.com:digitalsurgeons/dscomponent.git

# install dependencies
$ cd dscomponent
$ npm i

# install module globally
$ npm i -g ./
   or
$ npm link

# run command from the root of any project
$ dscomponent component-name

API

A command line utility to assist in the creation of DS Boilerplate component
$ dscomponent <component-name> [options]

Options:
  -s, --skip        skip creating file. Options: css, js, twig
  -h, --help        print usage
  -v, --version     print version
  -q, --quiet       don't output any logs

generate component (twig, scss, and js files)

  $ dscomponent <component-name>

generate component (twig and scss files) skip js

  $ dscomponent <component-name> --skip=js // or -s js

generate component (scss and js files) skip twig

  $ dscomponent <component-name> --skip=twig // or -s twig

generate component (twig and js files) skip scss

either css or scss works as a skip option

  $ dscomponent <component-name> --skip=css // or -s css

get API info

  $ dscomponent --help

get version

  $ dscomponent --version

generate component silently

  $ dscomponent --quiet

License

MIT