VSCode扩展临时更新配置值问题：suse-vale-styleguide路径失效求解

我正在开发一款名为suse-vale-styleguide的VSCode扩展，它是现有vale-vscode扩展的简易扩展。vale-vscode通过valeCLI.config配置项指定Vale的配置文件路径，我的扩展自带.vale.ini，需要临时修改这个配置项，这部分功能已实现且运行正常。

但问题在于，.vale.ini存放在带版本号的扩展目录中（例如~/.vscode-oss/extensions/opensuse.suse-vale-styleguide-0.2.3-universal/），这个目录会随扩展更新而变化。更新后，vale-vscode会去旧版本目录查找.vale.ini，导致报错。

另外，我的扩展的deactivate方法未生效，无法恢复原来的配置路径。当前代码如下：

// The module 'vscode' contains the VS Code extensibility API
// Import the module and reference it with the alias vscode in your code below
const vscode = require('vscode');
const fs = require('fs');
var oldValeIniPath = '';
// get config obj for vale plugin
var valeConfig = vscode.workspace.getConfiguration('vale');


// This method is called when your extension is activated
// Your extension is activated the very first time the command is executed

/**
 * @param {vscode.ExtensionContext} context
 */
function activate(context) {
    // get the current .vale.ini path
    let oldValeIniPath = valeConfig.get('valeCLI.config');
    //vscode.window.showInformationMessage(currentValeIniPath);
    // Use the console to output diagnostic information (console.log) and errors (console.error)
    // This line of code will only be executed once when your extension is activated
    console.log('Old .vale.ini path: ' + oldValeIniPath);
    // check if the current path exists (may not after extension upgrade) and
    // save it if yes
    if (fs.existsSync(oldValeIniPath)) {
        console.log('The path is valid');
    } else {
        console.error('The path is invalid');
        oldValeIniPath = '';
    }
    // construct the .vale.ini path for this extension and set it
    let curValeConfigPath = context.extensionPath + '/.vale.ini';
    valeConfig.update('valeCLI.config', curValeConfigPath);
}

// This method is called when your extension is deactivated
function deactivate() {
    valeConfig.update('valeCLI.config', oldValeIniPath)
}

module.exports = {
    activate,
    deactivate
}

解决方案 #

1. 修复deactivate方法失效问题 #

代码中存在变量作用域错误：activate内用let重新声明了oldValeIniPath，覆盖了全局变量，导致deactivate时拿到的是空字符串。同时需明确配置更新的作用域，避免影响工作区配置。修改后的代码：

const vscode = require('vscode');
const fs = require('fs');
let oldValeIniPath = '';
const valeConfig = vscode.workspace.getConfiguration('vale');

function activate(context) {
    // 读取原有配置并赋值给全局变量
    oldValeIniPath = valeConfig.get('valeCLI.config', '');
    console.log('Old .vale.ini path: ' + oldValeIniPath);

    // 检查路径有效性，无效则清空
    if (oldValeIniPath && !fs.existsSync(oldValeIniPath)) {
        console.error('The path is invalid');
        oldValeIniPath = '';
    }

    // 使用官方推荐的URI方式拼接路径
    const curValeConfigPath = vscode.Uri.joinPath(context.extensionUri, '.vale.ini').fsPath;
    // 指定全局配置作用域，和原有配置保持一致
    valeConfig.update('valeCLI.config', curValeConfigPath, vscode.ConfigurationTarget.Global);
}

function deactivate() {
    // 恢复原有配置，同样指定作用域
    valeConfig.update('valeCLI.config', oldValeIniPath, vscode.ConfigurationTarget.Global);
}

module.exports = { activate, deactivate };

2. 彻底避免版本号目录依赖的方案 #

不要依赖带版本号的扩展目录，改用全局存储目录存放.vale.ini，该目录不会随扩展更新变化：

function activate(context) {
    oldValeIniPath = valeConfig.get('valeCLI.config', '');
    if (oldValeIniPath && !fs.existsSync(oldValeIniPath)) {
        oldValeIniPath = '';
    }

    // 获取扩展全局存储目录的配置文件路径
    const globalValeIniPath = vscode.Uri.joinPath(context.globalStorageUri, '.vale.ini').fsPath;
    // 若全局存储中无配置文件，从扩展目录复制过去
    if (!fs.existsSync(globalValeIniPath)) {
        const sourcePath = vscode.Uri.joinPath(context.extensionUri, '.vale.ini').fsPath;
        fs.copyFileSync(sourcePath, globalValeIniPath);
    }

    // 设置全局存储路径到vale配置
    valeConfig.update('valeCLI.config', globalValeIniPath, vscode.ConfigurationTarget.Global);
}

这种方式的核心是利用context.globalStorageUri获取稳定的存储路径，彻底解决版本更新导致的路径失效问题。

3. 额外优化建议 #

• 监听valeCLI.config配置变化：若用户手动修改配置，扩展应停止自动覆盖，避免冲突
• 添加用户提示：在激活/停用扩展时，通过vscode.window.showInformationMessage告知用户配置已临时修改/恢复

内容的提问来源于stack exchange，提问作者Tomáš Bažant