Skip to content

Commit 56cdaea

Browse files
committed
Update README
1 parent eca973d commit 56cdaea

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ actual pre-publish actions. NPM module [in-publish](https://www.npmjs.com/packag
1616

1717
Please also take note of this [major NPM publish bug](https://github.com/npm/npm/issues/5082) that affects a wide range of Node / NPM versions. Basically, there is a chance that publishing may omit files. It has bitten TyphonJS NPM module publishing many times.
1818

19-
This NPM module runs all scripts defined in the `publish.prepublish.scripts` entry located in `.npmscriptrc` in the root path of a project.
19+
This NPM module runs all scripts defined in the `publish.prepublish.scripts` entry located in `.npmscriptrc` or `.npmscriptrc.js` in the root path of a project.
2020

2121
For a comprehensive ES6 build / testing / publishing NPM module please see [typhonjs-npm-build-test](https://www.npmjs.com/package/typhonjs-npm-build-test) as it combines this module along with transpiling ES6 sources with Babel, pre-publish script detection, ESDoc dependencies, testing with Mocha / Istanbul and an Istanbul instrumentation hook for JSPM / SystemJS tests. For a full listing of all TyphonJS NPM script modules available please see [typhonjs-node-npm-scripts](https://github.com/typhonjs-node-npm-scripts) organization on GitHub.
2222

@@ -26,14 +26,14 @@ To configure the prepublish script provide this entry in `package.json` scripts
2626

2727
```
2828
"devDependencies": {
29-
"typhonjs-npm-scripts-publish": "^0.3.0"
29+
"typhonjs-npm-scripts-publish": "^0.4.0"
3030
},
3131
"scripts": {
3232
"prepublish": "node ./node_modules/typhonjs-npm-scripts-publish/scripts/prepublish.js",
3333
},
3434
```
3535

36-
`.npmscriptrc` must be defined in the root path and contain a JSON formatted object hash `publish` with a `prepublish` hash
36+
`.npmscriptrc` or `.npmscriptrc.js` must be defined in the root path and contain a JSON formatted object hash `publish` with a `prepublish` hash
3737
with the following options:
3838
```
3939
(Array<string>) scripts - An array of executable actions / scripts.
@@ -49,4 +49,4 @@ Usually two tasks that are helpful when publishing ES6 NPM modules is ensuring a
4949
}
5050
```
5151

52-
Please note that you can add comments to `.npmscriptrc`. Also please see associated TyphonJS NPM scripts modules for how to define test and build scripts or review the documentation for [typhonjs-npm-build-test](https://www.npmjs.com/package/typhonjs-npm-build-test).
52+
Please note that you can add comments to `.npmscriptrc` and `.npmscriptrc.js` must be formatted as a CJS module. Also please see associated TyphonJS NPM scripts modules for how to define test and build scripts or review the documentation for [typhonjs-npm-build-test](https://www.npmjs.com/package/typhonjs-npm-build-test).

0 commit comments

Comments
 (0)