@replikanti/flowlint-core 0.9.2 → 0.9.4

package/README.md

@@ -1,75 +1,85 @@
-# @replikanti/flowlint-core
-
-Core linting engine for n8n workflows. This package provides the fundamental building blocks for analyzing and validating n8n workflow files.
-
-## Installation
-
-```bash
-npm install @replikanti/flowlint-core
-```
-
-## Usage
-
-```typescript
-import { parseN8n, runAllRules, loadConfig, defaultConfig } from '@replikanti/flowlint-core';
-
-// Parse a workflow from JSON string
-const workflow = parseN8n(workflowJsonString);
-
-// Run all linting rules
-const findings = runAllRules(workflow, {
-  path: 'my-workflow.n8n.json',
-  cfg: defaultConfig,
-});
-
-// Process findings
-findings.forEach(finding => {
-  console.log([${finding.severity.toUpperCase()}] ${finding.rule}: ${finding.message});
-});
-```
-
-## API
-
-### Parser
-
-- `parseN8n(doc: string): Graph` - Parse n8n workflow JSON/YAML into a graph structure
-
-### Linting
-
-- `runAllRules(graph: Graph, ctx: RuleContext): Finding[]` - Run all enabled rules
-
-### Configuration
-
-- `loadConfig(configPath?: string): FlowLintConfig` - Load configuration from file
-- `defaultConfig: FlowLintConfig` - Default configuration
-- `parseConfig(content: string): FlowLintConfig` - Parse config from YAML string
-
-### Validation
-
-- `validateN8nWorkflow(data: unknown): void` - Validate workflow structure
-
-## Rules
-
-This package includes 14 built-in rules:
-
-| Rule | Description | Severity |
-|------|-------------|----------|
-| R1 | Rate limit retry | must |
-| R2 | Error handling | must |
-| R3 | Idempotency | should |
-| R4 | Secrets exposure | must |
-| R5 | Dead ends | nit |
-| R6 | Long running | should |
-| R7 | Alert/log enforcement | should |
-| R8 | Unused data | nit |
-| R9 | Config literals | should |
-| R10 | Naming convention | nit |
-| R11 | Deprecated nodes | should |
-| R12 | Unhandled error path | must |
-| R13 | Webhook acknowledgment | must |
-| R14 | Retry-After compliance | should |
-
-## License
-
+# @replikanti/flowlint-core
+
+![Coverage](https://img.shields.io/badge/coverage-90%25-green)
+
+Core linting engine for n8n workflows. This package provides the fundamental building blocks for analyzing and validating n8n workflow files.
+
+## Installation
+
+```bash
+npm install @replikanti/flowlint-core
+```
+
+## Usage
+
+```typescript
+import { parseN8n, runAllRules, loadConfig, defaultConfig } from '@replikanti/flowlint-core';
+
+// Parse a workflow from JSON string
+const workflow = parseN8n(workflowJsonString);
+
+// Run all linting rules
+const findings = runAllRules(workflow, {
+  path: 'my-workflow.n8n.json',
+  cfg: defaultConfig,
+});
+
+// Process findings
+findings.forEach(finding => {
+  console.log(`[\${finding.severity.toUpperCase()}] \${finding.rule}: \${finding.message}`);
+});
+```
+
+## API
+
+### Parser
+
+- `parseN8n(doc: string): Graph` - Parse n8n workflow JSON/YAML into a graph structure
+
+### Linting
+
+- `runAllRules(graph: Graph, ctx: RuleContext): Finding[]` - Run all enabled rules
+
+### Configuration
+
+- `loadConfig(configPath?: string): FlowLintConfig` - Load configuration from file
+- `defaultConfig: FlowLintConfig` - Default configuration
+- `parseConfig(content: string): FlowLintConfig` - Parse config from YAML string
+
+### Validation
+
+- `validateN8nWorkflow(data: unknown): void` - Validate workflow structure
+
+## Testing
+
+Run tests with coverage reporting:
+
+```bash
+npm run test:coverage
+```
+
+## Rules
+
+This package includes 14 built-in rules:
+
+| Rule | Description | Severity |
+|------|-------------|----------|
+| R1 | Rate limit retry | must |
+| R2 | Error handling | must |
+| R3 | Idempotency | should |
+| R4 | Secrets exposure | must |
+| R5 | Dead ends | nit |
+| R6 | Long running | should |
+| R7 | Alert/log enforcement | should |
+| R8 | Unused data | nit |
+| R9 | Config literals | should |
+| R10 | Naming convention | nit |
+| R11 | Deprecated nodes | should |
+| R12 | Unhandled error path | must |
+| R13 | Webhook acknowledgment | must |
+| R14 | Retry-After compliance | should |
+
+## License
+
 MIT
 

package/dist/index.js

@@ -883,6 +883,30 @@ var metadata7 = {
   description: "Ensures critical paths include logging or alerting steps.",
   details: "For example, a failed payment processing branch should trigger an alert for monitoring."
 };
+function isPathHandled(graph, startNodeId) {
+  const queue = [startNodeId];
+  const visited = /* @__PURE__ */ new Set([startNodeId]);
+  let head = 0;
+  while (head < queue.length) {
+    const currentId = queue[head++];
+    const currentNode = graph.nodes.find((n) => n.id === currentId);
+    if (!currentNode) continue;
+    if (isNotificationNode(currentNode.type) || isErrorHandlerNode(currentNode.type, currentNode.name)) {
+      return true;
+    }
+    if (isRejoinNode(graph, currentId)) {
+      continue;
+    }
+    const outgoing = graph.edges.filter((e) => e.from === currentId);
+    for (const outEdge of outgoing) {
+      if (!visited.has(outEdge.to)) {
+        visited.add(outEdge.to);
+        queue.push(outEdge.to);
+      }
+    }
+  }
+  return false;
+}
 function r7AlertLogEnforcement(graph, ctx) {
   const cfg = ctx.cfg.rules.alert_log_enforcement;
   if (!cfg?.enabled) return [];
@@ -890,29 +914,7 @@ function r7AlertLogEnforcement(graph, ctx) {
   const errorEdges = graph.edges.filter((edge) => edge.on === "error");
   for (const edge of errorEdges) {
     const fromNode = graph.nodes.find((n) => n.id === edge.from);
-    let isHandled = false;
-    const queue = [edge.to];
-    const visited = /* @__PURE__ */ new Set([edge.to]);
-    let head = 0;
-    while (head < queue.length) {
-      const currentId = queue[head++];
-      const currentNode = graph.nodes.find((n) => n.id === currentId);
-      if (isNotificationNode(currentNode.type) || isErrorHandlerNode(currentNode.type, currentNode.name)) {
-        isHandled = true;
-        break;
-      }
-      if (isRejoinNode(graph, currentId)) {
-        continue;
-      }
-      const outgoing = graph.edges.filter((e) => e.from === currentId);
-      for (const outEdge of outgoing) {
-        if (!visited.has(outEdge.to)) {
-          visited.add(outEdge.to);
-          queue.push(outEdge.to);
-        }
-      }
-    }
-    if (!isHandled) {
+    if (!isPathHandled(graph, edge.to)) {
       findings.push({
         rule: metadata7.id,
         severity: metadata7.severity,
@@ -1137,7 +1139,7 @@ var r14RetryAfterCompliance = createNodeRule(metadata14.id, metadata14.name, (no
   const waitBetweenTries = node.flags?.waitBetweenTries;
   if (waitBetweenTries !== void 0 && waitBetweenTries !== null) {
     if (typeof waitBetweenTries === "number") return null;
-    if (typeof waitBetweenTries === "string" && !isNaN(Number(waitBetweenTries)) && !waitBetweenTries.includes("{{")) {
+    if (typeof waitBetweenTries === "string" && !Number.isNaN(Number(waitBetweenTries)) && !waitBetweenTries.includes("{{")) {
       return null;
     }
   }
@@ -1301,9 +1303,10 @@ function loadConfig(configPath) {
   }
   return loadConfigFromCwd();
 }
+var fsOverride = null;
 function loadConfigFromFile(configPath) {
   try {
-    const fs = require("fs");
+    const fs = fsOverride || require("fs");
     if (!fs.existsSync(configPath)) {
       return defaultConfig;
     }
@@ -1315,7 +1318,7 @@ function loadConfigFromFile(configPath) {
 }
 function loadConfigFromCwd() {
   try {
-    const fs = require("fs");
+    const fs = fsOverride || require("fs");
     const path = require("path");
     const candidates = [".flowlint.yml", ".flowlint.yaml", "flowlint.config.yml"];
     const cwd = process.cwd();