JS Best Practices

JavaScript Best Practices: Clean Code, Naming Conventions, & Defensiveness

Adhering to JavaScript best practices ensures code readability, maintainability, type safety, and defensive error handling across large engineering teams.

Core Engineering Principles

flowchart TD
    Principles["Clean JavaScript Principles"] --> Principle1["Use Modern ES6+ (const/let, destructuring, modules)"]
    Principles --> Principle2["Defensive Programming (Validate inputs & handle nulls)"]
    Principles --> Principle3["Strict Type Equality (Always use ===)"]
    Principles --> Principle4["Clean Naming Conventions (Meaningful camelCase names)"]

Code Quality Rules Checklist

Practical Code Example

// Demonstrating Clean Code, Guard Checks, and Defensive Programming

// 1. Self-Documenting Naming & Constants
const DEFAULT_TIMEOUT_MS = 5000;
const MAX_RETRY_LIMIT = 3;

/**
 * Defensive User Service Function
 */
class UserService {
  #usersList = [];

  constructor(initialUsers = []) {
    // Defensive type checking
    if (!Array.isArray(initialUsers)) {
      throw new TypeError("Initial users payload must be an array.");
    }
    this.#usersList = [...initialUsers]; // Defensive shallow copy
  }

  // Clean method with clear intent
  findUserById(targetUserId) {
    if (typeof targetUserId !== "number" || targetUserId <= 0) {
      console.warn("Invalid user ID provided to findUserById.");
      return null;
    }

    return this.#usersList.find(user => user.id === targetUserId) ?? null;
  }
}

const service = new UserService([{ id: 101, name: "Maksudur" }]);
const foundUser = service.findUserById(101);
console.log("Found User:", foundUser);

Best Practices & Gotchas

• Avoid Global State Pollution: Keep variables scoped inside modules, classes, or functions.
• Fail Fast & Defensively: Validate function parameters at the beginning of functions to catch errors early.
• Write Self-Documenting Code: Choose descriptive variable names (isPaymentVerified instead of chk).

Self-Check Challenge

Refactor function calc(d) { return d * 0.15; } into a clean, self-documenting function.