Alias npm submodules located in subdirectories
npm install grunt-alias-npm-submodules
> Alias npm submodules located in subdirectories
__grunt-alias-npm-submodules__ is a Grunt plugin. It creates alias script files in the root directory of your npm module that forward to submodules located in subdirectories to make them accessible using the npm module’s name:
``js
// Use this:
require('your-module/submodule');
// Instead of this:
require('your-module/subdirectory/submodule');
`
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
`shell`
npm install --save-dev grunt-alias-npm-submodules@latest
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:js`
grunt.loadNpmTasks('grunt-alias-npm-submodules');
command._
Task targets, files and options may be specified according to the grunt Configuring tasks guide.
#### Options
##### level
Type: Number or numeric String
Default:
The level(s) of how deep the target file is nested in subdirectories.
#### Usage Examples
This will create a alias file in the root directory:
`js
alias: {
options: {
levels: 2
},
partial: 'level_1/level_2/submodule.js'
},
`
Result:
sh
.
├── submodule.js # The alias file
└── level_1/
└── level_2/
└── submodule.js
`
When changing to 1, the result will be:
`sh
.
├── level_2 # The alias subdirectory
│ └── submodule.js # The alias file
└── level_1/
└── level_2/
└── submodule.js
``This is communist software. It is crafted with heart and soul to the best of the author’s knowledge and belief: _Not for profit but to satisfy the concrete needs._ Do whatever you want with it (as long as you keep the author’s copyright notice in all copies or substantial portions of it included) for free. Imagine how the world could be if others would produce and distribute their products for the same benefits and ask yourself why they’re actually not.
This software is licensed under MIT License.
Copyright © 2015 Christian Grete
- GitHub
- npm
- Twitter
- XING