@aurelienbbn/oxfmt-config

中文文档
0.2.0发布于 2026/09/29MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 2070

Reusable oxfmt config for JavaScript and TypeScript projects.

原始使用文档

@aurelienbbn/oxfmt-config

npm downloads CI license node

One oxfmt config for every JS/TS repo: 100 columns, double quotes, trailing commas, multiline JSDoc, sorted package.json.

pnpm add -D @aurelienbbn/oxfmt-config oxfmt   # oxfmt >=0.67.0 <0.69.0 · Node ^22.19.0 || ^24.11.0
// oxfmt.config.ts
import { defineOxfmtConfig } from "@aurelienbbn/oxfmt-config";
import { defineConfig } from "oxfmt";

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

Plain OxfmtConfig: works with oxfmt directly or as Vite+'s fmt config, no Vite+ dependency.

Exports

ExportWhat
defaultOxfmtConfigthe baseline object
defineOxfmtConfig(overrides?, options?)baseline + your overrides, fresh clone
OxfmtConfigtype, re-exported from oxfmt
Baseline values
SettingValue
printWidth100
tabWidth2
semitrue
singleQuotefalse
trailingComma"all"
arrowParens"always"
jsdoc.commentLineStrategy"multiline"
sortPackageJsontrue
ignorePatterns.agents/**, **/*.wasm, pnpm-lock.yaml
overrides[]

Lists merge, everything else replaces

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

Result is a structuredClone: mutating it never touches defaultOxfmtConfig.

Compatibility matrix: packed config vs baseline and current oxfmt, complete dependency-declaration checks, clean and badly formatted inputs.

版本与发布记录

@aurelienbbn/oxfmt-config 共发布 3 个版本,首次发布于 2026/09/25;过去 12 个月发布了 3 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.2.0latest2026/09/291 个月前
0.1.12026/09/251 个月前
0.1.02026/09/251 个月前

关于 @aurelienbbn/oxfmt-config 的常见问题

@aurelienbbn/oxfmt-config 是什么?

Reusable oxfmt config for JavaScript and TypeScript projects.

如何安装 @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 和提交记录判断。