n8n:create community node lint rule

Other Community

Skill notes

Step 1: Understand the Rule

Before writing code, clarify: What does the rule detect? (missing property, wrong pattern, bad value) Where does it apply? (.node.ts files, credential classes, both) Severity: error (must fix) or warn (should fix)? Fixable? Can it be auto-fixed safely, or only suggest?

Step 2: Implement the Rule

Create src/rules/<rule-name>.ts: Naming: Export as PascalCaseRule (e.g. MissingPairedItemRule). The name field is kebab-case. Available AST helpers — see reference.md for the full catalog of ast-utils and file-utils exports.

Step 3: Write Tests

Create src/rules/<rule-name>.test.ts: Test guidelines: Always test that non-INodeType classes are skipped (valid case) Test both the error message and the fixed output for fixable rules For rules with options, test each option combination

4b. Add to src/plugin.ts configs

Add to both config objects (unless the rule depends on n8n cloud features): Use error for rules that catch bugs or required patterns Use warn for style/convention rules (like options-sorted-alphabetically) If the rule uses no-restricted-globals or no-restricted-imports patterns, only add to recommended (not recommendedWithoutN8nCloudSupport)

Step 5: Write Documentation

Create docs/rules/<rule-name>.md: The header above `` will be regenerated by pnpm build:docs. Write a reasonable first version — it gets overwritten.

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
Other
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
88 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@n8n-io · no license declared
Token usage
Lean
Setup complexity
Plug-and-play
External API key
Not required
Operating systems
macOS · Linux · Windows
Runtime requirements
Node.js
Detected file/system behavior
  • Read-only
  • Write / modify
Network behavior
Local-only
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

01
Step 1: Understand the Rule

Before writing code, clarify: What does the rule detect? (missing property, wrong pattern, bad value) Where does it apply? (`.node.ts` files, credential classes, both) Severity: `error` (must fix) or `warn` (should fix)? Fixable? Can it be auto-fixed safely, or only suggest?

02
Step 2: Implement the Rule

Create `src/rules/<rule-name>.ts`: Naming: Export as `PascalCaseRule` (e.g. `MissingPairedItemRule`). The `name` field is kebab-case. Available AST helpers — see reference.md for the full catalog of `ast-utils` and `file-utils` exports.

03
Step 3: Write Tests

Create `src/rules/<rule-name>.test.ts`: Test guidelines: Always test that non-INodeType classes are skipped (valid case) Test both the error message and the fixed output for fixable rules For rules with options, test each option combination

04
Step 4: Register the Rule

Step 4: Register the Rule

05
Step 5: Write Documentation

Create `docs/rules/<rule-name>.md`: The header above `` will be regenerated by `pnpm build:docs`. Write a reasonable first version — it gets overwritten.

06
Step 6: Verify

Run from `packages/@n8n/eslint-plugin-community-nodes/`:

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.