别名导入为什么会打破Typescript的错误报告?
创始人
2024-12-11 20:31:31
0

在使用 Typescript 的过程中,有时我们会使用别名导入模块,例如:

import { someFunction } from "@/utils";

上述代码中的 @ 是我们在 tsconfig.json 文件中设置的别名,其实际路径可能为项目根目录下的 src/utils

然而,当我们在 utils 文件中写代码时,如果出现了错误,Typescript 的错误报告可能不太准确:

export function someFunction() {
    const name: string = 123;   // 将数字赋值给字符串类型,会报错
    return name;
}

上述代码中将数字赋值给字符串类型,会导致编译错误,但是在使用别名导入时,Typescript 报告的错误信息会变成:

Type '123' is not assignable to type 'string'.

这可能会给我们带来困惑,因为我们不知道这个错误具体在哪个文件中发生了。

解决这个问题的方法是,在 tsconfig.json 文件中添加一个 paths 属性:

{
    "compilerOptions": {
        "baseUrl": "./",
        "paths": {
            "@/*": ["src/*"]
        }
    }
}

然后在项目根目录下创建 tsconfig-paths-bootstrap.js 文件,用于在运行时使用指定的别名路径:

const tsConfigPaths = require("tsconfig-paths");

const baseUrl = "./";
const { paths } = require("../tsconfig.json").compilerOptions;

tsConfigPaths.register({
    baseUrl,
    paths
});

最后,在启动项目时,在命令行中添加 --require ./tsconfig-paths-bootstrap.js 这一参数,即可使用别名路径并且得到准确的错误报告。例如:

ts-node --require ./tsconfig-paths-bootstrap.js index.ts

这样,在开发过程中,我们就可以放心地使用别名导入了。

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...