1.0.1 • Published 2 years ago

@x-drive/alias v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

NodeJS 模块别名支持模块

NodeJs 应用中的模块引用,很容易会出现多层相对路径引用的情况,如:

import { local } from "../../../../../components/cache";

本模块使用了目前很多页端应用其实已广泛的别名机制来解决这个问题。

使用

  1. @x-drive/alias 加入到项目生产依赖
  2. 定义项目路径别名
    1. 默认是在根目录的 package.json 中的 aliases 字段
    2. 用户可通过配置指定符合标准的配置文件
  3. 在尽可能开始的地方启用模块

配置项

  • cwd 查找根目录,默认是 process.cwd()
  • modulesDir 额外的模块目录,默认是 node_modules
  • file 别名配置文件,默认是根目录下的 package.json

TypeScript 中使用

由于不同的项目 TypeScript 的应用方式有可能会不同,比如可能直接使用 node 启动 ts 项目或 ts 项目是需要编译后才启动的。因此 alias 不会尝试去使用 tsconfig 中的相关设置,也不会尝试去干预 ts 的相关设置。因此在 ts 中使用,需要用户自己根据项目的情况设置 tsconfig 稳健中 compilerOptions 中的 paths 字段