js-conventions

JavaScript Code Style

Use following conventions for JavaScript and TypeScript code.

Preparations

• Add to dev dependencies in package.json if not added:
  • eslint-config-metarhia
  • eslint, prettier
• Add scripts in package.json if not added:
  • "lint": "eslint . && prettier --check "/*.js" "/.json" "**/.md" "*/.ts""
  • "fix": "eslint . --fix && prettier --write "/*.js" "/.json" "**/.md" "*/.ts""
• Before and after code analysis with AI run npm run lint and npm t
• Use npm run fix if errors/warnings detected to auto-fix when possible

Formatting

• Use single quotes and semicolons
• Keep max line length 80 (ignore URLs)
• Use trailing commas in multiline arrays, objects, and params
• Keep one empty line between semantic blocks
• Follow Prettier and eslint-config-metarhia for spacing, braces, and indentation

Naming

• Use camelCase for variables and parameters
• Use UpperCamelCase for classes and types
• Use UPPER_SNAKE_CASE for constants
• Use new with capitalized constructor names
• Use error in catch blocks, not err
• Use short names (e, i) only in short one-line callbacks
• Use descriptive names in multiline callbacks (event, index, item)
• Use boolean prefixes: is, has, can, should
• Use singular names for entities and plural names for collections
• Use verb names for functions and handlers (parse, create, handle, on)
• Include units in numeric names (timeoutMs, sizeBytes) except options

Best practices

• Prefer const, minimize let, never use var
• Prefer arrow functions (except prototype/class methods)
• Do not mutate input parameters; avoid arguments
• Keep functions small and single-purpose
• Decompose long expressions into intermediate variables
• Prefer explicit loops (for, for..of) in hot paths
• Use array methods when they improve readability
• Use === and !== only
• Keep return types consistent
• Avoid nested ternaries and deep callback nesting
• Self-documented and self-descriptive code: do not add obvious comments, code should be clear without comments
• Use iteration methods like .map, .filter, .reduce if it is good for code semantic
• Try to avoid .forEach if callback operates with outer context