c3b-lint 0.0.2 → 0.0.4

package/README.md

@@ -20,9 +20,9 @@ markdown that a tool can check, with one command and one config to install. It r
    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,
    `integrity` on CDN scripts.
-5. **Project structure**: singular directory names, lowercase kebab-case asset names (and no camera exports), 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.
+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.
 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/c3b-lint.js

@@ -27,7 +27,16 @@ const EDITORCONFIG = resolve('.editorconfig');
 
 // The project's own config file when it has one (the one-liner --init writes, or an extended copy for
 // a project that needs an exception), so the CLI and WebStorm always agree; this package's otherwise.
-const configFor = (file) => (existsSync(resolve(file)) ? resolve(file) : join(CONFIG_DIR, file));
+// A .mjs variant is accepted for a package that is not "type": "module" (colab-client).
+function configFor(file) {
+    for (const candidate of [file, file.replace(/\.js$/, '.mjs')]) {
+        if (existsSync(resolve(candidate))) {
+            return resolve(candidate);
+        }
+    }
+
+    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
@@ -87,6 +96,10 @@ function writeBaseline() {
         if (existsSync(path) && readFileSync(path, 'utf8') === content) {
             continue;
         }
+        // a project keeping a .mjs config (not "type": "module") has made its choice
+        if (file.endsWith('.js') && existsSync(path.replace(/\.js$/, '.mjs'))) {
+            continue;
+        }
         console.log(`  write   ${ file }`);
         writeFileSync(path, content);
     }

package/check/structure.js

@@ -61,7 +61,9 @@ function checkAssetNames(report) {
 // CSS lives in src/style/ (reset, tokens, main, components) with pages in style/page/ and animations
 // in style/animation/; JS in src/script/ (WebGL helpers in src/gl/); fonts in src/asset/font/.
 function checkFileHomes(report) {
-    if (!existsSync('src')) {
+    // src/ is a web root when it holds pages; a library that keeps its modules in src/ (c10g) is not
+    // bound to the site layout
+    if (!existsSync('src') || globSync('src/**/*.html').length === 0) {
         return;
     }
     for (const file of globSync('src/**/*.{css,js,woff,woff2,ttf,otf}').map(toPosix).sort()) {

package/package.json

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