@apify/eslint-config-ts

中文文档
0.4.1发布于 2023/11/16ISCCommonJS近 30 天下载 9733

Typescript ESLint 配置在 Apify 中跨项目共享.

中文使用文档
文档目录6 节
  1. 安装
  2. 使用反应
  3. 编辑 .eslintrc
  4. 创建 tsconfig.json
  5. 示例最小设置( 在网络上使用)
  6. 编辑 lint npm 脚本

使用量

安装

npm install --save-dev eslint typescript @apify/eslint-config-ts @typescript-eslint/eslint-plugin @typescript-eslint/parser 

使用反应

要使用状态、儿童等反应类型安装:

npm i --save-dev @types/react

编辑 .eslintrc

添加(或替换) @apify/eslint-config 软件包)

{
  "extends": "@apify/eslint-config-ts"
}

注: https://eslint.org/docs/developer-guide/shareable-configs 页面存档备份,存于互联网档案馆:

在使用范围化模块时,不可能省略eslint-config-前缀. 这样做将导致一揽子命名冲突,从而导致在大多数情况下解决错误。 例如,一个名为@scope/eslint-config-myconfig vs @scope/my-config的软件包,因为两者都是有效的可扩展软件包名称,所以配置应当指定为:

{
    "extends": "@scope/eslint-config-myconfig"
}

创建 tsconfig.json

创建 tsconfig.json 在工程根中的文件并添加:

{}

所有选项列表 https://www.typescriptlang.org/tsconfig 互联网档案馆的存檔,存档日期2013-12-02

示例最小设置( 在网络上使用)

{
    "compilerOptions": {
        "skipLibCheck": true,
        "esModuleInterop": true,
        "jsx": "preserve",
        "noUnusedLocals": true,
        "noUnusedParameters": true
    },
    "exclude": [
        "node_modules",
    ],
    "include": [
        "**/*.ts",
        "**/*.tsx"
    ]
}

skipLibCheck数字 : 跳过第3个政党库声明文件的打字检查( extension. d. ts),因为它们可能有不同的 tsconfig

esModuleInterop数字 : 允许将“ 从反应中导入反应” 改为“ 从反应中导入 * ”

jsx数字 : 允许使用 JSX 标记

noUnusedLocals数字 : 未使用的变量出错

noUnusedParameters数字 : 未使用的函数参数出错

编辑 lint npm 脚本

编辑 lint npm 脚本以包含.ts,.tsx 文件并运行打字符验证

"eslint --ext .js,.jsx,.ts,.tsx ; tsc --noemit"

版本与发布记录

@apify/eslint-config-ts 共发布 12 个版本,首次发布于 2020/09/30;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.4.1latest2023/11/162 年前
0.4.02023/10/253 年前
0.3.02023/05/253 年前
0.2.32021/11/154 年前
0.2.22021/11/154 年前
0.2.12021/11/154 年前

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

@apify/eslint-config-ts 是什么?

Typescript ESLint 配置在 Apify 中跨项目共享.

如何安装 @apify/eslint-config-ts?

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

@apify/eslint-config-ts 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

最新版本 0.4.1 发布于 2023/11/16(2 年前);至今共发布 12 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/09/30。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。