如何使用Prettier管理好代码一致性

Prettier

Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary.

意思是：Prettier是一种固执己见的代码格式化程序。它通过解析代码并使用自己的规则(考虑到最大行的长度)重新打印代码，以及在必要时包装代码，从而实现一致的风格。

插件安装列表

• vetur（0.24.0）

• prettier（4.4.0）

• manta’s stylus supremacy（2.15.0）

简单配置实现保存文件格式化

进入 settings.json 文件复制以下配置代码

打开方式： VSCode 的系统settins.json文件，打开方式：ctrl + shift + P，搜索 open settings(json)

// 格式化设置
"editor.formatOnSave": true, // 是否保存时格式化
"editor.minimap.maxColumn": 80, // 右侧缩略图宽度尺寸
"editor.detectIndentation": false, // 关闭根据文件类型自动设置tabsize的选项
"vetur.format.defaultFormatter.html": "prettier",
"vetur.format.defaultFormatter.js": "prettier",
"vetur.format.defaultFormatter.less": "prettier",
"vetur.format.defaultFormatter.css": "none",
"vetur.format.options.useTabs": true, // 使用tab格式化而不是空格
"[vue]": {
    "editor.defaultFormatter": "octref.vetur"
},
"vetur.format.defaultFormatterOptions": {
    "prettier": {
        "printWidth": 120, // 代码宽度
        "singleQuote": false, // 是否使用单引号
        "semi": true, // 末尾使用分号
        "tabWidth": 4, // 缩进单位
        "arrowParens": "avoid", // 函数体一个参数的时候是否需要括号
        "bracketSpacing": true, // 在对象中，数组括号与文字之间加空格 "{ foo: bar }"
        "proseWrap": "preserve" // 代码超出是否要换行 preserve保留
    }
},
// 格式化stylus用的，不格式化可不用
"stylusSupremacy.insertColons": false, // 是否插入冒号
"stylusSupremacy.insertSemicolons": false, // 是否插入分号
"stylusSupremacy.insertBraces": false, // 是否插入大括号
"stylusSupremacy.insertNewLineAroundImports": false, // import之后是否换行
"stylusSupremacy.insertNewLineAroundBlocks": false, // 两个选择器中是否换行

完整配置（个人）

{
    // 格式化设置
    "editor.formatOnSave": true, // 是否保存时格式化
    "editor.minimap.maxColumn": 80, // 右侧缩略图宽度尺寸
    "editor.detectIndentation": false, // 关闭根据文件类型自动设置tabsize的选项
    "vetur.format.defaultFormatter.html": "prettier",
    "vetur.format.defaultFormatter.js": "prettier",
    "vetur.format.defaultFormatter.less": "prettier",
    "vetur.format.defaultFormatter.css": "none",
    "vetur.format.options.useTabs": false, // 使用tab格式化而不是空格
    "[vue]": {
        "editor.defaultFormatter": "octref.vetur"
    },
    "vetur.format.defaultFormatterOptions": {
        "prettier": {
            "printWidth": 120, // 代码宽度
            "singleQuote": false, // 是否使用单引号
            "semi": true, // 末尾使用分号
            "tabWidth": 4, // 缩进单位
            "arrowParens": "avoid", // 函数体一个参数的时候是否需要括号
            "bracketSpacing": true, // 在对象中，数组括号与文字之间加空格 "{ foo: bar }"
            "proseWrap": "preserve" // 代码超出是否要换行 preserve保留
        }
    },
    // 格式化stylus用的，不格式化可不用，插件：manta's stylus supremacy
    "stylusSupremacy.insertColons": false, // 是否插入冒号
    "stylusSupremacy.insertSemicolons": false, // 是否插入分号
    "stylusSupremacy.insertBraces": false, // 是否插入大括号
    "stylusSupremacy.insertNewLineAroundImports": false, // import之后是否换行
    "stylusSupremacy.insertNewLineAroundBlocks": false, // 两个选择器中是否换行
    // less设置
    "less.compile": {
        "compress": false,
        "sourceMap": false,
        "out": ".\\", // 这里是代表编译后生成的css文件所放的位置，当前写法表示 当前目录下生成index.css文件
    },
    "files.exclude": {
        "**/node_modules/*/**": true
    },
    "vetur.format.options.tabSize": 4,
    "diffEditor.ignoreTrimWhitespace": false,
    "editor.fontSize": 17,
    "explorer.confirmDelete": false,
    "[javascript]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "window.zoomLevel": 1,
    "prettier.jsxBracketSameLine": true,
    "prettier.vueIndentScriptAndStyle": true,
    "cSpell.words": [
        "border",
        "continuest",
        "get",
        "groupmanage",
        "jjsg",
        "jobsmanage",
        "realname",
        "state",
        "dev",
        "docs",
        "open",
        "vitepress"
    ],
}

文档配置参数列表（节选）

"prettier.printWidth": 100, // 超过最大值换行
"prettier.tabWidth": 4, // 缩进字节数
"prettier.useTabs": false, // 缩进不使用tab，使用空格
"prettier.semi": true, // 句尾添加分号
"prettier.singleQuote": true, // 使用单引号代替双引号
"prettier.proseWrap": "preserve", // 默认值。因为使用了一些折行敏感型的渲染器（如GitHub comment）而按照markdown文本样式进行折行
"prettier.arrowParens": "avoid", //  (x) => {} 箭头函数参数只有一个时是否要有小括号。avoid：省略括号
"prettier.bracketSpacing": true, // 在对象，数组括号与文字之间加空格 "{ foo: bar }"
"prettier.disableLanguages": ["vue"], // 不格式化vue文件，vue文件的格式化单独设置
"prettier.endOfLine": "auto", // 结尾是 \n \r \n\r auto
"prettier.eslintIntegration": false, //不让prettier使用eslint的代码格式进行校验
"prettier.htmlWhitespaceSensitivity": "ignore",
"prettier.ignorePath": ".prettierignore", // 不使用prettier格式化的文件填写在项目的.prettierignore文件中
"prettier.jsxBracketSameLine": false, // 在jsx中把'>' 是否单独放一行
"prettier.jsxSingleQuote": false, // 在jsx中使用单引号代替双引号
"prettier.parser": "babylon", // 格式化的解析器，默认是babylon
"prettier.requireConfig": false, // Require a 'prettierconfig' to format prettier
"prettier.stylelintIntegration": false, //不让prettier使用stylelint的代码格式进行校验
"prettier.trailingComma": "es5", // 在对象或数组最后一个元素后面是否加逗号（在ES5中加尾逗号）
"prettier.tslintIntegration": false // 不让prettier使用tslint的代码格式进行校验

官方完整配置文档超链接