@caspeco/eslint-config-ts

中文文档
5.5.1发布于 2026/10/20MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 5122

Caspeco ESLint configuration for TypeScript projects

原始使用文档
文档目录9 节
  1. Installation
  2. Usage
  3. What's Included
  4. Peer Dependencies
  5. Plugins
  6. typescript-eslint
  7. eslint-plugin-no-barrel-files
  8. eslint-plugin-check-file
  9. License

@caspeco/eslint-config-ts

Caspeco ESLint configuration for TypeScript projects.

Installation

npm install --save-dev @caspeco/eslint-config-ts

Usage

Create an eslint.config.js file in your project root:

import config from "@caspeco/eslint-config-ts";

export default [{ ignores: ["dist/**/*", "build/**/*"] }, ...config];

What's Included

This configuration includes:

  • TypeScript ESLint - Using recommended-type-checked config
  • No Barrel Files - Prevents barrel file usage (index files that just re-export)
  • File Naming Conventions - Enforces kebab-case for files and folders
  • Prettier Integration - Compatible with Prettier formatting

Peer Dependencies

This package requires the following peer dependencies (automatically installed by npm 7+):

  • @eslint/js
  • eslint
  • eslint-config-prettier
  • eslint-plugin-check-file
  • eslint-plugin-no-barrel-files
  • typescript-eslint

See package.json for specific version requirements.

Plugins

typescript-eslint

Using recommended-type-checked config with project service enabled.

eslint-plugin-no-barrel-files

eslint-plugin-no-barrel-files

We opt out of using barrel files as they can:

  • Slow down builds and tests
  • Cause circular dependencies
  • Make tree shaking more difficult

Note: We allow barrel files for libraries consumed as npm packages.

More information:

eslint-plugin-check-file

eslint-plugin-check-file

Enforces KEBAB_CASE for filenames and folders.

Why kebab-case?

  1. Cross-Platform Consistency: Avoids issues on case-insensitive systems (Windows, macOS) where MyFile.js and myfile.js are treated the same
  2. Readability: Clear, natural separation of words with hyphens
  3. Predictability: Consistent file-naming pattern across the project

License

MIT

版本与发布记录

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

版本发布日期距今
5.5.1latest2026/10/2020 天前
5.5.02026/10/2020 天前
5.5.0-beta.0next2026/10/2020 天前
5.4.22026/08/122 个月前
5.4.12026/07/104 个月前
5.4.02026/07/094 个月前

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

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

Caspeco ESLint configuration for TypeScript projects

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

在项目目录运行 npm install @caspeco/eslint-config-ts,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:eslint(^9.39.4 || ^10.0.0)、@eslint/js(^9.39.4 || ^10.0.0)、typescript-eslint(^8.57.2)、eslint-config-prettier(^10.1.8)、eslint-plugin-check-file(^3.3.2)、eslint-plugin-baseline-js(^0.7.5)、eslint-plugin-no-barrel-files(^2.2.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 caspeco-ts-migrate-v5,可以用 npx caspeco-ts-migrate-v5 直接运行。

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

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

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

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

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

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

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

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

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

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