Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Rush/link-module-alias
Register aliases of directories and custom module paths in Node - no require hook
https://github.com/Rush/link-module-alias
Last synced: 4 months ago
JSON representation
Register aliases of directories and custom module paths in Node - no require hook
- Host: GitHub
- URL: https://github.com/Rush/link-module-alias
- Owner: Rush
- License: mit
- Created: 2018-05-14T23:37:14.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-17T21:42:42.000Z (over 1 year ago)
- Last Synced: 2024-10-29T18:03:45.547Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 64.5 KB
- Stars: 307
- Watchers: 5
- Forks: 14
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### If you use `@` in your linked module names, there is a risk this module will cause data loss
See this issue https://github.com/Rush/link-module-alias/issues/3
# link-module-alias
Setup private modules within your repo to get away from error-prone typing of long relative paths like these:
```js
require('../../../../some/very/deep/module')
```
Just create an alias and do it cleanly:
```js
var module = require('@deep/module')
// Or ES6
import module from '@deep/module'
```
You can setup aliases both to individual files and to directories.
**WARNING** Use this module only in final applications. It will not work inside published npm packages.
## Install
```
npm i --save-dev link-module-alias
```
## Usage
Add your custom configuration to your `package.json` (in your application's root), and setup automatic initialization in your scripts section.
Note: you can use `@` in front of your module but before of the possible data loss https://github.com/Rush/link-module-alias/issues/3
```js
"scripts": {
"postinstall": "link-module-alias"
},
// Aliases
"_moduleAliases": {
"~root" : ".", // Application's root
"~deep" : "src/some/very/deep/directory/or/file",
"@my_module" : "lib/some-file.js", // can be @ - but see above comment and understand the associated risk
"something" : "src/foo", // Or without ~. Actually, it could be any string
"module-with-typings": {
"main": "src/path/to/module.js",
"typings" "src/path/to/module/typings.d.ts" // you can specify typings for files (it works with aliases to files only)
}
}
```
If you encounter issues with installing modules, you may want to set up the preinstall script as well:
```js
"scripts": {
"postinstall": "link-module-alias",
"preinstall": "command -v link-module-alias && link-module-alias clean || true"
}
```
## How does it work?
- For aliases to directories, we create symlinks with `fs.symlink`
- For aliases to files, we create proxy modules with a package.json containing `"main"` that points to the target file
## Background
This module it's almost a drop in replacement for another package https://www.npmjs.com/package/module-alias - use module `module-alias` if you like runtime require hooks and use `link-module-alias` if you want good compatibility with your IDE and no runtime hacks.
The key differentiator of `link-module-alias` is creating all the module links statically in form of symlinks and proxy packages inside `node_modules`, there is no hacky require hook and you don't need to load any supporting packages.
The key motivator to create `link-module-alias` was to fix the issue with module aliases not resolving in VS Code. https://github.com/ilearnio/module-alias/issues/19
## License
MIT. Attribution to the `module-alias` for parts for the README and original idea.
# Contributors
[@kwburnett](https://github.com/kwburnett)