A utility to resolve alias paths.
If you are using TypeScript, we recommend using @mnrendra/tsconfig-alias-parser to automatically parse tsconfig.json into aliases.
npm i @mnrendra/alias-resolverUsing CommonJS:
const { resolveAlias } = require('@mnrendra/alias-resolver')
const aliases = [
{
'alias': '@',
'path': './src'
},
{
'alias': '@tests',
'path': './tests'
}
]
const source = {
path: '[absolute-path]/[project-directory]/src/main/index.js',
code: 'const foo = require("@/foo");const { mocks } = require("@tests")',
type: 'script'
}
resolveAlias(source, aliases)
console.log(source.code) // Output: const foo = require('../foo');const {mocks} = require('../../tests')Using ES Module:
import { resolveAlias } from '@mnrendra/alias-resolver'
const aliases = [
{
'alias': '@',
'path': './src'
},
{
'alias': '@tests',
'path': './tests'
}
]
const source = {
path: '[absolute-path]/[project-directory]/src/main/index.mjs',
code: 'import foo from "@/foo";import { mocks } from "@tests"',
type: 'module'
}
resolveAlias(source, aliases)
console.log(source.code) // Output: import foo from '../foo';import { mocks } from '../../tests'Using TypeScript and implement @mnrendra/tsconfig-alias-parser:
import type { Aliases, Source } from '@mnrendra/alias-resolver'
import { resolveAlias } from '@mnrendra/alias-resolver'
import { parseTSConfigAliasSync } from '@mnrendra/tsconfig-alias-parser'
const aliases: Aliases = parseTSConfigAliasSync() // It will read from `tsconfig.json` automatically.
const source: Source = {
path: '[absolute-path]/[project-directory]/src/main/index.mjs',
code: 'import foo from "@/foo";import { mocks } from "@tests"',
type: 'module'
}
resolveAlias(source, aliases)
console.log(source.code) // Output: import foo from '../foo';import { mocks } from '../../tests'import type {
// @mnrendra/types-aliases
Aliases,
Alias,
// @mnrendra/alias-resolver
Source,
SourceType,
ResolveImport,
ResolveRequire,
// acorn
Literal,
Program,
CallExpression,
VariableDeclaration,
ImportDeclaration,
// acorn-walk
SimpleVisitors
} from '@mnrendra/alias-resolver'