Establish consistent naming conventions that preserve semantic meaning and follow established patterns. Use descriptive names that clearly indicate purpose and type.
Establish consistent naming conventions that preserve semantic meaning and follow established patterns. Use descriptive names that clearly indicate purpose and type.
Key guidelines:
SeverityLevelEnum instead of SeverityLevelshouldLogAnalytics() instead of isLogAnalytics()map((variable) => ...) instead of map((error) => ...)WorkflowStepFetcher instead of StepTemplateFetchersearchText instead of searchLower for variable name suggestionsworkflowId rather than mixing workflowIdOrInternalIdExample:
// Good
export enum SeverityLevelEnum { ... }
function shouldLogAnalytics(): boolean { ... }
invalidVariables.map((variable) => ({ message: variable.name }))
// Avoid
export enum SeverityLevel { ... }
function isLogAnalytics(): boolean { ... }
invalidVariables.map((error) => ({ message: error.name }))
This ensures code is self-documenting and maintains consistency across the codebase.
Enter the URL of a public GitHub repository