VSCode中CommonJS模块用path.join()时的IntelliSense失效问题

一、让VSCode IntelliSense识别path.join(__dirname, ...)引入的模块 #

1. 配置jsconfig.json路径映射 #

在项目根目录创建jsconfig.json文件，通过路径映射告知VSCode模块的实际存放位置：

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@modules/*": ["./src/modules/*"] // 替换为你的模块实际目录，可自定义别名
    }
  },
  "include": ["src/**/*"] // 包含所有需要智能提示的源码文件
}

配置后，VSCode会自动解析路径关联，为模块提供补全提示。

2. 补充类型定义与注释提示 #

• 安装Node.js类型定义，增强VSCode对Node API的识别能力：

  npm install @types/node --save-dev
  

• 对路径变量添加类型注释，帮助VSCode解析具体路径：

  const path = require('path');
  /** @type {string} */
  const moduleAPath = path.join(__dirname, "./modules/module_A.js");
  const moduleA = require(moduleAPath);
  

• 在文件顶部添加// @ts-check，开启VSCode类型检查模式，强制解析路径关联。

二、让After Effects CEP面板支持require()相对路径 #

CEP的Node.js运行环境与标准Node.js存在差异，__dirname指向可能不符合预期，可通过以下方法修复：

1. 手动重置NODE_PATH #

在面板初始化的入口文件中，添加代码指定模块根目录，让require能识别相对路径：

const path = require('path');
// 设置模块根目录，替换为你的实际路径
process.env.NODE_PATH = path.join(__dirname, './modules');
// 重新初始化模块搜索路径
require('module').Module._initPaths();

设置完成后，即可直接使用相对路径引入模块，比如require('./module_A.js')。

2. 封装自定义require函数 #

如果不想修改现有大量代码结构，可以封装全局自定义require函数，自动拼接正确路径：

const path = require('path');
// 全局挂载自定义require
global.cepRequire = (modulePath) => {
  return require(path.join(__dirname, modulePath));
};

后续使用const moduleA = cepRequire('./modules/module_A.js')，既能让AE正确识别路径，又能让VSCode提供智能提示。

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