Code Patterns

Code Patterns

When to Use

• Implementing new features
• Handling GitHub API calls
• Adding code analysis patterns
• Writing type-safe code

GitHub API Error Handling

try {
  const result = await this.octokit.pulls.get({
    owner: params.owner,
    repo: params.repo,
    pull_number: params.prNumber,
  });
  return result.data;
} catch (error) {
  const message = error instanceof Error ? error.message : String(error);
  console.error("Error fetching PR:", message);
  throw new Error(`Failed to fetch PR: ${message}`);
}

• Rate limiting: automatic via @octokit/plugin-throttling
• Pagination: use @octokit/plugin-paginate-rest
• Auth: ensure GITHUB_TOKEN in .env

Type-Safe Code

// CORRECT - Explicit type definition
export const PRParamsSchema = z.object({
  owner: z.string(),
  repo: z.string(),
  prNumber: z.number(),
});

export interface PRParams {
  owner: string;
  repo: string;
  prNumber: number;
}

// CORRECT - use optional property
interface GoodType {
  value?: string;
}

// CORRECT - use optional chaining when accessing
const result = obj?.value ?? "default";

Adding Analysis Patterns

Security patterns (src/code-analyzer.ts):

{
  pattern: /your-regex-pattern/gi,
  message: "Description of the issue",
}

Code smell patterns:

{
  pattern: /your-regex-pattern/g,
  message: "Description of the smell",
}

Service Layer

All GitHub API calls must go through GitHubService:

// CORRECT
const result = await githubService.getPRDetails(params);

// WRONG - bypasses service
const result = await octokit.pulls.get({...});

Converted and distributed by TomeVault — claim your Tome and manage your conversions.