JSON Sort -杰森排序
一个简单实用的 VSCode 扩展,可以根据预定义的规则对 JSON 文件的属性进行排序。

✨ 功能特性
- 🎯 右键菜单集成:在 JSON 文件上右键即可使用 “杰森排序” 功能
- 📋 自定义排序规则:通过
jsonSort.md
文件定义属性排序顺序
- 🔄 深度排序:自动递归排序嵌套的 JSON 对象
- 💾 保留原有属性:未在规则中定义的属性会保留在最后
- 🚀 零配置:开箱即用,只需创建规则文件即可
📦 安装
- 克隆此仓库到本地
- 在项目目录运行
npm install
安装依赖
- 运行
npm run compile
编译扩展
- 在 VSCode 中按
F5
启动调试
🚀 使用方法
1。创建排序规则文件
在项目中创建 jsonSort.md
文件,使用数字列表定义属性排序顺序:
# JSON 属性排序规则
请按照以下顺序排列 JSON 属性:
1. id
2. name
3. type
4. version
5. description
6. author
7. license
8. keywords
9. dependencies
10. devDependencies
11. scripts
12. config
13. data
2。执行排序
- 在 VSCode 中打开任意
.json
文件
- 在编辑器中右键点击
- 选择菜单中的 “杰森排序”
- JSON 文件将自动按照规则排序并保存
📝 示例
排序前的 JSON:
{
"scripts": {
"test": "echo \"test\"",
"build": "webpack"
},
"author": "陈随易",
"version": "1.0.0",
"name": "example-project",
"id": "001"
}
排序后的 JSON:
{
"id": "001",
"name": "example-project",
"version": "1.0.0",
"author": "陈随易",
"scripts": {
"test": "echo \"test\"",
"build": "webpack"
}
}
🔧 规则文件查找逻辑
扩展会从当前 JSON 文件所在目录开始,逐级向上查找 jsonSort.md
文件:
project/
├── src/
│ ├── data.json ← 右键点击此文件
│ └── jsonSort.md ← 首先在这里查找
├── jsonSort.md ← 如果上面没找到,继续向上查找
└── package.json
🎨 高级用法
嵌套对象排序
扩展会自动递归处理嵌套的对象:
{
"data": {
"users": [
{
"email": "user@example.com",
"id": 1,
"name": "张三"
}
]
}
}
数组中的对象也会按照相同的规则进行排序。
支持的格式
- ✅ 标准数字列表:
1. propertyName
- ✅ 带缩进的列表:
1. propertyName
- ✅ 多级嵌套列表 (当前版本会扁平化处理)
⚠️ 注意事项
- 文件名必须为
jsonSort.md
(区分大小写)
- 规则格式必须为数字列表 (如
1. name
)
- JSON 文件必须是有效的 JSON 格式
- 排序会自动保存文件
👨💻 作者