# @harness-engineering/linter-gen 中文文档

规范地址：https://npmcn.com/package/%40harness-engineering/linter-gen/

版本：0\.2\.0
npm 元数据更新时间：2026-11-12T02:31:24.384Z
中文译文更新时间：2026-11-17T10:50:29.346Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：122 kB，43 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2026-03-16T18:51:17.579Z
- 最新版本发布：2026-11-12T02:31:23.913Z
- 近 30 天下载量：9348（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

从 YAML 配置生成 ESLint 规则

## 安装

```sh
npm install @harness-engineering/linter-gen
```

也可以使用：`pnpm add @harness-engineering/linter-gen`、`yarn add @harness-engineering/linter-gen`、`bun add @harness-engineering/linter-gen`

## README

# @harness-engineering/linter-gen (英语)

使用可扩展的 Handlebars 模板从 YAML 配置生成 ESLint 规则 .

## 安装

```bash
pnpm add @harness-engineering/linter-gen
```

## 使用量

### 配置

创建 `harness-linter.yml`数字 :

```yaml
version: 1
output: ./generated/eslint-rules

rules:
  - name: no-ui-in-services
    type: import-restriction
    severity: error
    config:
      source: 'src/services/**'
      forbiddenImports:
        - 'react'
        - 'src/ui/**'
      message: 'Service layer cannot import UI code'
```

### 国 际

```bash
# Generate rules
harness linter generate

# Generate with options
harness linter generate --config ./custom-config.yml --output ./rules --clean

# Validate config only
harness linter validate
```

### 程序化 API

```typescript
import { generate, validate } from '@harness-engineering/linter-gen';

// Generate rules
const result = await generate({
  configPath: './harness-linter.yml',
  outputDir: './generated',
  clean: true,
});

if (result.success) {
  console.log(`Generated ${result.rulesGenerated.length} rules`);
}

// Validate config
const validation = await validate({ configPath: './harness-linter.yml' });
```

## 内建模板

### 导入限制

在匹配源模式的文件中块导入匹配模式 .

```yaml
- name: no-react-in-services
  type: import-restriction
  config:
    source: 'src/services/**'
    forbiddenImports:
      - 'react'
      - 'react-dom'
    message: 'Service files cannot import React'
```

### 边界验证

确保文件导出 Zod schemas 进行校验 .

```yaml
- name: api-must-validate
  type: boundary-validation
  config:
    pattern: 'src/api/**/*.ts'
    requireZodSchema: true
    message: 'API endpoints must use Zod validation'
```

### 依赖图

检测循环导入依赖性 .

```yaml
- name: no-cycles
  type: dependency-graph
  config:
    entryPoints:
      - 'src/index.ts'
    exclude:
      - '**/*.test.ts'
    maxDepth: 20
```

## 自定义模板

### 以《公约》为基础

将模板放入 `templates/` 相对于配置的目录 :

```
project/
├── harness-linter.yml
└── templates/
    └── my-custom-type.ts.hbs
```

### 明确路径

在配置中指定模板路径 :

```yaml
templates:
  my-custom-type: ./custom-templates/my-rule.ts.hbs
```

### 模板上下文

模板接收 :

```typescript
{
  name: 'rule-name',           // kebab-case
  nameCamel: 'ruleName',       // camelCase
  namePascal: 'RuleName',      // PascalCase
  severity: 'error',           // error | warn | off
  config: { ... },             // Template-specific config
  meta: {
    generatedAt: '2026-03-13T...',
    generatorVersion: '0.1.0',
    configPath: '/path/to/config.yml',
  }
}
```

### 处理栏助手

-   `{{json value}}` - JSON,快说
-   `{{jsonPretty value}}` - JSON. 弦与格式化
-   `{{camelCase "kebab-name"}}` - 转换为骆驼Case
-   `{{pascalCase "kebab-name"}}` - 转换为PascalCase

## 许可证

麻省理工学院

## 常见问题

### @harness-engineering/linter-gen 是什么？

从 YAML 配置生成 ESLint 规则

### 如何安装 @harness-engineering/linter-gen？

在项目目录运行 npm install @harness-engineering/linter-gen，或使用 pnpm add / yarn add / bun add。

### @harness-engineering/linter-gen 支持 TypeScript 吗？

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

### @harness-engineering/linter-gen 支持 ESM 还是 CommonJS？

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

### @harness-engineering/linter-gen 可以商用吗？

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

### @harness-engineering/linter-gen 的下载量有多少？

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

### @harness-engineering/linter-gen 还在维护吗？

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

