Skip to content

Rename category enums from snake_case to kebab-case #116

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

Merged
invisiblemask merged 1 commit into from
Apr 2, 2026
Merged

Rename category enums from snake_case to kebab-case #116

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions .changeset/kebab-case-categories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@everipedia/iq-utils": major
---

Rename category enum values from snake_case to kebab-case
4 changes: 2 additions & 2 deletions src/schema/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,10 +179,10 @@ export type Tag = z.infer<typeof Tag>;

export const Category = z.enum([
"people",
"projects_and_protocols",
"projects-and-protocols",
"organizations",
"cryptoassets",
"exchanges_and_marketplaces",
"exchanges-and-marketplaces",
Comment on lines +182 to +185
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While the intent to use kebab-case is clear, this change introduces an inconsistency with other string enums in this file. For instance, CommonMetaIds consistently uses snake_case for multi-word values (e.g., contract_url, facebook_profile). The EditSpecificMetaIds enum is also inconsistent, with both snake_case and kebab-case values.

To improve overall consistency, I recommend one of two approaches:

  1. Expand this PR to convert other similar enums (like CommonMetaIds) to kebab-case. Since this is already a major breaking change, it's a good opportunity to bundle these related changes.
  2. If a broader change is not feasible, consider reverting this change to maintain consistency with the prevalent snake_case style.

A consistent naming convention is crucial for long-term maintainability.

Suggested change
"projects-and-protocols",
"organizations",
"cryptoassets",
"exchanges_and_marketplaces",
"exchanges-and-marketplaces",
"projects_and_protocols",
"organizations",
"cryptoassets",
"exchanges_and_marketplaces",
References
  1. Adhering to a consistent naming convention for identifiers like enum members improves code readability and maintainability, reducing cognitive load for developers.

"events",
]);
export type Category = z.infer<typeof Category>;
Expand Down
Loading