c3b-lint 0.0.20 → 0.0.21

package/README.md

@@ -21,7 +21,9 @@ 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. 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/`.
-5. The **500-line limit** on `src/**/*.{css,html}` (ESLint reports the JS); inline `<svg>` art is not counted.
+5. The **500-line limit** on `src/**/*.{css,html}` (ESLint reports the JS); inline `<svg>` art is not counted, nor is
+   a [colab-partial](https://codeberg.org/colab47/colab-partial) region whose partial is in `src/partial/` (one line
+   each: the partial is counted on its own).
 6. **ESLint** on every `.js` file — classic browser scripts under `src/` (IIFE required, no top-level declarations,
    no `console.log`), ES modules everywhere else — with `eslint:recommended` plus the rules from `frontend.md`:
    braces on every `if`, `const`/`let` never `var`, `===`, a blank line before `return`, 500 lines max, and a
@@ -85,7 +87,8 @@ A project's own settings go in its `package.json`, under `"c3b-lint"`:
   its own and never reads the HTML, so without them every use is "not defined". Read-only, `src/` scripts only.
 - `singularDirectories` — plural-looking directory names that are proper names (a client's brand).
 - `ignoreLength` — globs exempt from the 500-line limit and nothing else: the HTML, token, structure, ESLint and
-  Stylelint checks still run on them. For a file that can't be split, like a desktop app's one renderer page.
+  Stylelint checks still run on them. For a file that can't be split. A page made long by the partials it carries
+  needs none: their regions count as one line each.
 
 The ESLint and Stylelint configs read these too, so WebStorm reports what the CLI does.
 

package/c3b-lint.js

@@ -131,14 +131,21 @@ function checkEditorconfig(report) {
     }
 }
 
+// A colab-partial region: the opening marker's line, the copy, the closing marker's line naming the same partial
+const PARTIAL_REGION = /^[ \t]*<!-- partial ([\w./-]+) -->[ \t]*\r?\n[\s\S]*?^[ \t]*<!-- \/partial \1 -->/gm;
+
 // general.md: no hand-written file past 500 lines. ESLint reports JS; this covers CSS and HTML.
 function checkFileLengths(report) {
     const ignored = ignoredPaths();
     const exempt = ignoredPaths(readSettings().ignoreLength);
     const files = globSync('src/**/*.{css,html}').map(toPosix).filter((file) => !file.includes('/vendor/') && !ignored.has(file) && !exempt.has(file));
     for (const file of files.sort()) {
-        // inline <svg> is vector art, not hand-written markup: its lines are not counted
-        const content = readFileSync(file, 'utf8').replace(/<svg[\s\S]*?<\/svg>/g, '<svg/>');
+        // inline <svg> is vector art, not hand-written markup: its lines are not counted. Nor is a partial's
+        // copy (colab-partial writes it from src/partial/, which is counted on its own): one line, as long as
+        // that partial is there, so markers can't hide markup written nowhere else
+        const content = readFileSync(file, 'utf8')
+                .replace(/<svg[\s\S]*?<\/svg>/g, '<svg/>')
+                .replace(PARTIAL_REGION, (region, name) => (existsSync(join('src', 'partial', name)) ? `<!-- partial ${ name } -->` : region));
         const lines = content.split('\n').length - (content.endsWith('\n') ? 1 : 0);
         if (lines > MAX_LINES) {
             report.error(file, `is ${ lines } lines (limit ${ MAX_LINES }) — split it by responsibility`);

package/package.json

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