Skip to content

Fix stale codebase example in README.invariant.md #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ooloth wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −9
Open

Fix stale codebase example in README.invariant.md #108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions utils/errors/README.invariant.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,16 +181,12 @@ function getPost(slug: string) {

## Examples from Codebase

### Good: Post-Validation Assertion
### Good: Pre-Condition Guard

```typescript
// lib/cloudinary/fetchCloudinaryImageMetadata.ts
// Zod has already validated width/height are numbers
invariant(metadata.width > 0 && metadata.height > 0, 'Image dimensions must be positive', {
width: metadata.width,
height: metadata.height,
publicId,
})
// io/cloudinary/fetchCloudinaryImageMetadata.ts
// publicId has already been parsed from a validated Cloudinary URL
invariant(publicId.trim().length > 0, 'generateResponsiveImageUrls: publicId must not be empty')
```

### Good: Documenting Complete Mapping
Expand All @@ -205,7 +201,7 @@ invariant(ariaLabel, 'Emoji must have aria-label', { symbol })
### Bad: Checking Function That Throws

```typescript
// lib/cloudinary/fetchCloudinaryImageMetadata.ts (old code)
// io/cloudinary/fetchCloudinaryImageMetadata.ts (old code, before this pattern was removed)
const publicId = parsePublicIdFromCloudinaryUrl(url)
invariant(publicId, 'Parser must find publicId')
// BAD: parsePublicIdFromCloudinaryUrl throws if it can't parse
Expand Down
Loading