@atom.io/eslint-plugin

中文文档
0.1.1发布于 2026/10/29MPL-2.0TypeScriptES Module构建来源已验证近 30 天下载 2.1万

ESLint对原子.io状态和交易申报的规则.

中文使用文档
文档目录5 节
  1. ESLint对原子.io状态和交易申报的规则.
  2. 读取 attom.io.fyi 的文档
  3. 安装
  4. 配置
  5. 规则
atom.io logo

@atom.io/eslint-plugin

NPM VersionDependencies 1CoverageTypes

ESLint对原子.io状态和交易申报的规则.

读取 attom.io.fyi 的文档

在ESLint 9或10同时安装此软件包作为开发依赖, @typescript-eslint/parser 8,以及一个被支持的TypeScript编译器(4.8.4至6.0.x).

TypeScript同行描述了ESLint使用的编译器API. 您可以用 TypeScript 7 并列构建: 启动模板别名 TypeScript 7 作为 @typescript/native 页:1 tsc 财务报告和审定财务报表 @typescript/typescript6 作为 typescript 用于 ESLint 的编译器 API 和单独的 tsc6 命令.

这个 exact-catch-types 规则需要配置有类型信息的 TypeScript 解析器。 在您的 ESLint 配置中配置解析器 .

选入 ban-use-effect 规则禁止 useEffect 在应用程序代码中,同时允许 useLayoutEffect其诊断与 反对使用效果 财务报告和审定财务报表 node_modules/atom.io/docs/agent/packages/against-use-effect.md 用于替换指导。 见 配置和所支持的表格。 。 。 .

见 安装指南、配置展览和规则文档。当从 atom.io/eslint-plugin,将导入改为 @atom.io/eslint-plugin; 默认插件导出, 命名 Rules 导出、 规则名称和选项不变 .

安装

pnpm add -D @atom.io/eslint-plugin eslint typescript-eslint \
  typescript@npm:@typescript/[email protected] \
  @typescript/native@npm:[email protected]

配置

import atomIO from "@atom.io/eslint-plugin"
import tseslint from "typescript-eslint"

export default tseslint.config(
    {
        ignores: [`dist/**`, `node_modules/**`],
    },
    ...tseslint.configs.recommendedTypeChecked,
    {
        files: [`**/*.{ts,tsx}`],
        languageOptions: {
            parserOptions: {
                projectService: true,
                tsconfigRootDir: import.meta.dirname,
            },
        },
        plugins: {
            "atom.io": atomIO,
        },
        rules: {
            "atom.io/exact-catch-types": `error`,
            "atom.io/explicit-state-types": `error`,
            "atom.io/explicit-transaction-types": `error`,
            "atom.io/naming-convention": `error`,
        },
    },
)

规则

规则说明
atom.io/ban-use-effect禁用 Atom.io 应用程序代码中的反用效果
atom.io/naming-convention给 Atom.io 资源的可变名称应匹配其密钥属性并遵循一致的格式
atom.io/exact-catch-types确保当一个错误类型(E)提供给一个原子时,“捕获”属性被设定,其中的所有构造器均可被指定给E.
atom.io/explicit-state-types国家声明必须具有直接传递给它们的通用类型的论据
atom.io/explicit-transaction-types交易申报必须具有直接传递给它们的通用类型的论据

版本与发布记录

@atom.io/eslint-plugin 共发布 4 个版本,首次发布于 2026/10/17;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.1latest2026/10/299 天前
0.1.02026/10/2414 天前
0.0.02026/10/1721 天前
0.0.0-stage2026/10/1721 天前

关于 @atom.io/eslint-plugin 的常见问题

@atom.io/eslint-plugin 是什么?

ESLint对原子.io状态和交易申报的规则.

如何安装 @atom.io/eslint-plugin?

在项目目录运行 npm install @atom.io/eslint-plugin,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:eslint(^9.0.0 || ^10.0.0)、typescript(>=4.8.4 <6.1.0)、@typescript-eslint/parser(^8.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@atom.io/eslint-plugin 支持 TypeScript 吗?

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

@atom.io/eslint-plugin 支持 ESM 还是 CommonJS?

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

@atom.io/eslint-plugin 可以商用吗?

@atom.io/eslint-plugin 使用 MPL-2.0 许可。弱 Copyleft:可以商用,也可以和闭源代码一起使用;但如果分发时修改了 MPL 授权的文件,这些文件的修改需以 MPL 开源。以上为概括,不构成法律意见,请以许可原文为准。

@atom.io/eslint-plugin 的下载量有多少?

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

@atom.io/eslint-plugin 还在维护吗?

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