Typescript 路径别名在运行时未正确解析

Question

我是运行 VS Code，我目前正在尝试为我的打字稿项目设置一些别名。

我的开发设置依赖于 nodemon 和 ts-node，代码被编译到 dist 文件夹。

到目前为止，我已经成功让 Typescript Hero 使用别名来管理导入：

到目前为止，我的文件夹结构是：

.
└─┬ src
  ├──modules
  ├────Category
  ├────Ressource
  ├──shared
  ├────debug

// tsconfig.json
{
    "compilerOptions": {
        "module": "commonjs",
        "moduleResolution": "node",
        "pretty": true,
        "sourceMap": true,
        "target": "es6",
        "outDir": "./dist",
        "baseUrl": "./src",
        "paths": {
            "@shared/*": [
                "shared/*"
            ],
            "@modules/*": [
                "modules/*"
            ]
        },
        "resolveJsonModule": true,
        "esModuleInterop": true
    },
    "include": [
        "src/**/*.ts"
    ],
    "exclude": [
        "node_modules",
        "**/*.spec.ts",
        "**/*.test.ts",
    ]
}

这是第一个失败的别名导入。

//Server.ts file
import Print from '@shared/debug/Print.class';
import App from './App';

const MyApp: App = new App();

MyApp.ExpressApp.listen(MyApp.Config.ExpressPort, () => {
    Print.Log('Express server listening on port ' + MyApp.Config.ExpressPort);
});

但是，我收到一个错误："Cannot find module '@shared/debug/Print.class'" "cross-env NODE_ENV=development nodemon ts-node ./src/server.ts"。

这就是我的立场。

现在，我已经阅读了一些关于 SO 的问答，似乎即使我在开发中设法使别名有效，它也会在生产中失败，因为我来自 Typescript 运行 src 文件夹和我的可交付成果是在 dist 中构建的？如果是这样，有什么办法可以补救吗？非常感谢

Answer 1

问题出在运行时间的节点路径别名解析上。即使打字稿由 ts-node 在运行time 执行，节点也无法按原样解析别名。（我认为）

但这只是冰山一角。稍后我会在我的开玩笑设置中遇到它，在 JS 运行时间。

我必须找到一种方法，每一次运行我都有时间来解释我的别名。有一些 npm 包，但其中很多需要更多声明。

而且我不想在我拥有的每个配置文件中声明我的别名，并且只依赖于我的 tsconfig 文件。

经过多次测试，只有两个节点模块可以安装 tsconfig-paths 用于 ts-node 上的打字稿运行time 执行。 @ef-carbon/tspm 将我的别名转换为构建目标。

npm i -D tsconfig-paths @ef-carbon/tspm

对于ts-node，脚本修改为：

ts-node -r tsconfig-paths/register ./src/server.ts

你编译的js只需要运行 :

ef-tspm

开个玩笑，ts-jest 是必需的，我已经有了它，但它没有正确配置。我使用内置助手来设置我的路径。我的玩笑配置文件现在看起来像这样：

//jest.config.js
const { pathsToModuleNameMapper } = require('ts-jest/utils');
const { compilerOptions } = require('./tsconfig');
module.exports = {
    roots: ['<rootDir>/src'],
    globals: {
        'ts-jest': {
            tsConfig: 'tsconfig.json',
            diagnostics: {
                warnOnly: true,
            },
        },
    },
    clearMocks: true,
    coverageDirectory: 'coverage',
    testRegex: '(/__tests__/.*|(\.|/)(test|spec))\.tsx?$',
    moduleFileExtensions: ['js', 'json', 'jsx', 'node', 'ts', 'tsx'],
    testEnvironment: 'node',
    moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/src/' }),
    pathToJest: 'npm test',
    preset: 'ts-jest',
    testMatch: null,
};

这是我的脚本在 package.json

中的样子

  "scripts": {
    "dev:ts": "cross-env NODE_ENV=development nodemon",
    "dev:js": "cross-env NODE_ENV=development npm run start:js",
    "staging": "cross-env NODE_ENV=staging npm run start:js",
    "production": "cross-env NODE_ENV=production npm run start:js",

    "test": "cross-env NODE_ENV=testing jest --runInBand",
    "test:debug": "npm run test --detectOpenHandles",

    "start:js": "npm run build && nodemon --config nodemon-js.json",
    "build": "npm run compile && npm run post:compile && npm run copyAssets",
    "compile": "tsc",
    "post:compile": "ef-tspm",
    "copyAssets": "copyfiles -e ./src/**/*.ts -e ./src/**/*sample* -e ./src/**/*.json -u 1 ./src/**/* ./dist/"
  },

看看进展如何，我可能会在之后添加一个 grunt/gulp 解决方案。但就目前而言，这已经足够好了。

Answer 2

我想你可以使用名为 module-alias 的包来解决这个问题。

首先，用yarn、npm或pnpm安装，选择一个你用的。

然后，为您的 package.json 添加相同的别名，就像：

{
  "_moduleAliases": {
    "@shared": "./src/shared",
    "@modules": "./src/modules"
  }
}

最后，在您的第一行中导入module-alias/register（这很重要）！

import 'module-alias/register'
// ... your other code

这是module-alias的地址，你可以参考

希望我的回答能帮助到您解决问题

Typescript 路径别名在运行时未正确解析

Typescript path aliases not resolved correctly at runtime

node.js

typescript

visual-studio-code

tsconfig-paths