Instruction file imported from AndyHsuTW/everything-llm-workspace (.github/instructions/typescript/coding-style.instructions.md). Copyright stays with the author.

TypeScript/JavaScript Coding Style

Extends common coding style with TypeScript/JavaScript specifics.

Immutability

Use spread operator for immutable updates:

// WRONG: Mutation
function updateUser(user, name) {
  user.name = name  // MUTATION!
  return user
}

// CORRECT: Immutability
function updateUser(user, name) {
  return {
    ...user,
    name
  }
}

Error Handling

Use async/await with try-catch:

try {
  const result = await riskyOperation()
  return result
} catch (error) {
  console.error('Operation failed:', error)
  throw new Error('Detailed user-friendly message')
}

Input Validation

Use Zod for schema-based validation:

import { z } from 'zod'

const schema = z.object({
  email: z.string().email(),
  age: z.number().int().min(0).max(150)
})

const validated = schema.parse(input)

Console.log

• No console.log statements in production code
• Use proper logging libraries instead