# @drupal-canvas/eslint-config 中文文档

规范地址：https://npmcn.com/package/%40drupal-canvas/eslint-config/

版本：0\.10\.1
npm 元数据更新时间：2026-09-25T20:54:45.549Z
中文译文更新时间：2026-11-12T21:44:53.413Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40drupal-canvas/eslint-config
原文对照：https://npmcn.com/package/%40drupal-canvas/eslint-config/?lang=original
源码仓库：https://git.drupalcode.org/project/canvas

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

- 包体积（解压后）：34.8 kB，3 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.19\.0 \<23 \|\| \>=24\.5\.0
- 运行依赖：8 个
- peer 依赖：eslint ^9\.26\.0
- 首次发布：2025-12-01T13:46:48.648Z
- 最新版本发布：2026-09-25T20:54:45.349Z
- 近 30 天下载量：4673（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

用于验证 Drupal Canvas 代码组件的 ESLint 配置

## 安装

```sh
npm install @drupal-canvas/eslint-config
```

也可以使用：`pnpm add @drupal-canvas/eslint-config`、`yarn add @drupal-canvas/eslint-config`、`bun add @drupal-canvas/eslint-config`

## README

# 龙卷风 Canvas ESLint 配置

用于验证 Drupal Canvas 代码组件的 ESLint 配置 .

## 配置变体

| 配置 | 说明 |
| --- | --- |
| `required` | 解析JavaScript和TypeScript文件的基础设置,组件元数据文件的YAML解析,以及Drupal Canvas代码组件验证的自定义规则. 自动使用 [`@drupal-canvas/cli`](https://www.npmjs.com/package/@drupal-canvas/cli) 当验证、构建或推动组件时. |
| `recommended` | `required` + 建议的规则来自 [`@eslint/js`](https://www.npmjs.com/package/@eslint/js), (中文(简体) ), [`eslint-plugin-react`](https://www.npmjs.com/package/eslint-plugin-react), (中文(简体) ), [`eslint-plugin-react-hooks`](https://www.npmjs.com/package/eslint-plugin-react-hooks), (中文(简体) ), [`eslint-plugin-jsx-a11y`](https://www.npmjs.com/package/eslint-plugin-jsx-a11y), (中文(简体) ), [`eslint-plugin-yml`](https://www.npmjs.com/package/eslint-plugin-yml) 财务报告和审定财务报表 [`typescript-eslint`](https://www.npmjs.com/package/typescript-eslint)。 。 。 . |
| `strict` | `recommended` + 严格规则从 [`eslint-plugin-jsx-a11y`](https://www.npmjs.com/package/eslint-plugin-jsx-a11y) 财务报告和审定财务报表 [`typescript-eslint`](https://www.npmjs.com/package/typescript-eslint)。 。 。 . |

## 使用量

```bash
npm install -D @drupal-canvas/eslint-config
```

```js
// eslint.config.js
import { defineConfig } from 'eslint/config';
import { recommended as drupalCanvasRecommended } from '@drupal-canvas/eslint-config';

export default defineConfig([
  ...drupalCanvasRecommended,
  // ...
]);
```

## 规则

这个 `required` 配置检查便携式作者规则和项目惯例. 元数据结构和目标接受通过 Canvas Code 组件元数据计划与目标Drupal站点.

| 规则 | 说明 |
| --- | --- |
| `component-dir-name` | 验证 `machineName` 匹配目录名称(索引样式)或文件名前缀(名样式). |
| `component-exports` | 验证该组件有默认导出 . |
| `component-imports` | 验证该组件仅从辅助进口来源和模式进口. |
| `component-no-hierarchy` | 验证组件目录为配置的直列子 `componentDir`。 。 。 . |
| `component-prop-example-value-no-empty-string` | 验证字符串道具示例中不包含空值 . |
| `component-prop-names` | 验证组件道具ID与骆驼Case版本的标题相匹配. |
| `component-required-props` | 验证所需的道具被定义,并提供一个默认示例. |

## 发展

用于开发此软件包的脚本如下:

| 命令 | 说明 |
| --- | --- |
| `dev` | 编译到 `dist` 用于开发的文件夹,同时监视更改. |
| `build` | 编译到 `dist` 用于制作的文件夹. |
| `type-check` | 运行类型脚本类型检查而不释放文件 . |
| `test` | 运行测试. |

## 常见问题

### @drupal-canvas/eslint-config 是什么？

用于验证 Drupal Canvas 代码组件的 ESLint 配置

### 如何安装 @drupal-canvas/eslint-config？

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

### @drupal-canvas/eslint-config 支持 TypeScript 吗？

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

### @drupal-canvas/eslint-config 支持 ESM 还是 CommonJS？

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

### @drupal-canvas/eslint-config 需要什么版本的 Node\.js？

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

### @drupal-canvas/eslint-config 可以商用吗？

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

### @drupal-canvas/eslint-config 的下载量有多少？

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

### @drupal-canvas/eslint-config 还在维护吗？

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