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

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

安装

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

配置文件

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

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

defineConfig 返回当前配置并输入。 设置在 项目README。 。 。 .

API 密码

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 命令打印; 参见 导出。 。 。 .
• 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。 。 。 .

许可证

麻省理工学院