문제
디자인 규칙이 올바른 CSS를 거부한다. 포커스 대비 규칙의 parseOklch는
색상각 단위 deg와 음수 색상각을 읽지 못해 oklch(52% 0.15 230deg)를 실패로
센다(B13). 첫 글꼴 규칙은 -apple-system, BlinkMacSystemFont로 시작하는
시스템 글꼴 스택을 실패로 센다(B6). color-mix()·알파 표면(B10, B11)은
"--color-focus or X is not a plain oklch() value"로 실패해서 어느 토큰이
무슨 값인지, 무엇이면 되는지 알 수 없다. 네 규칙의 설명은 코드 주석에만
있다.
고른 방법
- parseOklch가 색상각에 deg와 음수를 받는다. 알파는 계속 받지 않는다.
- oklch-contrast.ts에 resolveValue(var() 사슬 끝 값)를 두고 resolveColor가
그것을 쓴다. 포커스 규칙은 계산할 수 없는 토큰마다 "<테마> <토큰> is
<값>; contrast needs an opaque oklch(L C H), hue in degrees with or
without deg"를 낸다. 포커스 색 자체를 못 읽으면 표면 8개 대신 한 줄이다.
- 첫 글꼴 허용 목록에 -apple-system, BlinkMacSystemFont를 더한다.
- docs/styling/design-system-platform.md 4.1절에 규칙 4개, 지원 형식,
검사 위치를 표 하나로 적는다.
버린 대안
- color-mix()·알파 표면을 배경 위에 섞어 계산: 무엇이 아래에 그려지는지
규칙이 모른다. 추측하지 않고 실패하는 기존 원칙을 유지하고 메시지로
해결 형식을 알린다(리뷰 대안 비교와 같다).
- 리뷰 개선 (4) token-contract.ts에 "제품이 싣는 글꼴" 목록: 공개 계약에
새 이름을 넣는 설계 선택이고 완료 기준에 없다. 문서 표에 "아직 선언할
곳이 없어 실패한다"로 적었다.
- rad·grad·turn 단위: 쓰는 곳이 없다. 넣지 않은 단위는 메시지가 알려 준다.
위험·한계
- 실패 메시지 문구가 바뀐다. 문구를 단언하는 곳은 이 테스트 파일뿐이다.
- 패키지·<link>로 싣는 글꼴, 12-03의 검사 위치 밖 CSS는 그대로다.
- 화면 변화 없음. CSS를 바꾸지 않았다.
검증
- RED(수정 전): design-system-rules·oklch-contrast 테스트 19개 중 4개
실패. "reads a hue written with deg" expected [ …(8) ] to deeply equal [],
"names the value it cannot compute …" 메시지 불일치, "-apple-system"
expected [ Array(1) ] to deeply equal [], parseOklch("…230deg") expected
null.
- GREEN: 같은 두 파일과 design-system-contract 21/21 통과. 실제 스크립트
probe: 포커스를 oklch(52% 0.15 230deg)로 → PASS(B13). surface-muted를
oklch(0.97 0 0 / 0.9)로 → "light --color-surface-muted is oklch(0.97 0 0
/ 0.9); contrast needs …"로 실패(B11). 저장소 CSS는 PASS.
- tsc(tsconfig.node, tsconfig.test), 바꾼 파일 eslint, verify-
documentation-readiness PASS_SCOPED.
Refs: docs/reviews/2026-11-01-maturity-review/12-guardrails-ci.md 12-04
182 lines
7.7 KiB
TypeScript
182 lines
7.7 KiB
TypeScript
import { spawnSync } from "node:child_process";
|
|
import { cp, mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
|
|
import { describe, expect, it } from "vitest";
|
|
|
|
import {
|
|
FOCUS_RING_BACKGROUNDS,
|
|
firstFontFamilyFailures,
|
|
focusContrastFailures,
|
|
hueMixFailures,
|
|
unreadTokenFailures,
|
|
} from "../../scripts/lib/design-system-rules.ts";
|
|
|
|
const css = (source: string) => ({ file: "probe.css", source });
|
|
|
|
describe("design system rules", () => {
|
|
describe("UI-01 focus ring contrast", () => {
|
|
const tokens = (focus: string) =>
|
|
new Map([
|
|
...FOCUS_RING_BACKGROUNDS.map((surface) => [surface, "oklch(1 0 0)"] as const),
|
|
["--color-focus", focus],
|
|
]);
|
|
|
|
it("fails a focus colour below 3:1 against a surface", () => {
|
|
// The light focus ring before UI-01.
|
|
expect(focusContrastFailures("light", tokens("oklch(0.72 0.16 225)"))).toContainEqual(
|
|
expect.stringMatching(/^light --color-focus contrast 2\.\d\d:1 against --color-panel is below 3:1$/),
|
|
);
|
|
});
|
|
|
|
it("passes a focus colour at 3:1 or more on every surface", () => {
|
|
expect(focusContrastFailures("light", tokens("oklch(0.52 0.15 230)"))).toEqual([]);
|
|
});
|
|
|
|
// 12-04 B13: CSS allows a hue angle with its unit.
|
|
it("reads a hue written with deg", () => {
|
|
expect(focusContrastFailures("light", tokens("oklch(52% 0.15 230deg)"))).toEqual([]);
|
|
});
|
|
|
|
// 12-04 B10, B11: still refused, but the message names the token, its
|
|
// value and the one form the rule can compute.
|
|
it("names the value it cannot compute and the form it can", () => {
|
|
const properties = new Map([
|
|
...tokens("oklch(0.52 0.15 230)"),
|
|
["--color-panel", "color-mix(in oklab, var(--color-surface) 92%, black)"],
|
|
["--color-info-surface", "oklch(0.97 0.02 230 / 0.9)"],
|
|
]);
|
|
const supported = "contrast needs an opaque oklch(L C H), hue in degrees with or without deg";
|
|
expect(focusContrastFailures("light", properties)).toEqual([
|
|
`light --color-panel is color-mix(in oklab, var(--color-surface) 92%, black); ${supported}`,
|
|
`light --color-info-surface is oklch(0.97 0.02 230 / 0.9); ${supported}`,
|
|
]);
|
|
});
|
|
});
|
|
|
|
describe("UI-02 colour mixing space", () => {
|
|
it("fails a hue-based mixing space", () => {
|
|
expect(hueMixFailures(css("a { color: color-mix(in oklch, red, blue); }"))).toEqual([
|
|
"probe.css mixes colours in oklch; use oklab",
|
|
]);
|
|
});
|
|
|
|
it("fails it in upper case, since CSS keywords ignore case", () => {
|
|
expect(hueMixFailures(css("a { color: COLOR-MIX(in OKLCH, red, blue); }"))).toEqual([
|
|
"probe.css mixes colours in OKLCH; use oklab",
|
|
]);
|
|
});
|
|
|
|
it("passes oklab, and old code left in a comment", () => {
|
|
expect(
|
|
hueMixFailures(
|
|
css("/* was color-mix(in oklch, red, blue) */ a { color: color-mix(in oklab, red, blue); }"),
|
|
),
|
|
).toEqual([]);
|
|
});
|
|
});
|
|
|
|
describe("UI-03 component token readers", () => {
|
|
const tokens = ["--field-border", "--field-border-invalid"];
|
|
|
|
// 12-01: "var(--field-border" is also the start of
|
|
// "var(--field-border-invalid)".
|
|
it("does not count a longer token that starts with the same name", () => {
|
|
expect(
|
|
unreadTokenFailures(tokens, [css("a { border-color: var(--field-border-invalid); }")]),
|
|
).toEqual(["component token --field-border is defined but no style reads it"]);
|
|
});
|
|
|
|
it("counts var(--x) and var(--x, fallback), with any case for var", () => {
|
|
for (const source of [
|
|
"a { border-color: var(--field-border); }",
|
|
"a { border: 1px solid VAR( --field-border , red); }",
|
|
]) {
|
|
expect(unreadTokenFailures(["--field-border"], [css(source)])).toEqual([]);
|
|
}
|
|
});
|
|
|
|
it("does not count a name in another case, since custom properties are case-sensitive", () => {
|
|
expect(unreadTokenFailures(["--field-border"], [css("a { color: var(--Field-Border); }")]))
|
|
.toEqual(["component token --field-border is defined but no style reads it"]);
|
|
});
|
|
|
|
it("does not count a read inside a comment", () => {
|
|
expect(unreadTokenFailures(["--field-border"], [css("/* var(--field-border) */")])).toEqual([
|
|
"component token --field-border is defined but no style reads it",
|
|
]);
|
|
});
|
|
});
|
|
|
|
describe("UI-05 first font family", () => {
|
|
it("fails a named font that nothing loads", () => {
|
|
expect(firstFontFamilyFailures("Inter, system-ui, sans-serif", [])).toEqual([
|
|
'--font-sans starts with "Inter", which is neither a generic family nor loaded by @font-face',
|
|
]);
|
|
});
|
|
|
|
it("passes a generic family, or a family loaded by @font-face", () => {
|
|
expect(firstFontFamilyFailures("system-ui, sans-serif", [])).toEqual([]);
|
|
// 12-04 B6: the WebKit and Blink names for the system font.
|
|
expect(firstFontFamilyFailures("-apple-system, BlinkMacSystemFont, system-ui", []))
|
|
.toEqual([]);
|
|
expect(firstFontFamilyFailures("BlinkMacSystemFont, system-ui", [])).toEqual([]);
|
|
expect(
|
|
firstFontFamilyFailures('"Brand Sans", sans-serif', [
|
|
css('@font-face { font-family: "Brand Sans"; src: url(brand.woff2); }'),
|
|
]),
|
|
).toEqual([]);
|
|
});
|
|
});
|
|
|
|
// 12-02: the cases above test the rule functions. This one tests that
|
|
// check:design-system still calls each of them on the token files and
|
|
// styles/**: drop a call from the script and it fails here, while the
|
|
// repository CSS keeps passing the gate.
|
|
it("check-design-system.ts reports one violation per rule in a copy of the CSS", async () => {
|
|
const root = await mkdtemp(path.join(tmpdir(), "design-system-rules-"));
|
|
try {
|
|
for (const folder of ["src/presentation/design-system/tokens", "src/presentation/styles"]) {
|
|
await cp(folder, path.join(root, folder), { recursive: true });
|
|
}
|
|
const edit = async (file: string, from: string | RegExp, to: string) => {
|
|
const target = path.join(root, file);
|
|
const source = await readFile(target, "utf8");
|
|
const edited = source.replace(from, to);
|
|
if (edited === source) throw new Error(`${String(from)} not found in ${file}`);
|
|
await writeFile(target, edited);
|
|
};
|
|
const semantic = "src/presentation/design-system/tokens/semantic.css";
|
|
await edit(semantic, /--color-focus: [^;]+;/, "--color-focus: oklch(0.72 0.16 225);");
|
|
await edit(semantic, "--font-sans: ", "--font-sans: Inter, ");
|
|
await edit("src/presentation/styles/theme/primitives.css", "var(--drawer-width)", "20rem");
|
|
await writeFile(
|
|
path.join(root, "src/presentation/styles/theme/probe.css"),
|
|
".probe { color: color-mix(in oklch, red, blue); }\n",
|
|
);
|
|
|
|
const result = spawnSync(process.execPath, [path.resolve("scripts/check-design-system.ts")], {
|
|
cwd: root,
|
|
encoding: "utf8",
|
|
});
|
|
expect(result.status, result.stderr).toBe(1);
|
|
const { failures } = JSON.parse(
|
|
await readFile(path.join(root, "artifacts/quality/design-system.json"), "utf8"),
|
|
) as { failures: string[] };
|
|
const rules = [
|
|
/^light --color-focus contrast \d\.\d\d:1 against --color-[a-z-]+ is below 3:1$/,
|
|
/^src\/presentation\/styles\/theme\/probe\.css mixes colours in oklch; use oklab$/,
|
|
/^component token --drawer-width is defined but no style reads it$/,
|
|
/^--font-sans starts with "Inter", which is neither a generic family nor loaded by @font-face$/,
|
|
];
|
|
expect(failures.filter((failure) => !rules.some((rule) => rule.test(failure)))).toEqual([]);
|
|
for (const rule of rules) {
|
|
expect(failures, String(rule)).toContainEqual(expect.stringMatching(rule));
|
|
}
|
|
} finally {
|
|
await rm(root, { recursive: true, force: true });
|
|
}
|
|
});
|
|
});
|