# @harperfast/code-guidelines 中文文档

规范地址：https://npmcn.com/package/%40harperfast/code-guidelines/

版本：0\.1\.2
npm 元数据更新时间：2026-10-03T00:44:31.154Z
中文译文更新时间：2026-11-17T10:20:04.435Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：18.1 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：5 个
- peer 依赖：eslint \>= 9，prettier \>= 3，typescript \>= 5\.9，@types/node \>= 20
- 首次发布：2026-07-29T12:44:44.903Z
- 最新版本发布：2026-07-29T14:39:17.471Z
- 近 30 天下载量：63710（2026-10-18 至 2026-11-16，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

Harper寄存器的编码准则。 包括类型、衬线和格式.

## 安装

```sh
npm install @harperfast/code-guidelines
```

也可以使用：`pnpm add @harperfast/code-guidelines`、`yarn add @harperfast/code-guidelines`、`bun add @harperfast/code-guidelines`

## README

# @harperfast/代码指南

这个寄存器包含了哈珀组织的代码指南工具和配置.

> 目前导出Pretier,ESLint和TS节点类型检查的共享配置. 不久将增加更多的工具.

## 快速启动

1.  `npm i --save-dev @harperfast/code-guidelines`
    
2.  添加 `"prettier": "@harperfast/code-guidelines/prettier"` 改为 **软件包.json**。 。 。 .
    
3.  运行 `npx prettier .`
    

## 格式化

我们用 [高级](https://prettier.io/) 用于格式化。 默认配置导出于 `/prettier` 路径(即:. `@harperfast/code-guidelines/prettier`) (中文(简体) ).

评议 [共享配置](https://prettier.io/docs/en/sharing-configurations) 文档,以了解如何使用或扩展基础配置.

## 线性

我们用 [ESLint 语录](https://eslint.org/) 用于执行代码质量,并整合Pretier格式化。 默认配置导出于 `/eslint` 路径(即:. `@harperfast/code-guidelines/eslint`) (中文(简体) ).

### 使用 Harper ESLint 配置

您必须创建本地的 ESLint 配置, 导入 Harper 的 ESLint 配置, 然后您可以通过添加自己的规则来扩展或覆盖基础配置 .

关于扩展配置的更详细资料,请参见: [ESLint 配置文件文档](https://eslint.org/docs/latest/use/configure/configuration-files#extending-configurations)。 。 。 .

1.  安装所需的依赖性 :

```bash
npm i --save-dev @harperfast/code-guidelines eslint prettier
```

2.  创建一个 `eslint.config.mjs` 在工程根中的文件 :

```javascript
import harperConfig from '@harperfast/code-guidelines/eslint';
import { defineConfig } from 'eslint/config';

export default defineConfig([
    ...harperConfig,
    // Your custom configuration here
    {
        rules: {
            // Override or add custom rules
        },
    },
]);
```

3.  运行 ESLint :

```bash
npx eslint .
```

## 类型检查

TypeScript 配置文件在 `/tsconfig` 导出路径并可用于此 `extends` 个人财产 `tsconfig.json` 文档.

例如,要使用基础节点.js配置(支持节点.js v20或后期):

1.  从安装必要的依赖性开始 :

```bash
   npm i --save-dev typescript @types/node@20 @harperfast/code-guidelines
```

2.  然后创建一个 `tsconfig.json` 文件中包含以下内容:

```json
{
    "extends": "@harperfast/code-guidelines/tsconfig.node.json",
    "compilerOptions": {
        // Your custom options here
    }
}
```

3.  最后,使用TypeScript或Node.js Type脱发!

```bash
   npx tsc
   # or
   node src/index.ts
```

配置基于受欢迎 [tsconfig 基础](https://github.com/tsconfig/bases) 项目.

以下列表概述了可用的配置:

-   `tsconfig.node.json` - 节点.js v20 或以后有节点.js 类型剥取支持
-   _马上就要来了!_

### 添加新配置

要添加新的类型脚本配置 :

1.  在此寄存器中创建新文件 `tsconfig.` 结尾 `.json`介于两者之间的名称应是对环境或相关版本的描述(例如:. `tsconfig.react.json` 或者说 `tsconfig.node-24.json`) (中文(简体) ).
2.  更新 `exports` 输入 `package.json` 包含使用与文件相同名称的新配置文件.
3.  以简记入上表.
4.  飞船

## 常见问题

### @harperfast/code-guidelines 是什么？

Harper寄存器的编码准则。 包括类型、衬线和格式\.

### 如何安装 @harperfast/code-guidelines？

在项目目录运行 npm install @harperfast/code-guidelines，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（\>= 9）、prettier（\>= 3）、typescript（\>= 5\.9）、@types/node（\>= 20）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @harperfast/code-guidelines 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/harperfast\_\_code-guidelines 是否存在。

### @harperfast/code-guidelines 支持 ESM 还是 CommonJS？

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

### @harperfast/code-guidelines 可以商用吗？

@harperfast/code-guidelines 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @harperfast/code-guidelines 的下载量有多少？

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

### @harperfast/code-guidelines 还在维护吗？

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

