c3b-lint 0.0.8 → 0.0.10

package/README.md

@@ -15,7 +15,8 @@ markdown that a tool can check, with one command and one config to install. It r
    rules (that is a token by definition), and a token nothing uses (CSS `var()`, or JS/HTML by name).
 4. **HTML** on every page under `src/` (partials are skipped): doctype, `lang`, charset, viewport without
    `user-scalable=no`, the required head set (title, description, absolute canonical, `og:*` with an absolute
-   `og:image`, `twitter:card`, one SVG favicon; a `noindex` page is excused the canonical and social tags), no external stylesheets (webfonts are self-hosted), stylesheet order (`reset`, `tokens`, `main`, …, page file last),
+   `og:image`, `twitter:card`, one SVG favicon; a `noindex` page is excused the canonical and social tags), no external
+   stylesheets (webfonts are self-hosted), stylesheet order (`reset`, `tokens`, `main`, …, page file last),
    the skip-link rule (`<a id="skip-link" href="#main">` first in `<body>` when there is a header or nav, absent
    otherwise, `<main id="main">`), one `<h1>`, `alt` on every image, no inline handlers, no `<style>` or `style=""`
    (except a JS-driven custom property), relative paths only, kebab-case ids and classes, no duplicate ids,
@@ -46,7 +47,8 @@ npx c3b-lint --init
 
 - `.editorconfig` — the shared one (a copy; editors need a real file).
 - `eslint.config.js` and `stylelint.config.js` — one line each, re-exporting this package's configs, so WebStorm
-  shows the same errors inline as the CLI reports. Bumping `c3b-lint` changes the rules everywhere.
+  shows the same errors inline as the CLI reports. Bumping `c3b-lint` changes the rules everywhere. Written only
+  when missing: a project that has extended its config keeps it.
 - `.githooks/pre-commit`, and `git config core.hooksPath .githooks` — the lint runs before every commit, so a
   commit that fails it never lands, whoever makes it. The hook lives in the repo, so after a clone one `--init`
   (or `npx c3b-lint --init` in `postinstall`) wires it up. If `node_modules` is missing it says so and lets the

package/c3b-lint.js

@@ -37,6 +37,7 @@ function configFor(file) {
 
     return join(CONFIG_DIR, file);
 }
+
 const MAX_LINES = 500;
 
 // Files --init writes at the project root. The .editorconfig is a copy (it has to be a real
@@ -44,14 +45,14 @@ const MAX_LINES = 500;
 // c3b-lint changes the rules everywhere without touching projects.
 const BASELINE = {
     '.editorconfig': readFileSync(join(CONFIG_DIR, 'editorconfig'), 'utf8'),
-    'eslint.config.js': "export { default } from 'c3b-lint/config/eslint.config.js';\n",
-    'stylelint.config.js': "export { default } from 'c3b-lint/config/stylelint.config.js';\n",
+    'eslint.config.js': 'export { default } from \'c3b-lint/config/eslint.config.js\';\n',
+    'stylelint.config.js': 'export { default } from \'c3b-lint/config/stylelint.config.js\';\n'
 };
 
 const FLAGS = {
     '--fix': 'apply the ESLint and Stylelint fixes that are safe to apply automatically',
     '--init': 'write .editorconfig, eslint.config.js, stylelint.config.js and the pre-commit hook',
-    '--help': 'print this help',
+    '--help': 'print this help'
 };
 
 function usage() {
@@ -96,6 +97,11 @@ function writeBaseline() {
         if (existsSync(path) && readFileSync(path, 'utf8') === content) {
             continue;
         }
+        // a lint config the project has extended (c10g's librarySrc, colab-client's exceptions) is its own:
+        // only the .editorconfig is kept in step with the shared one
+        if (file.endsWith('.js') && existsSync(path)) {
+            continue;
+        }
         // a project keeping a .mjs config (not "type": "module") has made its choice
         if (file.endsWith('.js') && existsSync(path.replace(/\.js$/, '.mjs'))) {
             continue;
@@ -177,7 +183,7 @@ async function runStylelint() {
         config,
         configBasedir: process.cwd(),
         fix,
-        formatter: 'string',
+        formatter: 'string'
     });
     const output = result.report ?? result.output;
     if (output.trim()) {
@@ -199,11 +205,29 @@ async function main() {
         return;
     }
 
+    const started = performance.now();
+    const timings = [];
+    // Runs one check and records how long it took, so a slow run says where the time went
+    const timed = async (name, check) => {
+        const before = performance.now();
+        const result = await check();
+        timings.push(`  ${ name.padEnd(13) }${ Math.round(performance.now() - before) }ms`);
+
+        return result;
+    };
+
     const report = createReport();
-    checkStructure(report);
-    checkHtml(report);
-    checkCssTokens(report);
-    const errors = checkEditorconfig() + checkFileLengths() + report.errors + await runEslint() + await runStylelint();
+    await timed('structure', () => checkStructure(report));
+    await timed('html', () => checkHtml(report));
+    await timed('tokens', () => checkCssTokens(report));
+    let errors = report.errors;
+    errors += await timed('editorconfig', () => checkEditorconfig());
+    errors += await timed('lengths', () => checkFileLengths());
+    errors += await timed('eslint', () => runEslint());
+    errors += await timed('stylelint', () => runStylelint());
+
+    console.log(timings.join('\n'));
+    console.log(`  ${ 'total'.padEnd(13) }${ Math.round(performance.now() - started) }ms`);
     if (errors > 0) {
         fail(`${ errors } error(s)`);
     }

package/check/css-tokens.js

@@ -89,8 +89,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);
-            // 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);
+            // zero, keywords and a var() reference are not "the token's value" even when a token (an alias
+            // like --color-icon-border: var(--color-border)) happens to hold them
+            const trivial = /^(0|0px|none|auto|inherit|initial|transparent|currentcolor)$/.test(exact) || /var\(/.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) })`);
             }

package/check/hook.js

@@ -26,7 +26,10 @@ export function installHook(log) {
 
     if (existsSync('.git')) {
         try {
-            const current = execFileSync('git', ['config', '--get', 'core.hooksPath'], { encoding: 'utf8', stdio: 'pipe' }).trim();
+            const current = execFileSync('git', ['config', '--get', 'core.hooksPath'], {
+                encoding: 'utf8',
+                stdio: 'pipe'
+            }).trim();
             if (current === '.githooks') {
                 return;
             }

package/check/html.js

@@ -18,7 +18,7 @@ const REQUIRED_META = [
     ['og:url', (el) => el.name === 'meta' && attr(el, 'property') === 'og:url'],
     ['og:image', (el) => el.name === 'meta' && attr(el, 'property') === 'og:image'],
     ['twitter:card', (el) => el.name === 'meta' && attr(el, 'name') === 'twitter:card'],
-    ['favicon link[rel=icon]', (el) => el.name === 'link' && attr(el, 'rel') === 'icon'],
+    ['favicon link[rel=icon]', (el) => el.name === 'link' && attr(el, 'rel') === 'icon']
 ];
 
 const toPosix = (p) => p.split(sep).join('/');
@@ -44,7 +44,7 @@ const children = (el) => (el.childNodes ?? []).filter(isElement);
 
 export function checkHtml(report) {
     const files = globSync('src/**/*.html').map(toPosix)
-        .filter((f) => !f.startsWith('src/partial/') && !f.includes('/vendor/')).sort();
+            .filter((f) => !f.startsWith('src/partial/') && !f.includes('/vendor/')).sort();
     for (const file of files) {
         checkPage(report, file, readFileSync(file, 'utf8'));
     }
@@ -112,7 +112,7 @@ function checkPage(report, file, source) {
 
     // --- stylesheet link order: reset, tokens, main, components, page file last
     const allSheets = headEls.filter((el) => el.name === 'link' && attr(el, 'rel') === 'stylesheet')
-        .map((el) => ({ el, href: attr(el, 'href') ?? '' }));
+            .map((el) => ({ el, href: attr(el, 'href') ?? '' }));
     // frontend.md: webfonts are self-hosted woff2 in src/asset/font/; no stylesheet comes from another origin
     for (const sheet of allSheets.filter((s) => /^(https?:)?\/\//.test(s.href))) {
         report.error(at(sheet.el), `external stylesheet ${ sheet.href } — self-host it (fonts as woff2 in src/asset/font/)`);

package/check/report.js

@@ -18,6 +18,6 @@ export function createReport() {
         },
         get warnings() {
             return warnings;
-        },
+        }
     };
 }

package/config/editorconfig

@@ -31,6 +31,9 @@ ij_javascript_align_multiline_parameters = false
 ij_javascript_align_multiline_chained_methods = false
 ij_javascript_blank_lines_after_imports = 1
 ij_javascript_keep_blank_lines_in_code = 1
+ij_javascript_enforce_trailing_comma = remove
+ij_javascript_spaces_within_array_initializer_brackets = false
+ij_javascript_space_before_function_left_parenth = false
 
 [*.java]
 ij_java_if_brace_force = always

package/config/eslint.config.js

@@ -23,6 +23,27 @@ const shared = {
     'padding-line-between-statements': ['error', { blankLine: 'always', prev: '*', next: 'return' }],
     // an unused catch binding is fine: `catch (error) { // reason }` is how we say the failure is expected
     'no-unused-vars': ['error', { caughtErrors: 'none' }],
+
+    // Formatting, matching the shared .editorconfig so the CLI enforces what WebStorm formats, and
+    // --fix can do it without an IDE. (ESLint 9 still ships these rules deprecated; when it drops
+    // them in 10, they move to @stylistic/eslint-plugin under the same names.)
+    // MemberExpression: 2 is the editorconfig's continuation indent of 8 for a chained call on its own line
+    'indent': ['error', 4, { SwitchCase: 1, MemberExpression: 2 }],
+    'quotes': ['error', 'single', { avoidEscape: true, allowTemplateLiterals: false }],
+    'semi': ['error', 'always'],
+    'template-curly-spacing': ['error', 'always'],
+    'object-curly-spacing': ['error', 'always'],
+    'array-bracket-spacing': ['error', 'never'],
+    'comma-dangle': ['error', 'never'],
+    'arrow-parens': ['error', 'always'],
+    'space-before-function-paren': ['error', { anonymous: 'always', named: 'never', asyncArrow: 'always' }],
+    'keyword-spacing': 'error',
+    'space-infix-ops': 'error',
+    'comma-spacing': 'error',
+    'key-spacing': 'error',
+    'no-trailing-spaces': 'error',
+    'no-multiple-empty-lines': ['error', { max: 1, maxEOF: 0 }],
+    'eol-last': 'error'
 };
 
 export const browser = {
@@ -30,7 +51,7 @@ export const browser = {
     languageOptions: {
         ecmaVersion: 2024,
         sourceType: 'script',
-        globals: { ...globals.browser, HTMLCanvasElement: 'readonly', App: 'writable', ColabClient: 'readonly' },
+        globals: { ...globals.browser, HTMLCanvasElement: 'readonly', App: 'writable', ColabClient: 'readonly' }
     },
     rules: {
         ...js.configs.recommended.rules,
@@ -41,26 +62,26 @@ export const browser = {
             'error',
             {
                 selector: 'Program > VariableDeclaration',
-                message: 'Classic scripts share one global scope: wrap the file in an IIFE and attach its API to window.App.',
+                message: 'Classic scripts share one global scope: wrap the file in an IIFE and attach its API to window.App.'
             },
             {
                 selector: 'Program > FunctionDeclaration',
-                message: 'Classic scripts share one global scope: wrap the file in an IIFE and attach its API to window.App.',
-            },
+                message: 'Classic scripts share one global scope: wrap the file in an IIFE and attach its API to window.App.'
+            }
         ],
         'no-restricted-properties': [
             'warn',
             {
                 object: 'document',
                 property: 'getElementsByClassName',
-                message: 'Use getElementById for the landmark, then querySelectorAll scoped off it.',
-            },
+                message: 'Use getElementById for the landmark, then querySelectorAll scoped off it.'
+            }
         ],
         'no-restricted-globals': [
             'warn',
-            { name: 'setInterval', message: 'Use IntersectionObserver or requestAnimationFrame, not polling.' },
-        ],
-    },
+            { name: 'setInterval', message: 'Use IntersectionObserver or requestAnimationFrame, not polling.' }
+        ]
+    }
 };
 
 export const node = {
@@ -69,12 +90,12 @@ export const node = {
     languageOptions: {
         ecmaVersion: 2024,
         sourceType: 'module',
-        globals: globals.node,
+        globals: globals.node
     },
     rules: {
         ...js.configs.recommended.rules,
-        ...shared,
-    },
+        ...shared
+    }
 };
 
 // For a Node library that keeps its modules in src/ (c10g): the Node rules there instead of the
@@ -89,12 +110,12 @@ export const librarySrc = {
         'no-console': 'off',
         'no-restricted-syntax': 'off',
         'no-restricted-properties': 'off',
-        'no-restricted-globals': 'off',
-    },
+        'no-restricted-globals': 'off'
+    }
 };
 
 export default [
     { ignores: ['node_modules/**', 'dist/**', 'c10g/**', 'src/**/vendor/**', '**/*.min.js'] },
     browser,
-    node,
+    node
 ];

package/config/stylelint.config.js

@@ -23,7 +23,7 @@ export default {
         'selector-id-pattern': [KEBAB, { message: 'ids are kebab-case' }],
         'selector-class-pattern': [CLASS, {
             resolveNestedSelectors: true,
-            message: 'classes are kebab-case; state classes are is-*; a variant of a shared class uses --',
+            message: 'classes are kebab-case; state classes are is-*; a variant of a shared class uses --'
         }],
         // custom properties are kebab-case everywhere; the stricter token shape applies in tokens.css below
         'custom-property-pattern': ['^[a-z0-9]+(-[a-z0-9]+)*$', { message: 'custom properties are kebab-case' }],
@@ -33,33 +33,33 @@ export default {
         'unit-disallowed-list': [['dvh'], { message: 'dvh follows the phone toolbar; use vh, or svh for bottom-anchored content' }],
         'declaration-property-unit-allowed-list': {
             'font-size': ['rem', 'vw', '%'],
-            'letter-spacing': ['em'],
+            'letter-spacing': ['em']
         },
         // frontend.md: don't style off data attributes; they exist for JS
         'selector-attribute-name-disallowed-list': [['/^data-/'], {
             severity: 'warning',
-            message: 'data-* attributes are for JS; style with an id, class or structural selector',
-        }],
+            message: 'data-* attributes are for JS; style with an id, class or structural selector'
+        }]
     },
     // Override globs are relative to the project root: c3b-lint sets configBasedir to it.
     overrides: [
         {
             files: ['src/style/tokens.css', 'src/style/reset.css'],
-            rules: { 'selector-disallowed-list': null },
+            rules: { 'selector-disallowed-list': null }
         },
         {
             // a theme switch (:root[data-theme="light"] { --color-bg: … }) is the one place styling
             // hangs off a data attribute: JS sets it, and only tokens change
             files: ['src/style/tokens.css'],
-            rules: { 'selector-attribute-name-disallowed-list': null },
+            rules: { 'selector-attribute-name-disallowed-list': null }
         },
         {
             files: ['src/style/tokens.css'],
             rules: {
                 'custom-property-pattern': ['^[a-z][a-z0-9]*-[a-z0-9]+(-[a-z0-9]+)*$', {
-                    message: 'tokens are --{category}-{role}[-{variant}]: --color-text-muted, not --fg',
-                }],
-            },
-        },
-    ],
+                    message: 'tokens are --{category}-{role}[-{variant}]: --color-text-muted, not --fg'
+                }]
+            }
+        }
+    ]
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c3b-lint",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "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",