Skip to content

Commit

Permalink
doc: replace prepublish with prepare in package.json docs
Browse files Browse the repository at this point in the history
PR-URL: npm/npm#14290
Credit: @zkat
Reviewed-By: @othiym23
  • Loading branch information
zkat committed Oct 20, 2016
1 parent c12bbf8 commit c27412b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/files/package.json.md
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ from the root of a package, and can be managed like any other npm
configuration param. See `npm-config(7)` for more on the topic.

For build steps that are not platform-specific, such as compiling
CoffeeScript or other languages to JavaScript, use the `prepublish`
CoffeeScript or other languages to JavaScript, use the `prepare`
script to do this, and make the required package a devDependency.

For example:
Expand All @@ -529,12 +529,12 @@ For example:
"coffee-script": "~1.6.3"
},
"scripts": {
"prepublish": "coffee -o lib/ -c src/waza.coffee"
"prepare": "coffee -o lib/ -c src/waza.coffee"
},
"main": "lib/waza.js"
}

The `prepublish` script will be run before publishing, so that users
The `prepare` script will be run before publishing, so that users
can consume the functionality without requiring them to compile it
themselves. In dev mode (ie, locally running `npm install`), it'll
run this script as well, so that you can test it easily.
Expand Down

0 comments on commit c27412b

Please sign in to comment.