n8n:create-community-node-lint-rule

Source excerpt starting at line 1.

1# AST & File Utilities Reference2 3Helpers available from `../utils/index.js`. Use these instead of writing custom AST traversal.4 5## ast-utils.ts6 7### Class/Interface detection8 9| Function | Returns | Use when |10|----------|---------|----------|11| `isNodeTypeClass(node)` | `boolean` | Check if class implements `INodeType` or extends `Node` |12| `isCredentialTypeClass(node)` | `boolean` | Check if class implements `ICredentialType` |13 14### Property finding15 16| Function | Returns | Use when |17|----------|---------|----------|18| `findClassProperty(node, name)` | `PropertyDefinition \| null` | Find a property on a class (e.g. `description`, `icon`) |19| `findObjectProperty(obj, name)` | `Property \| null` | Find a property in an object literal (Identifier key) |20| `findJsonProperty(obj, name)` | `Property \| null` | Find a property with a Literal key (JSON-style `"key"`) |21| `findArrayLiteralProperty(obj, name)` | `Property \| null` | Find a property whose value is an ArrayExpression |22 23### Value extraction24 25| Function | Returns | Use when |26|----------|---------|----------|27| `getLiteralValue(node)` | `string \| boolean \| number \| null` | Extract primitive from a Literal node |28| `getStringLiteralValue(node)` | `string \| null` | Extract string specifically |29| `getBooleanLiteralValue(node)` | `boolean \| null` | Extract boolean specifically |30| `getModulePath(node)` | `string \| null` | Get import path from string literal or template literal |31 32### Array operations33 34| Function | Returns | Use when |35|----------|---------|----------|36| `hasArrayLiteralValue(arr, value)` | `boolean` | Check if array contains a specific string literal |37| `extractCredentialInfoFromArray(element)` | `{ name, testedBy } \| null` | Parse credential object from array element |38| `extractCredentialNameFromArray(element)` | `string \| null` | Get just the credential name from array element |39 40### Method matching41 42| Function | Returns | Use when |43|----------|---------|----------|44| `isThisHelpersAccess(node)` | `boolean` | Match `this.helpers` member expression |45| `isThisMethodCall(node, method)` | `boolean` | Match `this.methodName(...)` calls |46| `isThisHelpersMethodCall(node, method)` | `boolean` | Match `this.helpers.methodName(...)` calls |47 48### Similarity49 50| Function | Returns | Use when |51|----------|---------|----------|52| `findSimilarStrings(target, candidates, maxDistance?)` | `string[]` | Suggest similar names (Levenshtein distance) |53 54## file-utils.ts55 56### Path operations57 58| Function | Use when |59|----------|----------|60| `isContainedWithin(child, parent)` | Check path is within a directory |61| `safeJoinPath(base, ...parts)` | Join paths with traversal prevention |62 63### Package.json64 65| Function | Returns | Use when |66|----------|---------|----------|67| `findPackageJson(startDir)` | `string \| null` | Walk up to find nearest package.json |68| `readPackageJsonN8n(startDir)` | `N8nPackageJson \| null` | Parse n8n config section |69| `readPackageJsonCredentials(startDir)` | `Set<string>` | Get credential names from package.json |70| `readPackageJsonNodes(startDir)` | `string[]` | Get resolved node file paths |71 72### File system73 74| Function | Use when |75|----------|----------|76| `validateIconPath(filePath, iconValue)` | Check icon file exists and is SVG |77| `extractCredentialNameFromFile(filePath)` | Parse credential class name from file |78| `fileExistsWithCaseSync(filePath)` | Case-sensitive existence check |79| `findSimilarSvgFiles(dir, name)` | Suggest similar SVG filenames |80 81### Credential verification82 83| Function | Use when |84|----------|----------|85| `areAllCredentialUsagesTestedByNodes(startDir)` | Check all credentials have testedBy |86