# @colony/eslint-config-colony 中文文档

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

版本：10\.0\.0
npm 元数据更新时间：2024-03-18T21:22:23.365Z
中文译文更新时间：2026-11-10T11:13:14.511Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：10.7 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：eslint ^8\.57\.0，eslint-config-airbnb-base ^15\.0\.0，eslint-config-prettier ^9\.1\.0，eslint-plugin-eslint-comments ^3\.2\.0，eslint-plugin-import ^2\.29\.1，eslint-plugin-prettier ^5\.1\.3，prettier ^3\.2\.5
- 首次发布：2017-11-26T02:55:37.052Z
- 最新版本发布：2024-03-13T09:04:50.152Z
- 近 30 天下载量：7594（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 0 个）

## 中文简介

殖民地项目的eslint配置

## 安装

```sh
npm install @colony/eslint-config-colony
```

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

## README

# 埃斯林特- 配置- 殖民地

用于殖民地开放源码软件项目的eslint配置. 复制自 [eslint - 配置 - 空降](https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb/README.md)

## 使用量

我们的默认导出包含我们所有的ESLint规则.

**所需资源**

-   `eslint`
-   `babel-eslint`
-   `eslint-config-airbnb-base`
-   `eslint-config-prettier`
-   `eslint-plugin-import`
-   `eslint-plugin-prettier`
-   `prettier`

如果使用纱线,请运行 `npm info "@colony/eslint-config-colony@latest" peerDependencies` ,然后运行 `yarn add --dev <dependency>@<version>` 用于列出的对等依赖。 npm 指令见下文.

1.  安装命令列出的每个软件包的正确版本:

```sh
npm info "@colony/eslint-config-colony@latest" peerDependencies
```

如果使用 **npm 5+ (韩语)**快捷键

```sh
npx install-peerdeps --dev @colony/eslint-config-colony
```

如果使用 **线条**,也可以使用上面描述的快捷键,如果您在您的机器上安装了 npm 5+,因为命令会检测您正在使用纱线,并将相应采取行动. 否则,跑 `npm info "@colony/eslint-config-colony@latest" peerDependencies` ,然后运行 `yarn add --dev <dependency>@<version>` 用于列出的对等依赖.

如果使用 **npm < 5 (中文(简体) )**, Linux/OSX 用户可以运行

```sh
(
  export PKG=@colony/eslint-config-colony;
  npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)
```

生成并运行一个命令,例如:

```sh
npm install --save-dev @colony/eslint-config-colony eslint@^#.#.# eslint-plugin-import@^#.#.#
```

如果使用 **npm < 5 (中文(简体) )**, Windows 用户可以手动安装所有对等依赖,也可以使用 [安装- perdeps](https://github.com/nathanhleung/install-peerdeps) cli 工具.

```sh
npm install -g install-peerdeps
install-peerdeps --dev @colony/eslint-config-colony
```

CLI将制作并运行一个命令,比如:

```sh
npm install --save-dev @colony/eslint-config-colony eslint@^#.#.# eslint-plugin-import@^#.#.#
```

2.  添加 `"extends": "@colony/eslint-config-colony"` 到您的 . slintrc

## 常见问题

### @colony/eslint-config-colony 是什么？

殖民地项目的eslint配置

### 如何安装 @colony/eslint-config-colony？

在项目目录运行 npm install @colony/eslint-config-colony，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（^8\.57\.0）、eslint-config-airbnb-base（^15\.0\.0）、eslint-config-prettier（^9\.1\.0）、eslint-plugin-eslint-comments（^3\.2\.0）、eslint-plugin-import（^2\.29\.1）、eslint-plugin-prettier（^5\.1\.3）、prettier（^3\.2\.5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @colony/eslint-config-colony 支持 TypeScript 吗？

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

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

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

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

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

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

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

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

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