Makes requiring files deep in your node module easy and safe from refactoring
MIT License
Generates additional files to make requiring files deep in your node module easy and safe from refactoring.
Save generate-export-aliases
as a dev dependency in your package.json
.
npm i -D generate-export-aliases
Add a prepublish hook and the exports you wish to alias to the config
section of your package.json
under exportAliases
.
For example, if you wanted to alias the myHelper.js
file in the following directory structure...
├── LICENSE
├── README.md
├── package.json
├── lib
│ ├── fileA.js
│ ├── fileB.js
│ ├── fileC.js
│ └── shared
│ ├── myHelper.js
│ └── otherHelper.js
package.json
{
"name": "my-fantastic-library",
"scripts": {
"prepublish": "generate-export-aliases"
},
"config": {
"exportAliases": {
"exposed-helper": "./lib/shared/myHelper.js"
}
}
}
const exposedHelper = require('my-fantastic-library/exposed-helper')
const exposedHelperOriginal = require('my-fantastic-library/lib/shared/myHelper.js')
exposedHelper === exposedHelperOriginal // true
lodash's build process