# @faktion-com/prettier-config 中文文档

规范地址：https://npmcn.com/package/%40faktion-com/prettier-config/

版本：0\.0\.3
npm 元数据更新时间：2025-08-12T15:49:45.983Z
中文译文更新时间：2026-11-14T16:21:08.337Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40faktion-com/prettier-config
原文对照：https://npmcn.com/package/%40faktion-com/prettier-config/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：12.8 kB，21 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2025-06-25T15:23:40.824Z
- 最新版本发布：2025-08-12T15:49:45.788Z
- 近 30 天下载量：1983（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

更美物质的配置

## 安装

```sh
npm install @faktion-com/prettier-config
```

也可以使用：`pnpm add @faktion-com/prettier-config`、`yarn add @faktion-com/prettier-config`、`bun add @faktion-com/prettier-config`

## README

# @faktion-com/ prettier-config (英语)

Faktion 项目共享的 Pretier 配置包 。 这个包为所有Faktion寄存器和项目提供了一致的代码格式化规则.

## 特征

-   **统一格式**:确保所有代码遵循相同的格式标准
-   **尾风 CSS 支持**页:1 `prettier-plugin-tailwindcss` 用于优化尾风类排序
-   **现代默认**: 配置了现代 JavaScript/ TypeScript 开发的合理默认
-   **简单整合**: 任何项目的简单设置程序

## 安装

将软件包安装为 dev 依赖 :

```bash
npm install --save-dev @faktion-com/prettier-config
# or
yarn add --dev @faktion-com/prettier-config
# or
pnpm add --save-dev @faktion-com/prettier-config
```

## 使用量

### 基本设置

创建一个 `.prettierrc.js` 在工程根中的文件 :

```javascript
module.exports = require("@faktion-com/prettier-config/base");
```

或者如果你在使用ES模块, 创建一个 `.prettierrc.mjs`数字 :

```javascript
import baseConfig from "@faktion-com/prettier-config/base";
export default baseConfig;
```

### Tailwind css 特定设置

对于带有自定义尾风配置的项目,您需要在指向尾风的配置中添加属性 . config.js 文件,这样在添加自定义类时,它们也会被尾风插件命令

```typescript
import reactConfig from "@faktion-com/prettier-config/react";
export default {
    ...reactConfig,
    "tailwindConfig": "./apps/frontend/tailwind.config.js"
} as const
```

### 软件包.json 配置

或者,您可以直接将配置添加到您的 `package.json`数字 :

```json
{
  "prettier": "@faktion-com/prettier-config/base"
}
```

## 配置

基础配置包括以下设置:

-   **轨迹逗号**: ES5样式
-   **标签宽度**: 2 个空格
-   **分号**: 永远
-   **引号**单引号
-   **JSX引述**单引号
-   **标签**: 仅空格
-   **打印宽度**: 80个字符
-   **括号间距**已启用
-   **括号同行**已启用
-   **箭头函数括号**: 永远
-   **每行单属性**已启用
-   **结束**: LF (Unix 样式)
-   **插件**: 包含 Tailwind CSS 插件

## IDE 整合

### VS 代码

1.  安装 Pretier 扩展
2.  将 Pretier 设置为默认物质
3.  保存时启用格式( 可选)

添加到您的 VS 代码设置 :

```json
{
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true
}
```

### 其他编辑器

大多数现代编辑器都自动支持Pretier配置文件. 配置将在您有 `.prettierrc.js` 或者说 `package.json` 配置您的项目 .

## 脚本

将这些脚本添加到您的 `package.json` 用于方便的格式 :

```json
{
  "scripts": {
    "format": "prettier --write .",
    "format:check": "prettier --check ."
  }
}
```

## 忽略文件

创建一个 `.prettierignore` 用于排除格式化文件的文件 :

```
node_modules
dist
build
```

## 常见问题

### @faktion-com/prettier-config 是什么？

更美物质的配置

### 如何安装 @faktion-com/prettier-config？

在项目目录运行 npm install @faktion-com/prettier-config，或使用 pnpm add / yarn add / bun add。

### @faktion-com/prettier-config 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @faktion-com/prettier-config 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @faktion-com/prettier-config 可以商用吗？

@faktion-com/prettier-config 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @faktion-com/prettier-config 的下载量有多少？

根据 npm 官方下载统计，@faktion-com/prettier-config 在 2026/10/14 – 2026/11/12 这 30 天内被下载 1,983 次，日均约 66 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @faktion-com/prettier-config 还在维护吗？

最新版本 0\.0\.3 发布于 2025/08/12（1\.3 年前）；至今共发布 4 个版本，其中过去 12 个月发布了 0 个；首次发布于 2025/06/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。