Clean Names

Clean Names

N1: Choose Descriptive Names

Names should reveal intent. If a name requires a comment, it doesn't reveal its intent.

// Bad - what is d?
const d = 86400;

// Good - obvious meaning
const SECONDS_PER_DAY: number = 86400;

// Bad - what does this function do?
function proc(lst: number[]): number[] {
    return lst.filter(x => x > 0);
}

// Good - intent is clear
const filterPositiveNumbers = (numbers: number[]): number[] => {
    return numbers.filter((n: number): boolean => n > 0);
};

N2: Choose Names at the Appropriate Level of Abstraction

Don't pick names that communicate implementation; choose names that reflect the level of abstraction of the class or function.

// Bad - too implementation-specific
function getMapOfUserIdsToNames(): Map<string, string> {
    // ...
}

// Good - abstracts the data structure
const getUserDirectory = (): UserDirectory => {
    // ...
};

N3: Use Standard Nomenclature Where Possible

Use terms from the domain, design patterns, or well-known conventions.

// Good - uses pattern name
class UserFactory {
    create(data: UserData): User { /* ... */ }
}

// Good - uses domain term
const calculateAmortization = (principal: number, rate: number, term: number): number => {
    // ...
};

N4: Unambiguous Names

Choose names that make the workings of a function or variable unambiguous.

// Bad - ambiguous
function rename(old: string, newName: string): void {
    // ...
}

// Good - clear what's being renamed
const renameFile = (oldPath: string, newPath: string): void => {
    // ...
};

N5: Use Longer Names for Longer Scopes

Short names are fine for tiny scopes. Longer scopes need longer, more descriptive names.

// Good - short name for tiny scope
const total: number = numbers.reduce(
    (sum: number, value: number): number => sum + value,
    0
);

// Good - longer name for module-level constant
const MAX_RETRY_ATTEMPTS_BEFORE_FAILURE: number = 5;

// Bad - short name at module level
const MAX = 5;

N6: Avoid Encodings

Don't encode type or scope information into names. Modern editors make this unnecessary.

// Bad - Hungarian notation
const strName = "Alice";
const arrUsers: User[] = [];
const nCount = 0;

// Good - clean names
const name: string = "Alice";
const users: User[] = [];
const count: number = 0;

// Bad - interface prefix
interface IUserRepository {
    // ...
}

// Good - just name it
interface UserRepository {
    // ...
}

N7: Names Should Describe Side Effects

If a function does something beyond what its name suggests, the name is misleading.

// Bad - name doesn't mention file creation
function getConfig(): Config {
    if (!fs.existsSync(configPath)) {
        fs.writeFileSync(configPath, "{}");  // Hidden side effect!
    }
    return JSON.parse(fs.readFileSync(configPath, "utf-8"));
}

// Good - name reveals behavior
const getOrCreateConfig = (): Config => {
    if (!fs.existsSync(configPath)) {
        fs.writeFileSync(configPath, "{}");
    }
    return JSON.parse(fs.readFileSync(configPath, "utf-8"));
};

Quick Reference