# @better-css-modules/core 中文文档

规范地址：https://npmcn.com/package/%40better-css-modules/core/

版本：0\.4\.1
npm 元数据更新时间：2026-10-21T15:06:02.931Z
中文译文更新时间：2026-11-07T23:59:27.173Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40better-css-modules/core
原文对照：https://npmcn.com/package/%40better-css-modules/core/?lang=original
源码仓库：https://github.com/k35o/better-css-modules

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

- 包体积（解压后）：192 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：10 个
- 首次发布：2026-03-27T14:16:28.716Z
- 最新版本发布：2026-10-21T15:06:02.391Z
- 近 30 天下载量：9918（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 8 个）

## 中文简介

分析、类型生成、未使用的级检测、代号检查、监视器和更好cs-模块配置

## 安装

```sh
npm install @better-css-modules/core
```

也可以使用：`pnpm add @better-css-modules/core`、`yarn add @better-css-modules/core`、`bun add @better-css-modules/core`

## README

# @ better-cs-moules/ core (英语)

更好的cs-模块背后的分析: 配置加载, `.d.ts` 和检查。 CLI和每个捆绑器插件都建在上面. 在他们旁边安装 `defineConfig`,该配置文件导入.

## 安装

```bash
pnpm add -D @better-css-modules/core
```

## 配置文件

```ts
// better-css-modules.config.ts
import { defineConfig } from "@better-css-modules/core";

export default defineConfig({
  globalCss: ["./src/globals.css"],
  layer: "components",
});
```

`defineConfig` 返回当前配置并输入。 设置在 [项目README](https://github.com/k35o/better-css-modules#configuration)。 。 。 .

## API 密码

```ts
import {
  check,
  ConfigError,
  formatDiagnostic,
  generate,
  loadConfig,
} from "@better-css-modules/core";

try {
  const config = await loadConfig();
  const { files } = await generate(config);
  const { diagnostics, modules, tokens } = await check(config);
  for (const diagnostic of diagnostics) console.log(formatDiagnostic(diagnostic, process.cwd()));
  console.log(`${files.length} types, ${modules} modules, tokens: ${tokens.join(", ")}`);
} catch (error) {
  if (!(error instanceof ConfigError)) throw error;
  console.error(error.message);
  process.exitCode = 2;
}
```

-   `loadConfig({ cwd?, config? })` 装入配置文件 `config` 名称,相对于 `cwd`,或 `better-css-modules.config.*` 内 `cwd` (默认为工作目录),并返回为 `ResolvedConfig`: 已填入、检查并带有的默认值 `root`,每个相对路径的起始目录 `file`,配置文件或 `null`。 。 。 .
-   `generate(config)` 写入 `.d.ts` 文档及其声明地图,删除它为样式表所写的已丢失的文件,并返回 a `GenerateResult`数字 : `files`, (中文(简体) ), `removed` 语法 `diagnostics`。 。 。 .
-   `check(config)` 运行每次检查并返回 a `CheckResult`: 排序 `diagnostics`,数量 `modules` 和符号类别`tokens`全球CSS限制.
-   `exportTokens(config)` 读取全局 CSS 并返回其符号为 DTCG 解析器文档 `DtcgResolver` 页:1 `tokens` 命令打印; 参见 [导出](https://github.com/k35o/better-css-modules#token-export)。 。 。 .
-   `formatDiagnostic(diagnostic, cwd)` 给 `file:line:col error rule: message` cLI线,以及 `formatGitHubAnnotation(diagnostic, cwd)` gitHub 动作工作流程命令 `--format github`。 。 。 .
-   `ConfigError` 是在配置或它命名的文件中的错误. `loadConfig` 抛出它,同样 `check` 何时 `include` 匹配无文件, 无法读取全局 CSS, 或者它不声明 `layer`,以及 `exportTokens` 当全球 CSS 无法读取,或者一个符号有一个名称 DTCG 无法持有时.
-   类型 `Config`, (中文(简体) ), `ResolvedConfig`, (中文(简体) ), `GenerateResult`, (中文(简体) ), `CheckResult`, (中文(简体) ), `Diagnostic`, (中文(简体) ), `RuleId`, (中文(简体) ), `DtcgResolver` 财务报告和审定财务报表 `DtcgToken` 描述这些.

`@better-css-modules/core/internal` 持有 CLI 和插件共享 。 它只用于这些包 和外铸.

规则 `check` 报告在下文 [项目README](https://github.com/k35o/better-css-modules#rules)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @better-css-modules/core 是什么？

分析、类型生成、未使用的级检测、代号检查、监视器和更好cs-模块配置

### 如何安装 @better-css-modules/core？

在项目目录运行 npm install @better-css-modules/core，或使用 pnpm add / yarn add / bun add。

### @better-css-modules/core 支持 TypeScript 吗？

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

### @better-css-modules/core 支持 ESM 还是 CommonJS？

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

### @better-css-modules/core 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @better-css-modules/core 可以商用吗？

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

### @better-css-modules/core 的下载量有多少？

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

### @better-css-modules/core 还在维护吗？

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