cred-class-field-placeholder-url-missing-eg.md

cred-class-field-placeholder-url-missing-eg

placeholder for a URL in credential class must be prepended with e.g..

📋 This rule is part of the plugin:n8n-nodes-base/credentials config.

🔧 Run ESLint with --fix option to autofix the issue flagged by this rule.

Examples

❌ Example of incorrect code:

class MyTestOAuth2Api implements ICredentialType {
    name = 'myTestOAuth2Api';
    displayName = 'My Test OAuth2 API';
    documentationUrl = 'myTest';
    extends = [
        'oAuth2Api',
    ];
    placeholder = 'https://n8n.io';
}

✅ Example of correct code:

class MyTestOAuth2Api implements ICredentialType {
    name = 'myTestOAuth2Api';
    displayName = 'My Test OAuth2 API';
    documentationUrl = 'myTest';
    extends = [
        'oAuth2Api',
    ];
    placeholder = 'e.g. https://n8n.io';
}

Links

• Rule source
• Test source