https://github.com/aadsm/npm-template-es2015-flow-jest
npm Template for a project using ES2015, Flow and Jest
https://github.com/aadsm/npm-template-es2015-flow-jest
Last synced: about 2 months ago
JSON representation
npm Template for a project using ES2015, Flow and Jest
- Host: GitHub
- URL: https://github.com/aadsm/npm-template-es2015-flow-jest
- Owner: aadsm
- Created: 2015-12-19T17:09:00.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-01-11T03:16:41.000Z (over 9 years ago)
- Last Synced: 2025-02-05T03:35:38.902Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 5.86 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# npm Template for a project using ES2015, Flow and Jest
## What does it do
The package.json and skeleton provided gives you a ready to use project configuration that allows you to:
* Use [ES2015](https://babeljs.io/docs/learn-es2015/) in your code
* Use [Flow](http://flowtype.org/) types
* Run [Jest](https://facebook.github.io/jest/) tests
* Use [ESLint](http://eslint.org/) rules
* Publish to npm
* Distribute to the browser
## How to use
```bash
curl -L https://github.com/aadsm/npm-template-es2015-flow-jest/tarball/master | tar zx
mv aadsm-npm-template-es2015-flow-jest* project-name && cd project-name
npm install
```
## Structure
* `src/` - es2015 source code.
* `src/index.js` - main entry point.
* `src/__tests__/` - tests.
* `bundle/` - compiled source code.
* `dist/` - browser bundles.
### Shipping
`npm run build` - compiles all your source code and puts it into `build/`.
### Testing
`npm test` - runs all jest tests located in `src/__tests__/`.
### Linting
`npm run lint` - lints the source code using rules defined in [`.eslintrc.json`](https://github.com/aadsm/npm-template-es2015-flow-jest/blob/master/.eslintrc.json). Check [ESLint user guide](http://eslint.org/docs/user-guide/configuring) to learn how to configure it.
### Developing
`npm run watch` - watches `src/` for changes and updates `dist/` as needed.
### Publishing to npm
When running `npm publish` only the `dist/` directory will be published. So before doing it, run `npm run dist`.
Flow types are preserved by shipping the original annotated source code with a `.flow.js` extension. Dependents of your library that use flow will automatically use these files for type checking. This is a feature provided by flow.
### Browser distribution
`npm run browser` - bundles your code using browserify and uglifyjs. It produces `dist/browser.js` (development version) and `dist/browser.min.js` (production version) that you can include in your webapp.
`npm run browser-watch` - watches `src/` for changes and updates `dist/browser.js` as needed.
Browserify is configured to use UMD and exports the main module into `window.projectName`. Change the `-s projectName` option in `package.json` to use a different name.