omni-door

A tool set for set up the standard JS project

Usage no npm install needed!

<script type="module">
  import omniDoor from 'https://cdn.skypack.dev/omni-door';
</script>

README

🐸 omni-door (The CLI Tool for set up standard JS prject)

NPM downloads npm version Build Status codecov install size license

install

Several options to get up and running:

  • Clone the repo: git clone git@github.com:BobbyLH/omni-door.git
  • Install with npm: npm install omni-door -g
  • Install with Yarn: yarn global add omni-door

omni --help

  Usage: index [options] [command]

  Options:

    -v, --version   output the version number
    -h, --help      output usage information

  Commands:

    init [options]          initialize your project
    new [options] [module]  omni new [module] [-f | -c]
    build                   build your project according to [omni.config.js]
    release [options]       publish your project according to [omni.config.js]
    test [options]          test your project by unit test frame
    lint [options]          check your project by lint-tools

omni init

Initial your project by answer several questions

omni init

Initial your project according to some template

omni init --t

or

omni init --entire

options

Usage: omni init [options]

initialize your project

Options:
  -s --simple      create a simple project
  -t --standard    create a standard project
  -e --entire      create a most versatile project
  -u --utils       create a utils library
  -c --components  create a component library
  -h, --help       output usage information

omni new

options

Usage: omni new [options] [module]

omni new [module] [-f | -c]

Options:
  -f, --fc    create a functional component
  -c, --cc    create a class component
  -h, --help  output usage information

omni build

Build your project according to [omni.config.js]

npm run build

or

omni build

omni release

options

Usage: omni release [options]

publish your project according to [omni.config.js]

Options:
  -i, --ignore            ignore automatic iteration version
  -m, --manual <version>  manual iteration version
  -h, --help              output usage information

License

Copyright (c) 2019-2019 Bobby.li

Released under the MIT License