# Code Patterns

> Common code patterns for this project. Use when implementing features or handling errors. Use when this capability is needed.

- Skill: `tomevault-io/code-patterns` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/code-patterns`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/code-patterns/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: AI & ML
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/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

```typescript
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

```typescript
// 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`):

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

Code smell patterns:

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

## Service Layer

All GitHub API calls must go through `GitHubService`:

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

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

---
> Converted and distributed by [TomeVault](https://tomevault.io/claim/jamesjfoong) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-13 -->