c3b-lint 0.0.5 → 0.0.7

package/README.md

@@ -21,8 +21,10 @@ markdown that a tool can check, with one command and one config to install. It r
    (except a JS-driven custom property), relative paths only, kebab-case ids and classes, no duplicate ids,
    `integrity` on CDN scripts.
 5. **Project structure**: singular directory names, lowercase kebab-case asset names (and no camera exports), and,
-   when `src/` holds pages, CSS only in `src/style/` + `style/page/` + `style/animation/`, JS only in `src/script/`,
-   fonts only in `src/asset/font/` as woff2, file names starting with a letter.
+   when `src/` holds pages, CSS only in `src/style/` + `style/page/` + `style/animation/`, JS only in `src/script/`
+   (an experiment under `src/experiment/<name>/` keeps its own beside its `index.html`), fonts only in
+   `src/asset/font/` as woff2, file names starting with a letter. A directory whose plural-looking name is a proper
+   name (a client's brand) is listed in `package.json` under `"c3b-lint": { "singularDirectories": [...] }`.
 6. The **500-line limit** on `src/**/*.{css,html}` (ESLint reports the JS).
 7. That the project's **`.editorconfig`** is the shared one — it carries the JetBrains `ij_*` code-style keys, so
    WebStorm and IntelliJ format the same way without committing `.idea/`.

package/check/css-tokens.js

@@ -84,7 +84,9 @@ export function checkCssTokens(report) {
             // spacing property (a 24px icon is not --spacing-lg, a 16px font size is not --spacing-md)
             const exact = normalise(value);
             const lengthLike = /^-?\d/.test(exact);
-            if (byValue.has(exact) && !decl.prop.startsWith('--') && (!lengthLike || SPACING_PROPERTIES.test(decl.prop))) {
+            // zero and keywords are not "the token's value" even when a token happens to hold them
+            const trivial = /^(0|0px|none|auto|inherit|initial|transparent|currentcolor)$/.test(exact);
+            if (byValue.has(exact) && !trivial && !decl.prop.startsWith('--') && (!lengthLike || SPACING_PROPERTIES.test(decl.prop))) {
                 report.error(`${ file }:${ where.line }`, `${ decl.value } duplicates ${ byValue.get(exact) } — use var(${ byValue.get(exact) })`);
             }
 
@@ -96,7 +98,8 @@ export function checkCssTokens(report) {
                     add(colours, colour, where);
                 }
             }
-            if (decl.prop === 'font-family' && !/var\(/.test(value)) {
+            // a keyword (inherit, initial, unset, revert) is not a font literal
+            if (decl.prop === 'font-family' && !/var\(/.test(value) && !/^(inherit|initial|unset|revert|revert-layer)$/.test(exact)) {
                 add(fonts, exact, where);
             }
             if (SPACING_PROPERTIES.test(decl.prop) && !/var\(|calc\(|%|auto|^0$/.test(value)) {

package/check/html.js

@@ -118,9 +118,11 @@ function checkPage(report, file, source) {
     if (names.slice(0, expectedStart.length).join() !== expectedStart.join()) {
         report.error(at(sheets[0].el), `stylesheets start with ${ STYLE_ORDER.join(', ') } in that order`);
     }
+    // page stylesheets (style/page/*.css, one or more) come after every shared one
     const pageIndex = sheets.findIndex((s) => /\/page\//.test(s.href));
-    if (pageIndex !== -1 && pageIndex !== sheets.length - 1) {
-        report.error(at(sheets[pageIndex].el), 'the page stylesheet is linked last');
+    const sharedAfter = sheets.findIndex((s, i) => i > pageIndex && pageIndex !== -1 && !/\/page\//.test(s.href));
+    if (sharedAfter !== -1) {
+        report.error(at(sheets[sharedAfter].el), 'the page stylesheets are linked last');
     }
 
     // --- skip link and main

package/check/structure.js

@@ -1,4 +1,4 @@
-import { existsSync, globSync, readdirSync, statSync } from 'fs';
+import { existsSync, globSync, readdirSync, readFileSync, statSync } from 'fs';
 import { basename, dirname, sep } from 'path';
 
 // The project-structure rules from general.md and frontend.md: singular directory names, kebab-case
@@ -8,13 +8,27 @@ const SKIP_DIRS = new Set(['node_modules', '.git', 'dist', 'c10g', '.llm-rules',
 // Words that end in s but are not plurals, or that are plural by convention outside our control
 const SINGULAR_ENDING_IN_S = new Set(['css', 'js', 'canvas', 'status', 'news', 'gl', 'lens', 'bus', 'analysis', 'ios', 'macos', 'assets']);
 const ASSET_NAME = /^[a-z0-9]+(-[a-z0-9]+)*(\.[a-z0-9]+)+$/;
-const CSS_HOMES = [/^src\/style\/[a-z0-9-]+\.css$/, /^src\/style\/page\/[a-z][a-z0-9-]*\.css$/, /^src\/style\/animation\/[a-z][a-z0-9-]*\.css$/];
-const JS_HOMES = [/^src\/script\/([a-z0-9-]+\/)*[a-z][a-z0-9-]*\.js$/, /^src\/gl\//];
+const CSS_HOMES = [/^src\/style\/[a-z0-9-]+\.css$/, /^src\/style\/page\/[a-z][a-z0-9.-]*\.css$/, /^src\/style\/animation\/[a-z][a-z0-9.-]*\.css$/];
+// an experiment (src/experiment/<name>/) is self-contained: its own JS and CSS sit beside its index.html
+const JS_HOMES = [/^src\/script\/([a-z0-9-]+\/)*[a-z][a-z0-9.-]*\.js$/, /^src\/gl\//, /^src\/experiment\//];
+const CSS_HOMES_EXTRA = [/^src\/experiment\//];
 
 const toPosix = (p) => p.split(sep).join('/');
 
+// A project names the plural-looking directories that are proper names (a client's brand, an
+// experiment's title) in package.json: "c3b-lint": { "singularDirectories": ["mannequin-films"] }
+function readAllowedDirectories() {
+    try {
+        const pkg = JSON.parse(readFileSync('package.json', 'utf8'));
+
+        return new Set(pkg['c3b-lint']?.singularDirectories ?? []);
+    } catch (error) {
+        return new Set();
+    }
+}
+
 export function checkStructure(report) {
-    checkDirectoryNames(report, '.');
+    checkDirectoryNames(report, '.', readAllowedDirectories());
     checkAssetNames(report);
     checkFileHomes(report);
 }
@@ -22,9 +36,9 @@ export function checkStructure(report) {
 // Every directory, root included, is singular: component/ not components/. "assets" is in the
 // exception list only because it is a common name for a dir that should be asset/ — it is reported
 // separately below, with the rename.
-function checkDirectoryNames(report, dir) {
+function checkDirectoryNames(report, dir, allowed) {
     for (const entry of readdirSync(dir)) {
-        if (SKIP_DIRS.has(entry) || entry.startsWith('.')) {
+        if (SKIP_DIRS.has(entry) || entry.startsWith('.') || allowed.has(entry)) {
             continue;
         }
         const path = dir === '.' ? entry : `${ dir }/${ entry }`;
@@ -34,9 +48,9 @@ function checkDirectoryNames(report, dir) {
         if (entry === 'assets' || entry === 'images' || entry === 'scripts' || entry === 'styles') {
             report.error(path + '/', `directories are singular — rename to ${ entry.slice(0, -1) }/`);
         } else if (/[a-z]s$/.test(entry) && !/ss$/.test(entry) && !SINGULAR_ENDING_IN_S.has(entry)) {
-            report.error(path + '/', `directories are singular — rename to ${ entry.slice(0, -1) }/ (or add it to the exceptions in c3b-lint if it is not a plural)`);
+            report.error(path + '/', `directories are singular — rename to ${ entry.slice(0, -1) }/ (a proper name goes in package.json "c3b-lint".singularDirectories)`);
         }
-        checkDirectoryNames(report, path);
+        checkDirectoryNames(report, path, allowed);
     }
 }
 
@@ -73,7 +87,7 @@ function checkFileHomes(report) {
         if (/^\d/.test(basename(file))) {
             report.error(file, 'file names start with a letter, never a digit');
         }
-        if (file.endsWith('.css') && !CSS_HOMES.some((home) => home.test(file))) {
+        if (file.endsWith('.css') && ![...CSS_HOMES, ...CSS_HOMES_EXTRA].some((home) => home.test(file))) {
             report.error(file, 'CSS lives in src/style/ (shared), src/style/page/ (one per page) or src/style/animation/');
         } else if (file.endsWith('.js') && !JS_HOMES.some((home) => home.test(file))) {
             report.error(file, 'JS lives in src/script/');

package/config/eslint.config.js

@@ -30,7 +30,7 @@ export const browser = {
     languageOptions: {
         ecmaVersion: 2024,
         sourceType: 'script',
-        globals: { ...globals.browser, App: 'writable', ColabClient: 'readonly' },
+        globals: { ...globals.browser, HTMLCanvasElement: 'readonly', App: 'writable', ColabClient: 'readonly' },
     },
     rules: {
         ...js.configs.recommended.rules,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c3b-lint",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Lints a co:lab project against the rules a tool can check: ESLint, Stylelint, the 500-line limit and the shared .editorconfig; --init writes the config files.",
   "license": "GPL-3.0",
   "type": "module",