深入解析antfu/eslint-config中VSCode提交时unused-imports规则失效问题

问题背景

在使用antfu的eslint-config配置时，开发者发现当通过VSCode的图形界面进行代码提交时，unused-imports/no-unused-imports这条ESLint规则不会在pre-commit钩子中执行。这个问题源于VSCode在通过UI提交代码时会设置特定的环境变量，导致规则被意外跳过。

问题根源分析

该问题的核心在于isInEditorEnv函数的判断逻辑。这个函数原本设计用于检测代码是否在编辑器环境中运行，以避免在开发过程中频繁触发某些规则。然而，当通过VSCode UI提交代码时，VSCode会设置以下关键环境变量：

• VSCODE_PID：VSCode的进程ID
• VSCODE_GIT_COMMAND：表示正在执行git命令

当前的isInEditorEnv函数仅检测VSCODE_PID的存在，而没有考虑VSCODE_GIT_COMMAND的情况，导致在VSCode提交时代码错误地判断为"编辑器环境"而跳过了规则检查。

技术细节

在终端直接使用git commit命令时，VSCode设置的环境变量较少，主要是与git相关的变量：

VSCODE_GIT_ASKPASS_EXTRA_ARGS=
VSCODE_INJECTION=1
VSCODE_GIT_ASKPASS_MAIN=...
VSCODE_GIT_IPC_HANDLE=...
VSCODE_GIT_ASKPASS_NODE=...

而通过VSCode UI提交时，会额外设置大量环境变量，包括：

VSCODE_CRASH_REPORTER_PROCESS_TYPE=extensionHost
VSCODE_AMD_ENTRYPOINT=vs/workbench/api/node/extensionHostProcess
VSCODE_PID=56456
VSCODE_GIT_COMMAND=-c
...

解决方案

最合理的修复方案是修改isInEditorEnv函数的判断逻辑，使其能够区分真正的编辑器环境和通过编辑器执行的git命令。具体可以调整为：

function isInEditorEnv() {
  return (process.env.VSCODE_PID && !process.env.VSCODE_GIT_COMMAND) || 
         process.env.JETBRAINS_IDE || 
         process.env.VIM;
}

这样修改后：

1. 保留了在真正编辑代码时跳过规则的功能（用户体验友好）
2. 确保了在通过VSCode提交代码时规则能够正常执行
3. 不影响其他IDE（如JetBrains系列、VIM等）的行为

最佳实践建议

对于使用antfu/eslint-config的开发者，如果遇到类似问题，可以：

1. 检查项目依赖的eslint-config版本，确保使用最新版
2. 临时解决方案是在配置中显式设置isInEditor: false
3. 理解不同开发环境下环境变量的差异，有助于调试类似问题

这个问题很好地展示了开发工具链中环境变量管理的重要性，也提醒我们在设计开发工具时要考虑各种使用场景的差异性。