更好的格式化你的vue2代码

725 阅读1分钟

Format Vue Style Code是一个VSCODE 插件,他能够帮助你做以下事情

Features

1️⃣ 重排 import 文件顺序 ✅

重排前
let timer;
import App from "./App.vue";
import { func1 } from "@/utils/func.js";
import { func2 } from "@/utils/func.js";
import Vue from "vue";
重排后
import Vue from "vue";
import { func1, func2 } from "@/utils/func.js";
import App from "./App.vue";
let timer;

引入文件将会按照以下规则进行排序,并且自动去除重复引入的文件。

  1. 依赖文件
  2. 带有@或者~的引入文件
  3. 相对路径引入的文件或者定义的变量

2️⃣ 对 Vue2 中的 option API 写法进行格式化 ✅

重排前
export default {
  methods: {    3️⃣
    func1() {},
  },
  data() {      2️⃣
    return {};
  },
  name: "App",  1️⃣
};
重排后
export default {
  name: "App",  1️⃣
  data() {      2️⃣
    return {};
  },
  methods: {    3️⃣
    func1() {},
  },
};

将按照 name、components...等顺序 进行排列。

  • 如何修改默认顺序? 快捷键:ctrl + shift + p 或者 command + shift + p,输入format-vue-style-code: change option order,输入你想要的排序即可。

3️⃣ 对 data 等 options 中的内容进行排序 ✅

template part
<template>
  <div>
    <div>{{ a }}</div>
    <div>{{ b }}</div>
  </div>
</template>
script part
export default {
  data() {
    return {
        b: 2,// => a: 1,
        a: 1,// => b: 2,
    };
  },
  created() {
    console.log(this.a)
  },
};
  • 在此例子中,data 中的 a: 1 将会被放到 b: 2 的前面;因为不管在template中还是其他option中,a 变量都是优先使用的。如果有冲突,那会以生命周期函数>template进行排序。

How to use

  • 右键菜单中的Format You Code选项
  • 快捷键:ctrl + shift + p 或者 command + shift + p,输入Format You Code

Undone Features

  • 对 Vue3 中的 composition API 进行格式化
  • 代码重构

Download

在 vscode 扩展中搜索 format-vue-style-code 即可找到该插件。

Issues

使用中遇到问题可以在这里提问。 github.com/leemathew19…

Sources

插件源码,沟通交流在这里。 github.com/leemathew19…