@wix/origami-lint 1.34.1 → 1.34.3

package/dist/lint.js

@@ -1,13 +1,17 @@
 #!/usr/bin/env node
-// Origami lint: lints the pages whose files changed since the last passing run. See lint/README.md.
+// Origami lint: runs the project rules on the site's own files, then lints the pages whose files changed since the last
+// passing run. See lint/README.md.
 import { getChangedFiles, markPassing } from "./history/index.js";
 import { runRules } from "./rules-adapter/index.js";
 import { findPagesToLint } from "./page-model/index.js";
+import { runProjectRules } from "./project-rules-runner/index.js";
 import { checkStartedAtSiteRoot } from "./shared/paths.js";
 checkStartedAtSiteRoot();
 const changedFiles = getChangedFiles();
+const projectPassed = runProjectRules(changedFiles.all);
 const pagesToLint = findPagesToLint(changedFiles);
-const passed = runRules(pagesToLint);
+const pagesPassed = runRules(pagesToLint);
+const passed = projectPassed && pagesPassed;
 if (passed)
     markPassing(changedFiles);
 process.exit(passed ? 0 : 1);

package/dist/project-model/index.js

@@ -0,0 +1,2 @@
+// The project model, beside the page model (part 2): what a project rule sees of the site.
+export { createProjectModel } from "./project-model.js";

package/dist/project-model/project-model.js

@@ -0,0 +1,15 @@
+/** A path from the site root that stays inside the site: no leading /, no .. segment. */
+function isSitePath(file) {
+    return !file.startsWith('/') && !file.split('/').includes('..');
+}
+/** The rule's view of the site: its files, and readFile. ruleName names the rule in readFile's error. */
+export function createProjectModel(ruleName, files, readFile) {
+    return {
+        files,
+        readFile(file) {
+            if (!isSitePath(file))
+                throw new Error(`project rule ${ruleName} read ${file}: write a path from the site root, without ..`);
+            return readFile(file);
+        },
+    };
+}

package/dist/project-rules-runner/index.js

@@ -0,0 +1,3 @@
+// The project rules runner, beside the rules adapter (part 5): runs the rules that check the site's own files and
+// folders (lint/rules/project/), not one page.
+export { runProjectRules } from "./run-project-rules.js";

package/dist/project-rules-runner/run-project-rules.js

@@ -0,0 +1,44 @@
+// Runs every project rule, on every run, on the whole site; prints each problem in the line shape the page rules'
+// problems print in.
+import { readFileSync } from 'node:fs';
+import path from 'node:path';
+import { projectRuleRegistry } from "../rules/project/index.js";
+import { log } from "../shared/log.js";
+import { ROOT } from "../shared/paths.js";
+import { createProjectModel } from "../project-model/index.js";
+/** true when no error rule reported a problem, on the site of these files. Logs how many rules run, and whether they passed. */
+export function runProjectRules(files, { rules = projectRuleRegistry, readFile = readFromSite, print = console.log } = {}) {
+    log(`${rules.length} project rules to run`);
+    let passed = true;
+    for (const rule of rules) {
+        let problems;
+        try {
+            problems = rule.check(createProjectModel(rule.name, files, readFile));
+        }
+        catch (error) {
+            // A rule that couldn't finish (a file it can't parse, a path out of the site) fails the run, whatever its severity.
+            print(formatProblem({ name: rule.name }, { file: '.', message: `the rule couldn't finish, so this run can't pass: ${error instanceof Error ? error.message : String(error)}` }));
+            passed = false;
+            continue;
+        }
+        for (const problem of problems) {
+            print(formatProblem(rule, problem));
+            if ((rule.severity ?? 'error') === 'error')
+                passed = false;
+        }
+    }
+    log(passed ? 'project rules passed' : 'project rules failed');
+    return passed;
+}
+/** `file:line:1: error origami(name): message`, the shape oxlint prints the page rules' problems in. */
+export function formatProblem({ name, severity = 'error' }, { file, line = 1, message }) {
+    return `${file}:${line}:1: ${severity === 'error' ? 'error' : 'warning'} origami(${name}): ${message}`;
+}
+function readFromSite(file) {
+    try {
+        return readFileSync(path.join(ROOT, file), 'utf8');
+    }
+    catch {
+        return undefined;
+    }
+}

package/dist/rules/project/define-project-rule.js

@@ -0,0 +1,4 @@
+/** Nothing changes a rule once it's defined. */
+export function defineProjectRule(rule) {
+    return Object.freeze({ ...rule, scope: 'project' });
+}

package/dist/rules/project/index.js

@@ -0,0 +1,2 @@
+export { defineProjectRule } from "./define-project-rule.js";
+export const projectRuleRegistry = [];

package/dist/shared/utils.js

@@ -31,7 +31,7 @@ export const RESERVED_ENTRY_KEYS = ['data', 'slots', 'elementProps', 'bindings',
 export const DATA_KEY = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
 /** By import source; the wrappers also by the imported name, since their packages export other things (`Show`, `Interact`). */
 const TYPE_BY_IMPORT_SOURCE = [
-    [new RegExp(`^${SYSTEM}/Page$`), 'page'],
+    [new RegExp(`^${SYSTEM}/(?:layout/)?Page$`), 'page'],
     [new RegExp(`^${SYSTEM}/layout/Header$`), 'headerLandmark'],
     [new RegExp(`^${SYSTEM}/layout/Footer$`), 'footerLandmark'],
     [new RegExp(`^${SYSTEM}/(?:layout/)?Section$`), 'section'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/origami-lint",
-  "version": "1.34.1",
+  "version": "1.34.3",
   "description": "Offline lint for an exported Origami site: lints the pages that changed since the last passing run",
   "type": "module",
   "bin": {
@@ -51,5 +51,5 @@
       ]
     }
   },
-  "falconPackageHash": "73a2fcabe83927b716b3f75d2c0db9dc6081ecbb3de57134cbd36383"
+  "falconPackageHash": "162134940d5c0140fe1b81ff9111d25a7f98f0201dfbbc32130245ca"
 }