@micelio/eslint-config 0.2.4 → 0.2.5

package/README.md

@@ -30,3 +30,18 @@ version `AGENTS.md` pins (`` `standard: X.Y` ``), using the SHA-256 hashes in
 `@micelio/eslint-config/standard-hashes.json`. Add it as `"lint:standard": "micelio-lint-standard"`
 and to `npm run check`. A pinned version newer than the installed package knows fails with a message
 that says to upgrade the package.
+
+## `lint:ee`
+
+`micelio-lint-ee [--allow <path>]... [root]` fails when a file git tracks enables Strapi Enterprise
+code, which is not AGPL-compatible (bogd3v/micelio-cms#96). It reads the tracked files with an
+extension of code or configuration (`.js`, `.ts` and their variants, `.json`, `.yml`, `.sh`,
+`.env.example`, `Dockerfile`) line by line and reports `path:line message` for three rules:
+
+- the line names `STRAPI_LICENSE` (sets or reads the Enterprise licence key);
+- the line imports `@strapi/review-workflows` or `@strapi/content-releases`;
+- the line imports Strapi code under `ee/` (`@strapi/<package>/ee`).
+
+`--allow <path>` (repeatable) names a tracked file, relative to the root, that may mention them, such
+as `THIRD-PARTY.md` or `package-lock.json`; nothing else is skipped. A repository without Strapi
+passes. Add it as `"lint:ee": "micelio-lint-ee"` and to `npm run check`.

package/dist/ee.d.ts

@@ -0,0 +1,31 @@
+/** One rule of `micelio-lint-ee`: a line that matches `pattern` fails with `message`. */
+export interface EeRule {
+    /** The text that marks the line as Strapi Enterprise code. */
+    pattern: RegExp;
+    /** What the line does, as it appears in the report. */
+    message: string;
+}
+/**
+ * The three rules of `micelio-cms`'s `scripts/check-no-ee.mjs`, none dropped or narrowed
+ * (Strapi Enterprise code is not AGPL-compatible, bogd3v/micelio-cms#96).
+ */
+export declare const EE_RULES: readonly EeRule[];
+/** What `lintEe` found. */
+export interface EeResult {
+    /** True when no scanned file matches a rule. */
+    ok: boolean;
+    /** One `path:line message` per match. */
+    failures: string[];
+    /** How many files were scanned. */
+    checked: number;
+    /** One line for the terminal. */
+    message: string;
+}
+/**
+ * Scans the files git tracks in `root` for Strapi Enterprise code.
+ *
+ * @param root - The repository directory.
+ * @param allow - The tracked paths, relative to `root`, that may name the patterns (a licence list, the lockfile).
+ * @returns The matches, one per line and rule.
+ */
+export declare function lintEe(root: string, allow?: readonly string[]): EeResult;

package/dist/ee.js

@@ -0,0 +1,52 @@
+import { execFileSync } from 'node:child_process';
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+/**
+ * The three rules of `micelio-cms`'s `scripts/check-no-ee.mjs`, none dropped or narrowed
+ * (Strapi Enterprise code is not AGPL-compatible, bogd3v/micelio-cms#96).
+ */
+export const EE_RULES = [
+    {
+        pattern: /STRAPI_LICENSE/,
+        message: 'sets or reads STRAPI_LICENSE (Strapi Enterprise license key)',
+    },
+    {
+        pattern: /['"]@strapi\/(review-workflows|content-releases)['"/]/,
+        message: 'imports a Strapi Enterprise package',
+    },
+    { pattern: /['"]@strapi\/[^'"]+\/ee(\/|['"])/, message: 'imports Strapi code under ee/' },
+];
+/** The tracked files that can hold code or configuration: the ones the script of `micelio-cms` reads. */
+const SCANNED = /\.(m?[jt]sx?|json|ya?ml|sh|env\.example)$|(^|\/)(Dockerfile|\.env\.example)$/;
+/**
+ * Scans the files git tracks in `root` for Strapi Enterprise code.
+ *
+ * @param root - The repository directory.
+ * @param allow - The tracked paths, relative to `root`, that may name the patterns (a licence list, the lockfile).
+ * @returns The matches, one per line and rule.
+ */
+export function lintEe(root, allow = []) {
+    const files = execFileSync('git', ['ls-files'], { cwd: root, encoding: 'utf8' })
+        .split('\n')
+        .filter((file) => file && !allow.includes(file) && SCANNED.test(file));
+    const failures = [];
+    for (const file of files) {
+        readFileSync(join(root, file), 'utf8')
+            .split('\n')
+            .forEach((line, index) => {
+            for (const rule of EE_RULES) {
+                if (rule.pattern.test(line))
+                    failures.push(`${file}:${index + 1} ${rule.message}`);
+            }
+        });
+    }
+    const ok = failures.length === 0;
+    return {
+        ok,
+        failures,
+        checked: files.length,
+        message: ok
+            ? `No Strapi Enterprise code enabled (${files.length} files checked).`
+            : 'Strapi Enterprise code must stay disabled: see THIRD-PARTY.md.',
+    };
+}

package/dist/lint-ee.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/lint-ee.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+import { lintEe } from './ee.js';
+// `micelio-lint-ee [--allow <path>]... [root]`: the `lint:ee` script of a repository born from `template/`.
+const allow = [];
+let root = process.cwd();
+const args = process.argv.slice(2);
+for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    if (arg === '--allow') {
+        const path = args[++i];
+        if (path === undefined) {
+            console.error('error: --allow needs a path');
+            process.exit(2);
+        }
+        allow.push(path);
+    }
+    else {
+        root = arg;
+    }
+}
+const result = lintEe(root, allow);
+if (result.ok) {
+    process.stdout.write(`${result.message}\n`);
+}
+else {
+    for (const failure of result.failures)
+        console.error(`error: ${failure}`);
+    console.error(result.message);
+    process.exitCode = 1;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@micelio/eslint-config",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "The ESLint flat config of the Micelio repositories, the licence allowlist behind lint:licenses and lint:standard.",
   "license": "MIT-0",
   "repository": {
@@ -45,6 +45,7 @@
     "provenance": true
   },
   "bin": {
+    "micelio-lint-ee": "./dist/lint-ee.js",
     "micelio-lint-standard": "./dist/lint-standard.js"
   },
   "devDependencies": {

package/standard-hashes.json

@@ -6,7 +6,7 @@
   "1.8": "bbdbd8b0f7d394ba24471a3b65dbcf7a82b9899a221a39e78ffe819ebbc79249",
   "files": {
     ".claude/agents/master.md": "35e9ce4cc637ca814352916dd24e64f25da66f0c3c36fb492e2172c40e6d6416",
-    ".claude/agents/planner.md": "944a55dae33c1f4290c574923d12af1d3b1f24c4cd5dfb75f4e819ca24ecb727",
+    ".claude/agents/planner.md": "548a7b62a14c0c07067004fb57934bf572e308063e3ed390262e1d7a69e9fea0",
     ".claude/agents/reviewer.md": "8edcd83631b191013217eb9f309b108f54e988708496182877077b65a9b6f1cf",
     ".claude/agents/verifier.md": "7fc1c73eec7c64ba669ece73075c0f967b316d81c9389a00ae729acf29505ae8",
     ".claude/agents/worker.md": "3f4dafea2266a752a5aba7f26035bdab1c5a4b6591916f0c2be4fdb68ad924ca",