You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+63-11Lines changed: 63 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# n8n Node Package Auditor
2
2
3
-
A TypeScript CLI that audits n8n community-node packages for public package quality, CI readiness, npm provenance publishing, and documentation hygiene.
3
+
An n8n community node plus CLI that audits n8n community-node packages for public package quality, CI readiness, npm provenance publishing, and documentation hygiene.
4
4
5
5
It was built as a portfolio-friendly automation tool after hardening and publishing `n8n-nodes-textdotlk`.
6
6
@@ -13,21 +13,59 @@ It was built as a portfolio-friendly automation tool after hardening and publish
13
13
- GitHub Actions CI workflow signals, including dependency installation plus validation commands
14
14
- npm Trusted Publishing / provenance workflow signals, including tag triggers and OIDC permissions
15
15
- README installation and usage sections
16
-
- SECURITY.md or README security guidance
16
+
-`SECURITY.md` or README security guidance
17
17
18
-
## Install for local development
18
+
## Install in n8n
19
+
20
+
After the package is published to npm, install it from n8n:
21
+
22
+
1. Go to **Settings → Community Nodes**.
23
+
2. Select **Install a community node**.
24
+
3. Enter:
25
+
26
+
```text
27
+
n8n-nodes-package-auditor
28
+
```
29
+
30
+
4. Click **Install** and restart n8n if prompted.
31
+
32
+
The installed node appears as **n8n Package Auditor**.
33
+
34
+
### n8n node parameters
35
+
36
+
-**Package Path**: Path to the package folder as seen by the n8n runtime.
37
+
-**Output Format**: `JSON`, `Markdown`, or `Text` for the `formattedReport` field.
38
+
-**Minimum Score**: Score threshold used to set the boolean `passed` output.
39
+
40
+
For Docker-based n8n, mount the package/repo you want to audit into the n8n container first, then use that container path in **Package Path**.
41
+
42
+
## Install as a CLI
43
+
44
+
After publish, install globally:
45
+
46
+
```bash
47
+
npm install -g n8n-nodes-package-auditor
48
+
```
49
+
50
+
The CLI binary remains:
51
+
52
+
```bash
53
+
n8n-node-package-auditor ./some-n8n-node-package --format text
- Add GitHub API checks for package/repo topics and latest CI status.
83
135
- Add configurable scoring profiles.
84
-
-Publish as an npm package after CLI UX stabilizes.
136
+
-Add npm/GitHub URL audit mode for n8n Cloud-friendly workflows.
85
137
86
138
## Security
87
139
88
-
This tool reads local package files and prints metadata. It should not read `.env` files or secrets. If future API integrations are added, credentials should be provided through environment variables and never serialized into reports.
140
+
This tool reads package files from the path you provide and prints package metadata. It should not read `.env` files or secrets. If future API integrations are added, credentials should be provided through environment variables or n8n credentials and never serialized into reports.
0 commit comments