@apify/eslint-config

中文文档
2.0.6发布于 2026/04/11ISCCommonJS构建来源已验证近 30 天下载 7.3万

在 Apify 中共享 ESLint 配置 .

中文使用文档

apify-slint-配置

此寄存器包含一个共享的 eslint 配置 说明它提供几种配置:

  • JavaScript 配置 @apify/eslint-config/js
  • 类型脚本 包含 JavaScript 配置的配置 @apify/eslint-config/ts
  • 欢乐 仅适用于测试文件和文件夹的配置 @apify/eslint-config/jest
  • 维特 仅适用于测试文件和文件夹的配置 @apify/eslint-config/vitest
  • 立体式规则 @apify/eslint-config/style (见下文)

如何增加您的项目

首先将软件包安装为开发依赖 :

npm install --save-dev @apify/eslint-config eslint

可以选择安装:

  • typescript-eslint 如果您打算使用 类型脚本, (中文(简体) ),
  • eslint-plugin-jest 如果您打算使用 欢乐 用于测试,
  • @vitest/eslint-plugin 如果您打算使用 维特 测试.

添加 eslint.config.js 文件,这里是一个使用无害环境管理和 Jest进行测试的 TypeScript 项目的示例配置:

import apifyTypescriptConfig from '@apify/eslint-config/ts';
// Optional
import apifyJestConfig from '@apify/eslint-config/jest';

export default [
    ...apifyTypescriptConfig,
    ...apifyJestConfig,
    {
        languageOptions: {
            sourceType: 'module',
            parserOptions: {
                projectService: true,
                tsconfigRootDir: import.meta.dirname,
            },
        },
    },
];

JavaScript 工程的示例配置 :

const apifyJsConfig = require('@apify/eslint-config/js');

module.exports = [
    ...apifyJsConfig,
];

JavaScript项目使用无害环境管理和测试的示例配置:

import apifyJsConfig from '@apify/eslint-config/js';
import apifyVitestConfig from '@apify/eslint-config/vitest';

export default [
    ...apifyJsConfig,
    ...apifyVitestConfig,
];

定型规则(选入)

基础配置有 没有 执行结构规则/格式规则——Pretier(或任何其他格式)是处理这些规则的建议方式。 如果你有很强的理由不使用前题 并且想要保留气味的风格规则,安装 @stylistic/eslint-plugin 并添加选入 @apify/eslint-config/style 配置 :

npm install --save-dev @stylistic/eslint-plugin
import apifyTypescriptConfig from '@apify/eslint-config/ts';
import apifyStyleConfig from '@apify/eslint-config/style';

export default [
    ...apifyTypescriptConfig,
    ...apifyStyleConfig,
];

增加了58个结构规则(indent, (中文(简体) ), quotes, (中文(简体) ), semi, (中文(简体) ), comma-dangle, (中文(简体) ), space-before-blocks, (中文(简体) ), keyword-spacing, (中文(简体) ), max-len等),选项相同 eslint-config-airbnb-base 用于执行,重写为 @stylistic/* 因此,他们与 eslint v9 +平面配置。 如果你使用Pretier,请 没有 包括这个配置 —— 规则会与您的前题相冲突 .

版本与发布记录

@apify/eslint-config 共发布 44 个版本,首次发布于 2019/07/29;过去 12 个月发布了 8 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.0.6latest2026/04/116 个月前
2.0.52026/04/116 个月前
2.0.42026/04/106 个月前
2.0.32026/04/096 个月前
2.0.22026/04/096 个月前
2.0.12026/04/096 个月前

其他发布通道:beta → 1.1.1-beta.0。

关于 @apify/eslint-config 的常见问题

@apify/eslint-config 是什么?

在 Apify 中共享 ESLint 配置 .

如何安装 @apify/eslint-config?

在项目目录运行 npm install @apify/eslint-config,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@eslint/js(^9.19.0)、eslint(^9.19.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@apify/eslint-config 支持 TypeScript 吗?

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

@apify/eslint-config 支持 ESM 还是 CommonJS?

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

@apify/eslint-config 可以商用吗?

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

@apify/eslint-config 的下载量有多少?

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

@apify/eslint-config 还在维护吗?

最新版本 2.0.6 发布于 2026/04/11(6 个月前);至今共发布 44 个版本,其中过去 12 个月发布了 8 个;首次发布于 2019/07/29。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。