# CSS ## Description CSS 模块提供围绕 CSS 类名集合（class set）的表达、转换和组合能力，用于在字符串、数组、对象三种常见表示之间建立稳定、可解释且可组合的公共语义。 它关注的不是样式体系本身，而是“类名集合如何被表达和变换”。对象表示除了能表达已启用类名，还可以显式保留值为 `false` 的键，以承载“已知但未启用”的状态。 ## For Understanding 理解 CSS 模块时，应把它看成“类名集合模型”，而不是“字符串拼接工具”。这个模块要解决的是不同输入形态之间的语义对齐问题：同一组类名可能来自 `.foo.bar`、`foo bar`、`["foo", "bar"]` 或 `{ foo: true, bar: false }`，进入系统后，应尽快被整理成清楚、稳定、可继续变换的集合语义。 三种表示的语义并不完全相同： - 字符串与数组主要表达“当前启用中的类名集合”。 - 对象既能表达启用状态，也能保留值为 `false` 的键，从而表达“已知但未启用”的状态信息。 - 空类名本身不承载有效样式语义，应在公共转换路径中尽早过滤。 因此，这个模块追求的不是机械的完全可逆，而是转换结果为什么会这样始终容易解释。如果某个转换会丢失对象中 `false` 键这类附加状态，那是表示层语义差异，而不是实现缺陷。 ## For Using 当应用需要在组件层、渲染层、样式工具层之间传递类名集合时，可以使用这个模块统一管理类名表达，而不是在调用点反复手写拆分、拼接、去重和真假值过滤。 当前公共能力大致可以按以下几类理解： - 类名表示类型：用于区分 `ClassString`、`ClassArray`、`ClassObject` 以及三者联合的输入形态。 - 表示间转换：用于在字符串、数组、对象之间显式切换，并根据目标表示保留其应有语义。 - 统一归一化：用于把混合输入整理成某一种稳定目标表示，减少下游接口摩擦。 - 前缀处理：用于给类名补前缀、移除前缀，适合组件库或命名空间约定场景。 - 集合操作：用于添加、移除、切换、替换、判断是否包含某组类名。 这个模块不适合承载样式命名规范、主题系统、选择器优先级策略或任何特定框架的样式约定。它只负责类名集合语义，不负责更高层的样式设计决策。 ## For Contributing 贡献 CSS 模块时，应优先判断新增能力是否真正表达了稳定的类名集合语义，而不是某个框架、某个模板语法或某种局部命名习惯的便捷包装。只有前者才适合作为长期公共 API。 在扩展时，应优先遵守以下边界： - 公共能力应围绕类名集合的表达、转换、组合和集合操作展开。 - 不要把具体框架的模板语法、渲染约定或样式系统规则直接写入模块公共语义。 - 表示之间的转换应优先保证结果可解释，而不是追求表面上的完全可逆。 - 对象表示中的 `false` 键是有意义的显式状态；字符串与数组表示则只表达启用中的类名。 ### JSDoc 注释格式要求 - 每个公开导出的目标（类型、函数、变量、类等）都应包含 JSDoc 注释，让人在不跳转实现的情况下就能理解用途。 - JSDoc 注释第一行应为清晰且简洁的描述，该描述优先使用中文（英文也可以）。 - 如果描述后还有其他内容，应在描述后加一个空行。 - 如果有示例，应使用 `@example` 标签，后接三重反引号代码块（不带语言标识）。 - 如果有示例，应包含多个场景，展示不同用法，尤其要覆盖常见组合方式或边界输入。 - 如果有示例，应使用注释格式说明每个场景：`// Expect: `。 - 如果有示例，应将结果赋值给 `example1`、`example2` 之类的变量，以保持示例易读。 - 如果有示例，`// Expect: ` 应该位于 `example1`、`example2` 之前，以保持示例的逻辑清晰。 - 如果有示例，应优先使用确定性示例；避免断言精确的随机输出。 - 如果函数返回结构化字符串，应展示其预期格式特征。 - 如果有参考资料，应将 `@see` 放在 `@example` 代码块之后，并用一个空行分隔。 ### 实现规范要求 - 不同程序元素之间使用一个空行分隔，保持结构清楚。这里的程序元素，通常指函数、类型、常量，以及直接服务于它们的辅助元素。 - 某程序元素独占的辅助元素与该程序元素本身视为一个整体，不要在它们之间添加空行。 - 程序元素的辅助元素应该放置在该程序元素的上方，以保持阅读时的逻辑顺序。 - 若辅助元素被多个程序元素共享，则应将其视为独立的程序元素，放在这些程序元素中第一个相关目标的上方，并与后续程序元素之间保留一个空行。 - 辅助元素也应该像其它程序元素一样，保持清晰的命名和适当的注释，以便在需要阅读实现细节时能够快速理解它们的作用和使用方式。 - 辅助元素的命名必须以前缀 `internal` 开头（或 `Internal`，大小写不敏感）。 - 辅助元素永远不要公开导出。 - 被模块内多个不同文件中的程序元素共享的辅助元素，应该放在一个单独的文件中，例如 `./src/css/internal.ts`；若当前没有必要，不必为了形式强行拆分。 - 模块内可以包含子模块。只有当某个子目录表达一个稳定、可单独理解、且可能被父模块重导出的子问题域时，才应将其视为子模块。 - 子模块包含多个文件时，应该为其单独创建子文件夹，并为其创建单独的 Barrel 文件；父模块的 Barrel 文件再重导出子模块的 Barrel 文件。 - 子模块不需要有自己的 `README.md`。 - 子模块可以有自己的 `internal.ts` 文件，多个子模块共享的辅助元素应该放在父模块的 `internal.ts` 文件中，单个子模块共享的辅助元素应该放在该子模块的 `internal.ts` 文件中。 - 对模块依赖关系的要求（通常是不循环依赖或不反向依赖）与对 DRY 的要求可能产生冲突。此时，若复用的代码数量不大，可以适当牺牲 DRY，复制粘贴并保留必要的注释说明；若复用的代码数量较大，则可以将其抽象到新的文件或子模块中，如 `common.ts`，并在需要的地方导入使用。 - 涉及字符串解析、空白规整、点号分隔、真假值过滤等规则时，应让行为保持直白、可预测，而不要让调用方猜测隐含规范。 ### 导出策略要求 - 保持内部辅助项和内部符号为私有，不要让外部接入依赖临时性的内部结构。 - 每个模块都应有一个用于重导出所有公共 API 的 Barrel 文件。 - Barrel 文件应命名为 `index.ts`，放在模块目录根部，并且所有公共 API 都应从该文件导出。 - 新增公共能力时，应优先检查它是否表达稳定、清楚且值得长期维护的类名集合语义，而不是某段实现细节的便捷暴露；仅在确认需要长期对外承诺时再加入 Barrel 导出。 ### 测试要求 - 若程序元素是函数，则只为该函数编写一个测试，如果该函数需要测试多个用例，应放在同一个测试中。 - 若程序元素是类，则至少要为该类的每一个方法编写一个测试，如果该方法需要测试多个用例，应放在同一个测试中。 - 若程序元素是类，除了为该类的每一个方法编写至少一个测试之外，还可以为该类编写任意多个测试，以覆盖该类的不同使用场景或边界情况。 - 若编写测试时需要用到辅助元素（Mock 或 Spy 等），可以在测试文件中直接定义这些辅助元素。若辅助元素较为简单，则可以直接放在每一个测试内部，优先保证每个测试的独立性，而不是追求极致 DRY；若辅助元素较为复杂或需要在多个测试中复用，则可以放在测试文件顶部，供该测试文件中的所有测试使用。 - 测试顺序应与源文件中被测试目标的原始顺序保持一致。 - 若该模块不需要测试，必须在说明文件中明确说明该模块不需要测试，并说明理由。一般来说，只有在该模块没有可执行的公共函数、只承载类型层表达，或其语义已被上层模块的测试完整覆盖且重复测试几乎不再带来额外价值时，才适合这样处理。 - 模块的单元测试文件目录是 `./tests/unit/css`，若模块包含子模块，则子模块的单元测试文件目录为 `./tests/unit/css/`。 - 测试应重点覆盖三种表示之间的语义差异，尤其是空类名过滤、对象 `false` 键保留与集合操作结果是否可解释。