# @faircopy/config 中文文档

规范地址：https://npmcn.com/package/%40faircopy/config/

版本：1\.27\.3
npm 元数据更新时间：2026-11-07T06:14:58.803Z
中文译文更新时间：2026-11-14T09:00:28.838Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40faircopy/config
原文对照：https://npmcn.com/package/%40faircopy/config/?lang=original
项目主页：https://github.com/omniaura/faircopy#readme
源码仓库：https://github.com/omniaura/faircopy

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

- 包体积（解压后）：3 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-04-23T09:21:31.673Z
- 最新版本发布：2026-11-07T06:14:58.429Z
- 近 30 天下载量：11939（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：35（近 12 个月 35 个）

## 中文简介

定义 Config 帮助器和用于公平复制的再导出类型

## 安装

```sh
npm install @faircopy/config
```

也可以使用：`pnpm add @faircopy/config`、`yarn add @faircopy/config`、`bun add @faircopy/config`

## README

# @ faircopy/ config

`defineConfig()` 帮助 `faircopy.config.ts`. 具有全类型脚本推论的身份功能——除打字检查外,没有运行时间效果.

## 安装

```sh
npm i -D @faircopy/config
```

## 使用量

```ts
// faircopy.config.ts
import { defineConfig } from '@faircopy/config'
import { astro } from '@faircopy/astro'

export default defineConfig({
  files: ['src/**/*.astro'],
  ignore: ['src/content/blog/**'],
  adapters: [astro()],
  rulesets: ['@faircopy/rules-nlp'],
  rules: {
    'no-em-dash': 'error',
    'no-weasel-words': ['error', { words: ['actually', 'truly', 'really', 'literally'] }],
    'no-rhetorical-scaffolding': 'error',
    'no-passive-voice': 'warn',
  },
})
```

`rulesets` 加载可选规则包,使其规则ID可以使用而不重复包名. 如果多个装入的包会暴露出相同的赤裸规则名,则使用该规则的包合格ID.

所有公共类型从 `@faircopy/core` 从该包中再出.

## 常见问题

### @faircopy/config 是什么？

定义 Config 帮助器和用于公平复制的再导出类型

### 如何安装 @faircopy/config？

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

### @faircopy/config 支持 TypeScript 吗？

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

### @faircopy/config 支持 ESM 还是 CommonJS？

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

### @faircopy/config 可以商用吗？

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

### @faircopy/config 的下载量有多少？

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

### @faircopy/config 还在维护吗？

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

