@dyb-dev/prettier-config 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 dyb-dev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,51 @@
+# @dyb-dev/prettier-config
+
+`@dyb-dev/prettier-config` 是一个全面的 Prettier 配置包，支持 JavaScript、TypeScript、Vue、Jsonc、JsDoc格式化检查，且额外支持 Html、Markdown、.d.ts格式化检查。此包旨在为你的项目提供统一和一致的编码风格。
+
+## 安装
+
+使用以下命令安装此包，具体取决于你使用的包管理器：
+
+```shell
+# 使用 npm
+npm install @dyb-dev/prettier-config -D
+
+# 使用 pnpm
+pnpm add @dyb-dev/prettier-config -D
+
+# 使用 yarn
+yarn add @dyb-dev/prettier-config -D
+```
+
+## 使用方法
+
+在你的 Prettier 配置文件中扩展此配置。你可以在 `.prettierrc.js` 或 `.prettierrc.mjs` 或 `.prettierrc.cjs` 文件中进行配置：
+
+`.prettierrc.js` 或 `.prettierrc.mjs` 文件示例
+
+```js
+import prettierConfig from "@dyb-dev/prettier-config"
+export default prettierConfig
+```
+
+`.prettierrc.cjs` 文件示例
+
+```js
+const prettierConfig = require("@dyb-dev/prettier-config")
+module.exports = prettierConfig
+```
+
+## 功能支持
+
+-   **JavaScript 格式化**: 支持对普通 JavaScript 文件的代码规范检查。
+-   **TypeScript 格式化检查**: 确保你的 TypeScript 代码符合规范，但请注意，你需要额外安装 `typescript` 依赖（`npm install typescript -D`）。
+-   **Vue 文件格式化**: 内置对 Vue 文件的支持，确保你的 Vue 组件代码风格统一。
+-   **Jsonc 文件格式化**: 支持 JSON with Comments 格式的文件格式化。
+-   **JsDoc 格式化**: 确保你的代码注释符合规范，提升代码可读性。
+-   **Html 文件格式化**: 支持 HTML 文件的格式化，确保网页结构清晰规范。
+-   **Markdown 文件格式化**: 提供对 Markdown 文件的格式化支持，确保文档内容易读且统一。
+-   **.d.ts 文件格式化**: 针对 TypeScript 的类型声明文件进行格式化，确保类型定义清晰一致。
+
+### 安装包后无法使用格式化
+
+如果在安装 @dyb-dev/prettier-config 后无法使用格式化功能，可能是因为编辑器尚未加载新的配置。解决方法是 重启 编辑器，然后重新尝试格式化操作。

package/index.cjs

@@ -0,0 +1,55 @@
+/*
+ * @Author: dyb-dev
+ * @Date: 2024-08-27 20:52:09
+ * @LastEditors: dyb-dev
+ * @LastEditTime: 2024-08-27 22:50:43
+ * @FilePath: /base-lib/packages/prettier-config/index.cjs
+ * @Description: Prettier 配置
+ */
+
+module.exports = {
+    // 指定换行的行长
+    printWidth: 130,
+    // 指定每个缩进级别的空格数
+    tabWidth: 4,
+    // 用空格而不是制表符缩进
+    useTabs: false,
+    // 在语句末尾打印分号
+    semi: false,
+    // Vue 文件中 <script> 和 <style> 标签内的代码是否缩进
+    vueIndentScriptAndStyle: false,
+    // 使用双引号而不是单引号
+    singleQuote: false,
+    // 引用对象中的属性时更改
+    quoteProps: "as-needed",
+    // 打印对象字面量中括号之间的空格
+    bracketSpacing: true,
+    // 将多行 HTML（HTML、JSX、Vue、Angular）元素的 > 放在最后一行的末尾，而不是单独放在下一行（不适用于自关闭元素）。
+    bracketSameLine: false,
+    // 格式化开始位置：从文件顶部开始
+    rangeStart: 0,
+    // 格式化结束位置：无穷大
+    rangeEnd: Infinity,
+    // 尾随逗号
+    trailingComma: "none",
+    // 在 JSX 中使用单引号而不是双引号
+    jsxSingleQuote: false,
+    // 在唯一的箭头函数参数周围包含括号
+    arrowParens: "avoid",
+    // Prettier 可以在文件顶部插入一个特殊的 @format 标记，指定该文件已使用 Prettier 格式化
+    insertPragma: false,
+    // Prettier 可以限制自己只格式化在文件顶部包含特殊注释（称为 pragma）的文件
+    requirePragma: false,
+    // Prettier 不会更改 Markdown 文本 例如：README.md
+    proseWrap: "preserve",
+    // 指定 HTML、Vue、Angular 和 Handlebars 的全局空白敏感度，如果行标签可能会改变间距，保留空格，如果是块标签无法影响布局，则去除空格
+    htmlWhitespaceSensitivity:
+        "css",
+    // 维护现有的行结尾（一个文件中的混合值通过查看第一行之后使用的内容来规范化）
+    endOfLine: "auto",
+    // 控制 Prettier 是否格式化嵌入在文件中的引用代码
+    embeddedLanguageFormatting:
+        "auto",
+    // 不要强制每行使用一个属性
+    singleAttributePerLine: false
+}

package/index.mjs

@@ -0,0 +1,53 @@
+/*
+ * @Author: dyb-dev
+ * @Date: 2024-08-27 19:36:32
+ * @LastEditors: dyb-dev
+ * @LastEditTime: 2024-08-27 22:49:34
+ * @FilePath: /base-lib/packages/prettier-config/index.mjs
+ * @Description: Prettier 配置
+ */
+
+export default {
+    // 指定换行的行长
+    printWidth: 130,
+    // 指定每个缩进级别的空格数
+    tabWidth: 4,
+    // 用空格而不是制表符缩进
+    useTabs: false,
+    // 在语句末尾打印分号
+    semi: false,
+    // Vue 文件中 <script> 和 <style> 标签内的代码是否缩进
+    vueIndentScriptAndStyle: false,
+    // 使用双引号而不是单引号
+    singleQuote: false,
+    // 引用对象中的属性时更改
+    quoteProps: "as-needed",
+    // 打印对象字面量中括号之间的空格
+    bracketSpacing: true,
+    // 将多行 HTML（HTML、JSX、Vue、Angular）元素的 > 放在最后一行的末尾，而不是单独放在下一行（不适用于自关闭元素）。
+    bracketSameLine: false,
+    // 格式化开始位置：从文件顶部开始
+    rangeStart: 0,
+    // 格式化结束位置：无穷大
+    rangeEnd: Infinity,
+    // 尾随逗号
+    trailingComma: "none",
+    // 在 JSX 中使用单引号而不是双引号
+    jsxSingleQuote: false,
+    // 在唯一的箭头函数参数周围包含括号
+    arrowParens: "avoid",
+    // Prettier 可以在文件顶部插入一个特殊的 @format 标记，指定该文件已使用 Prettier 格式化
+    insertPragma: false,
+    // Prettier 可以限制自己只格式化在文件顶部包含特殊注释（称为 pragma）的文件
+    requirePragma: false,
+    // Prettier 不会更改 Markdown 文本 例如：README.md
+    proseWrap: "preserve",
+    // 指定 HTML、Vue、Angular 和 Handlebars 的全局空白敏感度，如果行标签可能会改变间距，保留空格，如果是块标签无法影响布局，则去除空格
+    htmlWhitespaceSensitivity: "css",
+    // 维护现有的行结尾（一个文件中的混合值通过查看第一行之后使用的内容来规范化）
+    endOfLine: "auto",
+    // 控制 Prettier 是否格式化嵌入在文件中的引用代码
+    embeddedLanguageFormatting: "auto",
+    // 不要强制每行使用一个属性
+    singleAttributePerLine: false
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@dyb-dev/prettier-config",
+  "version": "0.0.1",
+  "description": "Prettier 配置",
+  "author": "dyb-dev",
+  "license": "MIT",
+  "type": "module",
+  "private": false,
+  "main": "./index.cjs",
+  "module": "./index.mjs",
+  "exports": {
+    ".": {
+      "require": "./index.cjs",
+      "import": "./index.mjs"
+    }
+  },
+  "files": [
+    "index.cjs",
+    "index.mjs",
+    "package.json",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18.0.0",
+    "pnpm": ">=8.15.5"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dyb-dev/base-lib"
+  },
+  "homepage": "https://github.com/dyb-dev/base-lib/tree/main/packages/prettier-config",
+  "bugs": {
+    "url": "https://github.com/dyb-dev/base-lib/issues",
+    "directory": "https://github.com/dyb-dev/base-lib/tree/main/packages/prettier-config"
+  },
+  "keywords": [
+    "prettier",
+    "prettier-config"
+  ],
+  "devDependencies": {
+    "prettier": "^3.3.2"
+  },
+  "peerDependencies": {
+    "prettier": "^3.3.2"
+  }
+}