Skip to content

Commit 928989e

Browse files
docs(readme): Add a prepublish description.
1 parent 4082913 commit 928989e

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
* [Commit](#commit)
1717
* [Deploy](#deploy)
1818
* [Lint](#lint)
19+
* [Prepublish](#prepublish)
1920
* [Test](#test)
2021
* [Lint Messages](#lint-messages)
2122

@@ -157,6 +158,14 @@ $ mastarm lint "src/util/**/*.js" "test/**/*.js"
157158

158159
Note: by default standard will look for all files matching the patterns: `"**/*.js"`, `"**/*.jsx"`. Always quote the globs. Needed when used as an `npm` command.
159160

161+
### `prepublish`
162+
163+
Transpile a library using [Babel](http://babeljs.io/) and our custom config. Usually used as a prepublish step for libraries written in ES6+ that will be published to NPM. Pass it a directory and it will look for `.js` files to transpile.
164+
165+
```shell
166+
$ mastarm prepublish lib:build
167+
```
168+
160169
### `test`
161170

162171
Run the [Jest](http://facebook.github.io/jest/) test runner on your project. By default, mastarm will run Jest and generate coverage reports on all .js files in the `lib` folder of your project. The `patterns` argument will make Jest run only tests whose filename match the provided pattern.

0 commit comments

Comments
 (0)