如何在VSCode中自动修复ESLint sort-keys规则问题？

阿华AIGC实验室

2026-5-13

解决方案：实现JSON/JS对象键的自动排序

绝对可行！我之前处理过类似的遗留代码库场景，既然你已经确认调整键顺序不会影响代码运行，那可以通过以下两种方式实现自动修复：

一、VSCode插件方案（适合日常开发单文件修复）

1. 强制ESLint修复`sort-keys`规则

ESLint默认不把sort-keys标记为可自动修复，但你可以通过VSCode配置强制开启它的修复能力：
打开VSCode的settings.json（快捷键Ctrl+, 然后点击右上角的打开JSON图标），添加以下配置：

"eslint.rules.customizations": [
  { "rule": "sort-keys", "severity": "error", "fixable": true }
],
"editor.codeActionsOnSave": {
  "source.fixAll.eslint": true
}

配置完成后，保存文件时ESLint就会自动排序对象键；也可以手动触发修复：按下Ctrl+Shift+P，选择ESLint: Fix all auto-fixable problems。

2. 专用排序插件

如果觉得ESLint的配置太繁琐，可以试试专门的VSCode插件Object Keys Sort：

安装后，默认快捷键Alt+Shift+K可以快速对当前选中的对象（或整个文件的所有对象）排序
也可以在settings.json中开启保存自动排序：

"objectKeysSort.autoSortOnSave": true,
"objectKeysSort.include": ["**/*.js", "**/*.json"] // 指定要处理的文件类型

二、自定义脚本/CLI方案（适合批量修复遗留代码库）

如果需要一次性处理整个代码库的文件，用脚本或CLI命令效率更高：

1. 用ESLint CLI强制修复

直接通过ESLint命令行触发sort-keys的修复，即使它默认不允许自动修复：

npx eslint --fix --rule "sort-keys: error" src/**/*.{js,json}

这个命令会遍历src目录下所有JS和JSON文件，自动排序对象键。如果你的ESLint配置文件里已经启用了sort-keys规则，也可以简化成：

npx eslint --fix src/**/*.{js,json}

2. 自定义Node.js脚本（灵活定制）

如果需要更个性化的排序逻辑（比如忽略某些特定键、按特定规则排序），可以自己写脚本处理：

处理JS文件（基于AST解析）

先安装依赖：

npm install recast

然后编写脚本：

const recast = require('recast');
const fs = require('fs');
const path = require('path');

// 排序JS对象字面量的键
function sortJsObjectKeys(code) {
  const ast = recast.parse(code);
  recast.visit(ast, {
    visitObjectExpression(path) {
      // 按键名的字母顺序排序
      path.node.properties.sort((propA, propB) => {
        const keyA = propA.key.name || propA.key.value;
        const keyB = propB.key.name || propB.key.value;
        return keyA.localeCompare(keyB);
      });
      this.traverse(path);
    }
  });
  return recast.print(ast).code;
}

// 遍历目录处理所有JS文件
function processJsFiles(dir) {
  fs.readdirSync(dir).forEach(file => {
    const fullPath = path.join(dir, file);
    if (fs.statSync(fullPath).isDirectory()) {
      processJsFiles(fullPath);
    } else if (fullPath.endsWith('.js')) {
      const content = fs.readFileSync(fullPath, 'utf8');
      const sortedContent = sortJsObjectKeys(content);
      fs.writeFileSync(fullPath, sortedContent);
      console.log(`已处理：${fullPath}`);
    }
  });
}

// 执行脚本
processJsFiles('./src');

处理JSON文件（更简单）

JSON文件可以直接解析为对象后排序键：

const fs = require('fs');
const path = require('path');

function sortJsonFile(filePath) {
  const content = fs.readFileSync(filePath, 'utf8');
  const obj = JSON.parse(content);
  // 按键名排序
  const sortedObj = Object.keys(obj).sort().reduce((acc, key) => {
    acc[key] = obj[key];
    return acc;
  }, {});
  // 保留原有的缩进格式（这里用2空格）
  const sortedContent = JSON.stringify(sortedObj, null, 2);
  fs.writeFileSync(filePath, sortedContent);
  console.log(`已处理：${filePath}`);
}

// 遍历目录处理JSON文件
function processJsonFiles(dir) {
  fs.readdirSync(dir).forEach(file => {
    const fullPath = path.join(dir, file);
    if (fs.statSync(fullPath).isDirectory()) {
      processJsonFiles(fullPath);
    } else if (fullPath.endsWith('.json')) {
      sortJsonFile(fullPath);
    }
  });
}

processJsonFiles('./src');