如何在Node/TypeScript中配置项目专属全局模块简化长导入路径？

这个需求完全可以实现，无需将文件放入node_modules目录，仅需配置TypeScript路径别名+对应运行/打包工具的别名映射即可，以下是具体操作步骤：

首先修改项目根目录下的tsconfig.json，新增baseUrl和paths字段：

{
  "compilerOptions": {
    // 基准路径，所有paths的相对路径都会基于该字段解析，这里设为项目根目录
    "baseUrl": "./",
    "paths": {
      // 直接映射单个文件，匹配你示例的需求
      "my-config-module": ["src/path/to/configFile"],
      // 也可以映射整个目录，*为通配符，比如@utils/xx 会自动匹配到src/utils/xx
      "@utils/*": ["src/utils/*"]
    }
  }
}

配置完成后，TypeScript在类型检查阶段就可以正确识别你自定义的短路径，不会报路径不存在的错误。

注意：TypeScript的paths仅做类型层面的路径识别，实际代码运行或打包时还需要对应工具配置同名别名，才能正确解析到文件路径。以下是常见场景的配置：

• Webpack项目：修改webpack.config.js的resolve.alias配置

const path = require('path');

module.exports = {
  resolve: {
    alias: {
      'my-config-module': path.resolve(__dirname, 'src/path/to/configFile'),
      '@utils': path.resolve(__dirname, 'src/utils')
    }
  }
}

• Vite项目：修改vite.config.ts的resolve.alias配置

import { defineConfig } from 'vite';
import path from 'path';

export default defineConfig({
  resolve: {
    alias: {
      'my-config-module': path.resolve(__dirname, 'src/path/to/configFile'),
      '@utils': path.resolve(__dirname, 'src/utils')
    }
  }
})

• 纯Node.js + ts-node运行场景：需要安装tsconfig-paths来加载tsconfig的paths配置
  1. 安装依赖：npm install -D tsconfig-paths
  2. 启动时添加注册参数：ts-node -r tsconfig-paths/register src/index.ts
     也可以直接在tsconfig.json中添加配置，避免每次启动加参数：

  {
    "ts-node": {
      "require": ["tsconfig-paths/register"]
    }
  }
  

• 自定义别名尽量不要和npm公共包重名，避免出现引入冲突
• 如果你的项目需要打包后发布为npm包，需要额外将别名替换为相对路径再发布，否则下游使用者无法解析你项目内的自定义别名
• 配置完成后如果IDE仍提示路径错误，重启IDE的TypeScript服务即可生效

内容的提问来源于stack exchange，提问作者user2921009