zemdomu 1.3.14 → 1.3.16

package/README.md

@@ -109,8 +109,13 @@ npx zemdomu "src/**/*.html,src/**/*.jsx"
 ```
 
 Use `--custom` (or `-c`) to provide a path to a JavaScript or TypeScript module
-exporting a custom rule or array of rules. Use `--cross` to enable cross
-component analysis.
+exporting a custom rule or array of rules. For safety, the CLI only accepts
+files inside a `./custom-rules` directory (relative to your current working
+directory). You can repeat `--custom` to load multiple rule files. Use `--cross`
+to enable cross component analysis.
+
+Use `--perf` to emit a JSON timing report to stdout, and `--perf-slowest` to
+also print the slowest file and phase.
 
 ### Cross-component analysis
 
@@ -186,7 +191,11 @@ import {
   visitHtml,
   getAttr,
   getJsxAttr,
+  getJsxAttribute,
+  getJsxAttributeState,
+  getJsxExpressionState,
   getTag,
+  isJsxExpressionPossiblyEmpty,
   ElementNode,
   HtmlVisitor,
 } from "zemdomu";
@@ -195,14 +204,21 @@ import {
 `parseHtml` returns the root `ElementNode`. The `visitHtml` function performs a
 simple depth-first traversal using an `HtmlVisitor` with optional `enter` and
 `exit` callbacks. Utility functions like `getAttr` and `getJsxAttr` help reading
-attributes, while `getTag` resolves JSX element names.
+attributes. JSX helpers like `getJsxAttribute`, `getJsxAttributeState`, and
+`getJsxExpressionState` help interpret JSX attributes and expressions, while
+`getTag` resolves JSX element names.
 
 Or via the CLI:
 
 ```bash
-npx zemdomu file.html --custom my-rule.js
+mkdir -p custom-rules
+cp my-rule.js custom-rules/my-rule.js
+npx zemdomu file.html --custom custom-rules/my-rule.js
+npx zemdomu "src/**/*.{html,jsx,tsx,vue}" --perf --perf-slowest
 ```
 
+There is a sample rule in `custom-rules/example-rule.js` you can copy and edit.
+
 ## Local development (monorepo)
 
 From the core package:

package/out/cli.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const glob_1 = require("glob");
 const path_1 = __importDefault(require("path"));
 const project_linter_1 = require("./project-linter");
+const performance_diagnostics_1 = require("./performance-diagnostics");
 const rule_codes_1 = require("./rule-codes");
 function parsePatterns(inputs) {
     const result = [];
@@ -26,6 +27,8 @@ async function run() {
     const customRules = [];
     let cross = false;
     let depth;
+    let perfEnabled = false;
+    let perfSlowest = false;
     for (let i = 0; i < args.length; i++) {
         const arg = args[i];
         if (arg === '--custom' || arg === '-c') {
@@ -48,6 +51,13 @@ async function run() {
         else if (arg === '--cross') {
             cross = true;
         }
+        else if (arg === '--perf') {
+            perfEnabled = true;
+        }
+        else if (arg === '--perf-slowest') {
+            perfEnabled = true;
+            perfSlowest = true;
+        }
         else if (arg === '--cross-depth') {
             const val = args[++i];
             if (!val)
@@ -71,7 +81,13 @@ async function run() {
         for (const m of matches)
             files.add(m);
     }
-    const linter = new project_linter_1.ProjectLinter({ customRules, crossComponentAnalysis: cross, crossComponentDepth: depth });
+    const perf = perfEnabled ? new performance_diagnostics_1.PerformanceDiagnostics() : undefined;
+    const linter = new project_linter_1.ProjectLinter({
+        customRules,
+        crossComponentAnalysis: cross,
+        crossComponentDepth: depth,
+        perf,
+    });
     const results = await linter.lintFiles(Array.from(files));
     let hasIssues = false;
     for (const [file, issues] of results.entries()) {
@@ -81,6 +97,11 @@ async function run() {
             hasIssues = true;
         }
     }
+    if (perfEnabled && perf) {
+        process.stdout.write(perf.getAsJSON() + '\n');
+        if (perfSlowest)
+            perf.logSlowest();
+    }
     if (hasIssues)
         process.exit(1);
 }

package/out/component-analyzer.d.ts

@@ -13,6 +13,9 @@ interface ComponentReference {
     usageLocations: Array<{
         line: number;
         column: number;
+        inListDirect?: boolean;
+        inSection?: boolean;
+        renderGroup?: string;
     }>;
 }
 interface HeadingInfo {
@@ -34,6 +37,19 @@ interface NavInfo {
     hasLocalLink: boolean;
     childComponents: ComponentReference[];
 }
+interface SectionInfo {
+    filePath: string;
+    line: number;
+    column: number;
+    hasLocalHeading: boolean;
+    childComponents: ComponentReference[];
+}
+interface ListItemInfo {
+    filePath: string;
+    line: number;
+    column: number;
+    nesting: 'root' | 'inList' | 'inOther';
+}
 interface ComponentDefinition {
     name: string;
     filePath: string;
@@ -43,6 +59,9 @@ interface ComponentDefinition {
     ids: IdInfo[];
     navs: NavInfo[];
     hasLocalAnchor: boolean;
+    sections: SectionInfo[];
+    hasHeadingOutsideSection: boolean;
+    listItems: ListItemInfo[];
 }
 export declare class ComponentAnalyzer {
     private componentRegistry;
@@ -80,9 +99,12 @@ export declare class ComponentAnalyzer {
     private findCrossComponentDuplicateIds;
     private collectIds;
     private findCrossComponentNavLinks;
+    private findCrossComponentListNestingIssues;
     private checkNavs;
     private navHasLink;
     private componentHasAnchor;
+    getListNestingSuppressions(): Map<string, Set<string>>;
+    getSectionHeadingSuppressions(): Map<string, Set<string>>;
     private findEntryPoints;
     private findComponentsWithRule;
 }