# @aurelienbbn/oxfmt-config 中文文档

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

版本：0\.2\.0
npm 元数据更新时间：2026-09-29T13:27:01.906Z
中文译文更新时间：2026-11-07T06:07:35.824Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40aurelienbbn/oxfmt-config
原文对照：https://npmcn.com/package/%40aurelienbbn/oxfmt-config/?lang=original
项目主页：https://github.com/aurelienbobenrieth/harness/tree/main/packages/oxfmt-config#readme
源码仓库：https://github.com/aurelienbobenrieth/harness

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

- 包体积（解压后）：10.4 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^22\.19\.0 \|\| ^24\.11\.0
- 运行依赖：0 个
- peer 依赖：oxfmt \>=0\.67\.0 \<0\.69\.0
- 首次发布：2026-09-25T09:46:00.893Z
- 最新版本发布：2026-09-29T13:27:01.582Z
- 近 30 天下载量：2070（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

用于JavaScript和TypeScript项目的可重复使用的oxfmt配置.

## 安装

```sh
npm install @aurelienbbn/oxfmt-config
```

也可以使用：`pnpm add @aurelienbbn/oxfmt-config`、`yarn add @aurelienbbn/oxfmt-config`、`bun add @aurelienbbn/oxfmt-config`

## README

# @aurienbn/oxfmt-config

[![npm](https://img.shields.io/npm/v/@aurelienbbn/oxfmt-config)](https://www.npmjs.com/package/@aurelienbbn/oxfmt-config) [![downloads](https://img.shields.io/npm/dm/@aurelienbbn/oxfmt-config)](https://www.npmjs.com/package/@aurelienbbn/oxfmt-config) [![CI](https://github.com/aurelienbobenrieth/harness/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/aurelienbobenrieth/harness/actions/workflows/ci.yml) [![license](https://img.shields.io/npm/l/@aurelienbbn/oxfmt-config)](https://github.com/aurelienbobenrieth/harness/blob/main/packages/oxfmt-config/LICENSE) [![node](https://img.shields.io/node/v/@aurelienbbn/oxfmt-config)](https://github.com/aurelienbobenrieth/harness/blob/main/packages/oxfmt-config/package.json)

**每个 JS/TS 重播一个 oxfmt 配置: 100 列,双引号,后置逗号,多行 JSDoc,排序 `package.json`。 。 。 .**

```sh
pnpm add -D @aurelienbbn/oxfmt-config oxfmt   # oxfmt >=0.67.0 <0.69.0 · Node ^22.19.0 || ^24.11.0
```

```ts
// oxfmt.config.ts
import { defineOxfmtConfig } from "@aurelienbbn/oxfmt-config";
import { defineConfig } from "oxfmt";

export default defineConfig(defineOxfmtConfig({ ignorePatterns: ["dist/**"] }));
```

平面 `OxfmtConfig`: 直接或作为 Vite+ 工作的 oxfmt `fmt` 配置, 不依赖 Vite+ .

## 出口

| 导出 | 什麽 |
| --- | --- |
| `defaultOxfmtConfig` | 基线对象 |
| `defineOxfmtConfig(overrides?, options?)` | 基线 + 您的覆盖, 新的克隆 |
| `OxfmtConfig` | 类型,从 `oxfmt` |

基线值

| 设置 | 数值 |
| --- | --- |
| `printWidth` | `100` |
| `tabWidth` | `2` |
| `semi` | `true` |
| `singleQuote` | `false` |
| `trailingComma` | `"all"` |
| `arrowParens` | `"always"` |
| `jsdoc.commentLineStrategy` | `"multiline"` |
| `sortPackageJson` | `true` |
| `ignorePatterns` | `.agents/**`, (中文(简体) ), `**/*.wasm`, (中文(简体) ), `pnpm-lock.yaml` |
| `overrides` | `[]` |

## 列表合并, 其他都替换

```text
defineOxfmtConfig(o)                         ignorePatterns, overrides  →  baseline + yours, deduplicated
defineOxfmtConfig(o, { replaceLists: true }) ignorePatterns, overrides  →  yours only (drops default ignores)
any other top-level key                                                  →  yours wins
```

**结果是a `structuredClone`数字 :** 变换它从不碰 `defaultOxfmtConfig`。 。 。 .

[兼容性矩阵](https://npmcn.com/package/docs/compatibility.md): 已打包的配置 vs 基线和当前 oxfmt, 完整的依赖性声明检查, 干净且格式化不良的输入.

## 常见问题

### @aurelienbbn/oxfmt-config 是什么？

用于JavaScript和TypeScript项目的可重复使用的oxfmt配置\.

### 如何安装 @aurelienbbn/oxfmt-config？

在项目目录运行 npm install @aurelienbbn/oxfmt-config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：oxfmt（\>=0\.67\.0 \<0\.69\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aurelienbbn/oxfmt-config 支持 TypeScript 吗？

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

### @aurelienbbn/oxfmt-config 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @aurelienbbn/oxfmt-config 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.19\.0 \|\| ^24\.11\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @aurelienbbn/oxfmt-config 可以商用吗？

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

### @aurelienbbn/oxfmt-config 的下载量有多少？

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

### @aurelienbbn/oxfmt-config 还在维护吗？

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