Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mzabriskie/rackt-cli
Command line interface for automating common tasks when building React.js components
https://github.com/mzabriskie/rackt-cli
Last synced: about 1 month ago
JSON representation
Command line interface for automating common tasks when building React.js components
- Host: GitHub
- URL: https://github.com/mzabriskie/rackt-cli
- Owner: mzabriskie
- Created: 2014-12-02T20:53:55.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-10-21T23:18:11.000Z (about 8 years ago)
- Last Synced: 2024-09-26T08:54:47.677Z (3 months ago)
- Language: Shell
- Homepage:
- Size: 61.5 KB
- Stars: 336
- Watchers: 14
- Forks: 21
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome - rackt-cli - Command line interface for automating common tasks when building React.js components (Shell)
- awesome-starred - mzabriskie/rackt-cli - Command line interface for automating common tasks when building React.js components (others)
README
# rackt-cli
Command line interface for automating common tasks when building React.js components.
## Installing
```bash
$ npm install -g rackt-cli
```
## About
The motivation for this CLI is to make it simple to get started when creating a new component, and eliminate the boilerplate that is commonly copy/pasted from one project to another. This CLI provides all config, dev dependencies, and scripts for building, testing, and releasing. There is even a command for generating a new component structure. By leveraging `rackt-cli`, you are able to focus on writing code.
## Usage
| Command | Purpose |
| ------------------- | --------------------------------------------------------------------- |
| `rackt` | Prints out a list of available commands. |
| `rackt init ` | Creates a folder called `` and generates a component structure. |
| `rackt build` | Builds the component to `dist/` for UMD, and `build/` for CommonJS. |
| `rackt server` | Starts the dev server using port `8080`. |
| `rackt release` | Publish a new release to npm. Use `--preview` to preview release. |
| `rackt test` | Runs the test suite. Use `--single-run` for single run. |
| `rackt pages` | Deploys the examples to gh-pages. |
#### `init`
The `init` command generates a component structure based on the opinions of this CLI.
It provides a basic working component, along with a simple example, and a failing test.
#### `build`
The `build` command uses [webpack](http://webpack.github.io/), along with [babel](https://babeljs.io/) to transpile your code.
This means you are free to use JSX, and ES6 in your source, as it will be transpiled before shipping.
This command will generate two new folders within your component's folder.
A `dist/` folder contains a UMD version of your project, which is ideal for releasing to bower.
A `build/` folder will contain a transpiled version of your original source, un-bundled, for releasing to npm.
#### `server`
The `server` command uses [webpack-dev-server](http://webpack.github.io/docs/webpack-dev-server.html) to serve your examples in the browser.
You may also run `npm start` as an alias to this command.
#### `release`
The `release` command runs `test`, and `build` command, then updates your CHANGELOG, creates a new tag, and releases to npm.
#### `test`
The `test` command runs [karma](http://karma-runner.github.io/), using [mocha](http://mochajs.org/).
It will look for files under `lib/` suffixed with `-test.js`.
You can put these files alongside your source, or under sub-folders like `__tests__/`.
#### `pages`
The `pages` command will deploy your examples to a `gh-pages` branch.
## License
MIT