ContextQMD
Back to N8n

Credential Test Required

packages/@n8n/eslint-plugin-community-nodes/docs/rules/credential-test-required.md

1.37.21.4 KB
Original Source

Ensure credentials have a credential test (@n8n/community-nodes/credential-test-required)

šŸ’¼ This rule is enabled in the following configs: āœ… recommended, ā˜‘ļø recommendedWithoutN8nCloudSupport.

šŸ’” This rule is manually fixable by editor suggestions.

<!-- end auto-generated rule header -->

Rule Details

Ensures that your credentials include a test method to validate user credentials. This helps users verify their credentials are working correctly.

Examples

āŒ Incorrect

typescript
export class MyApiCredential implements ICredentialType {
  name = 'myApi';
  displayName = 'My API';
  properties: INodeProperties[] = [
    {
      displayName: 'API Key',
      name: 'apiKey',
      type: 'string',
      typeOptions: { password: true },
      default: '',
    },
  ];
  // Missing test method
}

āœ… Correct

typescript
export class MyApiCredential implements ICredentialType {
  name = 'myApi';
  displayName = 'My API';
  properties: INodeProperties[] = [
    {
      displayName: 'API Key',
      name: 'apiKey',
      type: 'string',
      typeOptions: { password: true },
      default: '',
    },
  ];

  test: ICredentialTestRequest = {
    request: {
      baseURL: 'https://api.myservice.com',
      url: '/user',
      method: 'GET',
    },
  };
}