module-alias
Advanced tools
Package description
The module-alias package is used to create aliases of directory paths, allowing you to simplify the require/import statements in your Node.js projects. This can be particularly useful for projects with deep directory structures, making the code cleaner and easier to maintain.
Registering Aliases
This feature allows you to register aliases for directories so that you can require modules using the alias instead of relative paths.
require('module-alias/register');
moduleAlias.addAliases({
'@root' : __dirname,
'@models' : __dirname + '/models',
'@controllers': __dirname + '/controllers',
'@lib' : __dirname + '/lib'
});Customizing Aliases with package.json
You can also define aliases directly in your package.json file, which module-alias will read and use to resolve modules.
{
"_moduleAliases": {
"@root": ".",
"@models": "./models",
"@controllers": "./controllers",
"@lib": "./lib"
}
}Requiring Modules with Aliases
Once aliases are set up, you can require modules using the defined aliases, making the require statements much cleaner and easier to understand.
const User = require('@models/user');This package allows you to alias module paths in Node.js, similar to module-alias. It provides a way to keep your require calls clean. However, it is not as widely used or as well-maintained as module-alias.
This Babel plugin allows you to add new 'root' directories that contain your modules. It also lets you map a module to another module or filepath. It is more flexible than module-alias as it integrates with Babel and supports both Node.js and frontend JavaScript projects.
This package provides similar functionality to module-alias, allowing you to define aliases for your modules and directories. It differs in the way it sets up the aliases, using symbolic links, which can be more compatible with certain tools that do not understand module resolution.
Readme
Allows to register aliases of directories and custom module paths in NodeJS.
This package is highly inspired by app-module-path package and it's totally backwards compatible with it. The main difference is that this package also allows you to create aliases of directories for further usage with require/import
npm i --save module-alias
Add these lines to your package.json (in your application's root)
"_moduleDirectories": ["node_modules_custom"],
"_moduleAliases": {
"@root" : "", // Application's root
"@client" : "src/client",
"@admin" : "src/client/admin",
"@deep" : "src/some/very/deep/directory",
"@my_module" : "src/some-file.js",
"something" : "src/foo", // Or without @. Actually, it could be any string
}
And these line at the very main file of your app, before any code
import 'module-alias/register'
// And you're all set, now you can do stuff like
import 'something'
import foo from '@foo'
import deepModule from '@bar/my-module'
import module from 'some-module' // module from `node_modules_custom` directory
import moduleAlias from 'module-alias'
//
// Register alias
//
moduleAlias.addAlias('@server', __dirname + '/src/server')
// Or multiple aliases
moduleAlias.addAliases({
'@root' : __dirname,
'@server': __dirname + '/src/server',
...
})
//
// Register custom modules directory (like node_modules, but
// with your own modules)
//
moduleAlias.addPath(__dirname + '/node_modules_custom')
moduleAlias.addPath(__dirname + '/src')
//
// Import settings from package.json
//
moduleAlias(__dirname + '/package.json')
// Or let mudule-alias to figure where your package.json is
// located. By default it will look in the same directory
// where you have your node_modules (application's root)
moduleAlias()
// webpack.config.js
const npm_package = require('./package.json')
module.exports = {
entry: { ... },
resolve: {
root: __dirname,
alias: npm_package._moduleAliases || {},
extensions: ['', '.js', '.jsx'],
modulesDirectories: npm_package._moduleDirectories || [] // eg: ["node_modules", "node_modules_custom", "src"]
}
}
Require alias, node import alias, node custom module directory, node local require paths, register module directory in nodejs
FAQs
Create aliases of directories and register custom module paths
The npm package module-alias receives a total of 1,075,599 weekly downloads. As such, module-alias popularity was classified as popular.
We found that module-alias demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.