如何触发TypeScript内联编译器警告？预处理器及自制工具建议

一、原生TypeScript是否支持//@ts-warn触发警告？ #

TypeScript原生没有类似//@ts-ignore的//@ts-warn语法，但可以通过ESLint自定义规则实现等效效果：

• 借助ESLint的no-warning-comments规则，配置自定义警告标记（比如@ts-warn）。
• 配置示例（.eslintrc.js）：

module.exports = {
  rules: {
    "no-warning-comments": [
      "warn",
      {
        terms: ["@ts-warn"],
        location: "start"
      }
    ]
  }
};

当代码中出现//@ts-warn('remove before publish')时，ESLint会在编译/lint阶段抛出警告，避免误提交调试代码。

也可以用JSDoc的@todo或@deprecated标签配合ESLint规则，但自定义@ts-warn更贴合需求场景。

二、类似C++#ifdef的条件编译实现 #

1. TypeScript原生条件编译 #

TypeScript支持通过编译常量配合打包工具实现静态条件编译：

• 在tsconfig.json中配置编译时常量：

{
  "compilerOptions": {
    "define": {
      "DEVELOPMENT": process.env.NODE_ENV === "development"
    }
  }
}

• 代码中直接使用常量判断：

if (DEVELOPMENT) {
  example(); // 开发环境保留，生产环境会被打包工具自动tree-shake移除
}

Webpack、Rollup等工具会根据常量值静态分析，自动剔除生产环境无用代码。

2. 预处理器工具 #

如果需要更接近#ifdef的注释式语法，可使用：

• babel-plugin-macros：自定义宏来实现条件编译，编写ifdef宏识别注释或特定语法块。
• ts-patch + 自定义Transformer：通过TypeScript Transform API修改AST，处理//@ifdef注释块，根据环境变量剥离代码。

三、自行开发工具的研究方向 #

1. 编译时警告工具 #

• TypeScript Compiler API：学习遍历AST抽象语法树，识别//@ts-warn类自定义注释，生成Compiler Diagnostic（警告信息）并集成到编译流程。
• ESLint自定义规则：基于ESLint规则API，编写规则检测特定注释并抛出警告，核心是掌握ESLint的AST遍历、注释获取方法。

2. 条件编译工具 #

• TypeScript Transform API：开发自定义Transformer，在编译的transform阶段处理AST，识别//@ifdef和//@endif包裹的代码块，根据环境变量决定是否保留代码。
• Babel插件开发：利用Babel解析器和遍历器，处理注释标记的代码块，修改AST实现代码剥离。
• 注意：文本正则替换方式虽简单但易误匹配，优先选择基于AST的处理方案，保证代码正确性。

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