flowlint 0.7.8 → 0.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +99 -86
  2. package/dist/cli.js +385 -1853
  3. package/dist/cli.js.map +1 -1
  4. package/package.json +5 -2
package/README.md CHANGED
@@ -1,88 +1,101 @@
1
- # FlowLint CLI
2
-
3
- Command-line tool for static analysis of n8n workflows.
4
-
5
- ## Installation
6
-
7
- ```bash
8
- npm install -g flowlint
9
- ```
10
-
11
- Or use npx:
12
-
13
- ```bash
14
- npx flowlint scan .
15
- ```
16
-
17
- ## Usage
18
-
19
- ### Scan workflows
20
-
21
- ```bash
22
- # Scan current directory
23
- flowlint scan
24
-
25
- # Scan specific directory
26
- flowlint scan ./workflows
27
-
28
- # Output as JSON
29
- flowlint scan --format json
30
-
31
- # Fail on errors (for CI)
32
- flowlint scan --fail-on-error
33
- ```
34
-
35
- ### Initialize configuration
36
-
37
- ```bash
38
- flowlint init
39
- ```
40
-
41
- Creates a `.flowlint.yml` file in the current directory.
42
-
43
- ## Configuration
44
-
45
- Create a `.flowlint.yml` file:
46
-
47
- ```yaml
48
- files:
49
- include:
50
- - "**/*.n8n.json"
51
- ignore:
52
- - "node_modules/**"
53
-
54
- rules:
55
- rate_limit_retry:
56
- enabled: true
57
- error_handling:
58
- enabled: true
59
- # ... more rules
60
- ```
61
-
62
- ## Rules
63
-
64
- | Rule | Description | Severity |
65
- |------|-------------|----------|
66
- | R1 | Rate limit retry | must |
67
- | R2 | Error handling | must |
68
- | R3 | Idempotency | should |
69
- | R4 | Secrets exposure | must |
70
- | R5 | Dead ends | nit |
71
- | R6 | Long running | should |
72
- | R7 | Alert/log enforcement | should |
73
- | R8 | Unused data | nit |
74
- | R9 | Config literals | should |
75
- | R10 | Naming convention | nit |
76
- | R11 | Deprecated nodes | should |
77
- | R12 | Unhandled error path | must |
78
- | R13 | Webhook acknowledgment | must |
79
- | R14 | Retry-After compliance | should |
80
-
81
- ## License
82
-
1
+ # FlowLint CLI
2
+
3
+ ![Coverage](https://img.shields.io/badge/coverage-80%25-green)
4
+
5
+ Command-line tool for static analysis of n8n workflows.
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ npm install -g flowlint
11
+ ```
12
+
13
+ Or use npx:
14
+
15
+ ```bash
16
+ npx flowlint scan .
17
+ ```
18
+
19
+ ## Usage
20
+
21
+ ### Scan workflows
22
+
23
+ ```bash
24
+ # Scan current directory
25
+ flowlint scan
26
+
27
+ # Scan specific directory
28
+ flowlint scan ./workflows
29
+
30
+ # Scan single file
31
+ flowlint scan ./workflows/payment-flow.n8n.json
32
+
33
+ # Output as JSON
34
+ flowlint scan --format json
35
+
36
+ # Fail on errors (for CI)
37
+ flowlint scan --fail-on-error
38
+ ```
39
+
40
+ ### Initialize configuration
41
+
42
+ ```bash
43
+ flowlint init
44
+ ```
45
+
46
+ Creates a `.flowlint.yml` file in the current directory.
47
+
48
+ ## Testing
49
+
50
+ Run tests with coverage reporting:
51
+
52
+ ```bash
53
+ npm run test:coverage
54
+ ```
55
+
56
+ ## Configuration
57
+
58
+ Create a `.flowlint.yml` file:
59
+
60
+ ```yaml
61
+ files:
62
+ include:
63
+ - "**/*.n8n.json"
64
+ ignore:
65
+ - "node_modules/**"
66
+
67
+ rules:
68
+ rate_limit_retry:
69
+ enabled: true
70
+ error_handling:
71
+ enabled: true
72
+ # ... more rules
73
+ ```
74
+
75
+ ## Rules
76
+
77
+ | Rule | Description | Severity |
78
+ |------|-------------|----------|
79
+ | R1 | Rate limit retry | must |
80
+ | R2 | Error handling | must |
81
+ | R3 | Idempotency | should |
82
+ | R4 | Secrets exposure | must |
83
+ | R5 | Dead ends | nit |
84
+ | R6 | Long running | should |
85
+ | R7 | Alert/log enforcement | should |
86
+ | R8 | Unused data | nit |
87
+ | R9 | Config literals | should |
88
+ | R10 | Naming convention | nit |
89
+ | R11 | Deprecated nodes | should |
90
+ | R12 | Unhandled error path | must |
91
+ | R13 | Webhook acknowledgment | must |
92
+ | R14 | Retry-After compliance | should |
93
+
94
+ ## License
95
+
83
96
  MIT
84
-
85
-
86
- ## Dependencies
87
-
97
+
98
+
99
+ ## Dependencies
100
+
88
101
  This tool depends on [@replikanti/flowlint-core](https://www.npmjs.com/package/@replikanti/flowlint-core) for linting logic.