@zerowork/prettierrc 1.0.0

package/.prettierignore

@@ -0,0 +1,17 @@
+# Dependency directories
+node_modules/
+
+# Production
+public/
+dist/
+
+# Cache
+.cache/
+cache/
+.history/
+
+# yarn v2
+.yarn/
+
+# See https://github.com/lerna/lerna/issues/2565
+CHANGELOG.md

package/README.md

@@ -0,0 +1,66 @@
+# prettierrc
+
+* prettier通用配置
+
+## 安装
+
+```sh
+npm i -D prettier @zerowork/prettierrc
+```
+
+## 配置使用
+
+### 方式一：在`package.json`中配置`prettier`
+
+* 在`package.json`中添加`prettier`字段，采用此方式将使用默认配置
+
+```diff
++	"prettier": "@zerowork/prettierrc",
+	"main": "dist/index.js"
+```
+
+### 方式二：使用`.prettierrc.js`方式导入配置
+
+* 新建`.prettierrc.js`，导入`@zerowork/prettierrc`，并支持配置覆盖
+
+```js
+module.exports = {
+  ...require("@zerowork/prettierrc"),
+  // 扩展或覆盖相关配置字段
+  semi: false
+}
+```
+
+## 配置使用`.prettierignore`
+
+1. 在 `npm scripts`中配置
+
+```json
+{
+	"scripts": {
+		"format": "prettier --write . --ignore-path ./node_modules/@zerowork/prettierrc/.prettierignore"
+	}
+}
+```
+
+2. 在 `lint-staged`中配置
+
+```json
+{
+	"lint-staged": {
+		"*": [
+			"prettier --write --ignore-path ./node_modules/@zerowork/prettierrc/.prettierignore"
+		]
+	}
+}
+```
+
+3. 在 vscode `settings.json`中配置
+
+```json
+{
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"editor.formatOnSave": true,
+	"prettier.ignorePath": "./node_modules/@zerowork/prettier/.prettierignore"
+}
+```

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./prettier.config');

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@zerowork/prettierrc",
+  "version": "1.0.0",
+  "description": "prettier通用配置",
+  "files": [
+    "index.js",
+    "README.md",
+    ".prettierignore",
+    "prettierrc.js",
+    "prettier.config.js",
+    "package.json"
+  ],
+  "main": "index.js",
+  "peerDependencies": {
+    "prettier": "*"
+  },
+  "devDependencies": {
+    "prettier": "^2.4.1"
+  },
+  "engines": {
+    "node": ">=12"
+  }
+}

package/prettierrc.js

@@ -0,0 +1,47 @@
+// https://prettier.io/docs/en/options.html
+
+module.exports = {
+  // 超过最大值换行
+  printWidth: 120,
+  // tab缩进字符数
+  tabWidth: 2,
+  // 缩进不使用tab，使用空格
+  useTabs: false,
+  // 去掉代码结尾的分号
+  semi: false,
+  // 使用单引号
+  singleQuote: true,
+  // 在jsx中使用单引号代替双引号
+  jsxSingleQuote: false,
+  // 在对象或数组最后一个元素后面是否加逗号（不添加）
+  trailingComma: 'none',
+  // 让prettier使用eslint的代码格式进行校验
+  eslintIntegration: true,
+  // 在对象，数组括号与文字之间加空格 "{ foo: bar }"
+  bracketSpacing: true,
+  // (x) => {} 箭头函数参数只有一个时要有小括号。
+  arrowParens: 'always',
+  // 换行符使用 lf 结尾  <lf|crlf|cr|auto>
+  endOfLine: 'lf',
+  // 不让HTML中的 > 多行显示
+  bracketSameLine: false,
+  // 每个文件格式化的范围是文件的全部内容 - 范围开始
+  rangeStart: 0,
+  // 每个文件格式化的范围是文件的全部内容 - 范围结束
+  rangeEnd: Number.POSITIVE_INFINITY,
+  // 若为true，文件顶部加了 /*** @prettier */或/*** @format */的文件才会被格式化
+  requirePragma: false,
+  // 当requirePragma参数为true时，此参数为true将向@format标记后面添加一个换行符
+  insertPragma: false,
+  // 当Markdown文本超过printWidth时是否换行 <always|never|preserve> - preserve 保留用户输入的情况
+  proseWrap: 'preserve',
+  // 根据显示样式决定 html 要不要折行 <css|strict|ignore>"
+  htmlWhitespaceSensitivity: 'css',
+  // 对象key是否使用引号 <as-needed|consistent|preserve> - preserve 保留用户输入的情况
+  quoteProps: 'preserve',
+  // vue文件的script标签和Style标签下的内容需要缩进
+  vueIndentScriptAndStyle: false,
+  // 是否格式化嵌入到JS中的html标记的代码段或者Markdown语法 <auto|off> - auto 格式化
+  embeddedLanguageFormatting: 'auto',
+};
+