eb-scripts

eb-scripts

A CLI and scripts used at Echobind

• eb-scripts
• Quickstart
• Usage
• Commands
• Contributing

Quickstart

To get started quickly, from the root of your project run:

npx eb-scripts init (react|react-typescript|react-native-typescript)

This will install eb-scripts as a devDependency and add a few helpful hygen scripts to your package.json.

Usage

$ npm install -g eb-scripts
$ eb-scripts COMMAND
running command...
$ eb-scripts (-v|--version|version)
eb-scripts/2.0.6 linux-x64 node-v13.1.0
$ eb-scripts --help [COMMAND]
USAGE
  $ eb-scripts COMMAND
...

Commands

• eb-scripts generate TEMPLATENAME
• eb-scripts help [COMMAND]
• eb-scripts init PROJECT

eb-scripts generate TEMPLATENAME

generates new files

USAGE
  $ eb-scripts generate TEMPLATENAME

ARGUMENTS
  TEMPLATENAME  (react-component|react-typescript-component|react-native-typescript-component|react-native-typescript-sc
                reen|react-native-e2e|util-typescript) the template you want to use

OPTIONS
  -h, --help       show CLI help
  -n, --name=name  [default: MyNewComponent] name to print
  -p, --path=path  path to where you want the files to go

EXAMPLE
  $ eb-scripts generate react-component -n MyNewComponent -p src/components
       Loaded templates: _templates
       added: src/MyNewComponent.js

See code: src/commands/generate.ts

eb-scripts help [COMMAND]

display help for eb-scripts

USAGE
  $ eb-scripts help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

eb-scripts init PROJECT

initializes project by installing eb-scripts and adding scripts to package.json

USAGE
  $ eb-scripts init PROJECT

ARGUMENTS
  PROJECT  (react|react-typescript|react-native-typescript) The language or framework of the project.
           Valid options: react,react-typescript,react-native-typescript

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ npx eb-scripts init react

See code: src/commands/init.ts

Contributing

If you're interested in contributing, please read our CONTRIBUTING guide.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

JavaScript Joe 💻 📖 💡 🚧

Jenn 👀 💻

Alvin Crespo 💻 📖 ⚠️ 👀

Chris Ball 🚇 🤔 👀

Jeffrey Zhen 👀

This project follows the all-contributors specification. Contributions of any kind welcome!