# @fellow/eslint-plugin-coffee 中文文档

规范地址：https://npmcn.com/package/%40fellow/eslint-plugin-coffee/

版本：0\.4\.13
npm 元数据更新时间：2026-01-12T19:25:24.900Z
中文译文更新时间：2026-11-14T14:07:17.340Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fellow/eslint-plugin-coffee
原文对照：https://npmcn.com/package/%40fellow/eslint-plugin-coffee/?lang=original
项目主页：https://github.com/aminland/eslint-plugin-coffee#readme
源码仓库：https://github.com/aminland/eslint-plugin-coffee

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

- 包体积（解压后）：49.4 kB，28 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=0\.10\.0
- 运行依赖：7 个
- 首次发布：2018-02-13T00:05:13.115Z
- 最新版本发布：2018-08-27T22:28:09.030Z
- 近 30 天下载量：4972（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 0 个）

## 中文简介

Transpiles咖啡文件(.coffee,.cjsx)并运行于斯林特. 报告有原行号的错误.

## 安装

```sh
npm install @fellow/eslint-plugin-coffee
```

也可以使用：`pnpm add @fellow/eslint-plugin-coffee`、`yarn add @fellow/eslint-plugin-coffee`、`bun add @fellow/eslint-plugin-coffee`

## README

# @fellow/eslint-plugin-coffee (英语)

咖啡文件先是用咖啡纸 然后再检查它们 行 / 列 报告是通过源图数据处理的, 因此它们对于您的咖啡文件是准确的 .

插件忽略了一些无法从 Coffeescript中满足的规则(参见 [此文件](https://npmcn.com/package/%40fellow/eslint-plugin-coffee/src/processors.coffee#L8)(中文(简体) )

还要遵守规则 [咖啡林2号](https://www.npmjs.com/package/@fellow/coffeelint2) 在埃斯林特创建了一个假规则, 将咖啡林特2的规则包裹并映射出来.

**特别谢谢** 改为 [亚历山大·梅特纳](https://github.com/a-x-) 用于启动和提供基础代码.

## 安装

你首先需要安装 [ESLint 语录](http://eslint.org/)数字 :

```
$ npm i eslint --save-dev
```

下一个,安装 `@fellow/eslint-plugin-coffee`数字 :

```
$ npm install @fellow/eslint-plugin-coffee --save-dev
```

**说明:** 如果在全球安装了 ESLint(使用 `-g` 您必须安装 `@fellow/eslint-plugin-coffee` 在全球.

## 简单使用( E)

编辑您的 `.eslintrc` 文档。 并添加此插件。 最简单的配置是仅仅扩展所提供的基础配置,以获得一套良好的规则([看这里](https://npmcn.com/package/%40fellow/eslint-plugin-coffee/src/configs/recommended.coffee)) (中文(简体) ). 你可以省略这个 `eslint-plugin-` 配置 eslint 时的前缀.

**说明:** 如果您喜欢使用标签, 请确保扩展 `@fellow/coffee/**recommended-tabs**` 换句话说.

```yaml
{ 
    "extends": ["plugin:@fellow/coffee/recommended"],
    "plugins": [
      "@fellow/coffee", 
      # ...
    ]
}
```

## 手动配置

仅限ESLint规则,添加 `@fellow/coffee` 到您的插件区 `.eslintrc` 配置文件 。 如果使用一套良好的基本规则,这将很好地涵盖许多事情。 一如既往,你可以省略 `eslint-plugin-` 前缀 :

```yaml
{
  "plugins": [
    "@fellow/coffee", 
      # ...
  ]
}
```

为了更好地与其他插件兼容(例如. `eslint-plugins-imports`)),我还提供"parser",由eslint可以钩入. 类似插件 `import` 插件不通过检查或需要模块运行, 您必须设置此插件来包装您的默认解析器 :

```yaml
{
  "parser": "@fellow/eslint-plugin-coffee",
  "parserOptions": { 
    "parser": "babel-eslint", # original parser goes here (you must specify one to use this option).
    "sourceType": "module", # any original parser config options you had.
    "ecmaVersion": 6
  },
  "plugins": [
    "@fellow/eslint-plugin-coffee", 
    # ...
  ],
  "rules": {
    "@fellow/coffee/coffeescript-error": ["error", {}],
    # ...
  }

}
```

看看你如何加入自己的咖啡林式规则, 切换你的 `.eslintrc` - > (中文) `.eslintrc.js` 并添加: `require('@fellow/eslint-plugin-coffee').registerCoffeeLintRule('myRuleModule')` 在顶上.

那就把它放进去 `rules` 区域 `.eslintrc.js`,通过任何您规则所期望的配置选项.

要学习如何为咖啡林写规则, 检查他们的文件.

## 编辑器兼容性

### 虚拟系统

为了在 VS 代码中工作,安装 `eslint` 扩展并添加到您的工作空间设置中 :

```
"settings": {
    ...
    "files.associations": {
        "*.cjsx": "coffeescript"
    },
    "eslint.validate": [
        "javascript",
        "javascriptreact",
        "coffeescript"
    ],
},
```

## 常见问题

### @fellow/eslint-plugin-coffee 是什么？

Transpiles咖啡文件\(\.coffee,\.cjsx\)并运行于斯林特\. 报告有原行号的错误\.

### 如何安装 @fellow/eslint-plugin-coffee？

在项目目录运行 npm install @fellow/eslint-plugin-coffee，或使用 pnpm add / yarn add / bun add。

### @fellow/eslint-plugin-coffee 支持 TypeScript 吗？

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

### @fellow/eslint-plugin-coffee 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @fellow/eslint-plugin-coffee 需要什么版本的 Node\.js？

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

### @fellow/eslint-plugin-coffee 可以商用吗？

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

### @fellow/eslint-plugin-coffee 的下载量有多少？

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

### @fellow/eslint-plugin-coffee 还在维护吗？

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