Skip to content

style: standardize schema naming conventions#98

Merged
ryoppippi merged 7 commits intomainfrom
naming
Jun 17, 2025
Merged

style: standardize schema naming conventions#98
ryoppippi merged 7 commits intomainfrom
naming

Conversation

@ryoppippi
Copy link
Owner

Summary

  • Standardize Valibot schema variable names to follow camelCase convention (variables start with lowercase)
  • Rename all schema variables from PascalCase to camelCase while keeping type names unchanged
  • Add naming conventions documentation to CLAUDE.md
  • Fix test command documentation in CLAUDE.md

Changes Made

Schema Renames (6 commits, one per schema):

  1. UsageDataSchemausageDataSchema

    • Main schema for Claude usage data from JSONL files
    • Updated in data-loader.ts and debug.ts
  2. ModelBreakdownSchemamodelBreakdownSchema

    • Schema for model-specific usage breakdown data
    • Updated all array references in other schemas
  3. DailyUsageSchemadailyUsageSchema

    • Schema for daily usage aggregation data
  4. SessionUsageSchemasessionUsageSchema

    • Schema for session-based usage aggregation data
  5. MonthlyUsageSchemamonthlyUsageSchema

    • Schema for monthly usage aggregation data
  6. ModelPricingSchemamodelPricingSchema

    • Schema for model pricing information from LiteLLM
    • Updated in types.internal.ts, macro.internal.ts, and pricing-fetcher.ts

Documentation Updates:

  • Added naming conventions to CLAUDE.md:
    • Variables: camelCase (e.g., usageDataSchema, modelBreakdownSchema)
    • Types: PascalCase (e.g., UsageData, ModelBreakdown)
    • Constants: UPPER_SNAKE_CASE (e.g., DEFAULT_CLAUDE_CODE_PATH)
  • Fixed test command documentation to use "bun run test"

Test Results

✅ All 164 tests pass
✅ TypeScript compilation successful
✅ ESLint formatting applied

Naming Convention Rationale

This change follows standard JavaScript/TypeScript conventions:

  • Variables (including schema definitions): start with lowercase letter
  • Types/Interfaces: start with uppercase letter
  • Constants: can use UPPER_SNAKE_CASE

The schemas are Valibot schema objects assigned to const variables, so they should follow variable naming conventions (camelCase), while the inferred types from these schemas correctly follow type naming conventions (PascalCase).

- Rename exported const UsageDataSchema to usageDataSchema for consistency with camelCase naming convention for variables
- Update all references in data-loader.ts and debug.ts
- Add naming conventions to CLAUDE.md (variables: camelCase, types: PascalCase, constants: UPPER_SNAKE_CASE)

This change follows the established naming convention where variables start with lowercase letters.
- Rename exported const ModelBreakdownSchema to modelBreakdownSchema for camelCase consistency
- Update type definition and all array references in other schemas
- ModelBreakdown type name remains uppercase as it is a type definition

This follows the naming convention where variables use camelCase starting with lowercase.
- Rename exported const DailyUsageSchema to dailyUsageSchema for camelCase consistency
- Update type definition to reference the new schema name
- DailyUsage type name remains uppercase as it is a type definition

This follows the naming convention where variables use camelCase starting with lowercase.
- Rename exported const SessionUsageSchema to sessionUsageSchema for camelCase consistency
- Update type definition to reference the new schema name
- SessionUsage type name remains uppercase as it is a type definition

This follows the naming convention where variables use camelCase starting with lowercase.
- Rename exported const MonthlyUsageSchema to monthlyUsageSchema for camelCase consistency
- Update type definition to reference the new schema name
- MonthlyUsage type name remains uppercase as it is a type definition

This follows the naming convention where variables use camelCase starting with lowercase.
- Rename exported const ModelPricingSchema to modelPricingSchema for camelCase consistency
- Update all imports and usages in macro.internal.ts and pricing-fetcher.ts
- Update type definition to reference the new schema name
- ModelPricing type name remains uppercase as it is a type definition

This follows the naming convention where variables use camelCase starting with lowercase.
- Update test command reference to use "bun run test" instead of just "bun test"
- Clarify that vitest runs via bun in the description
- Fix command in post-code change workflow section

This ensures the correct command is documented for running tests.
@coderabbitai
Copy link

coderabbitai bot commented Jun 17, 2025

Warning

Rate limit exceeded

@ryoppippi has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 4 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 887e86b and d3037c6.

📒 Files selected for processing (6)
  • CLAUDE.md (2 hunks)
  • src/data-loader.ts (9 hunks)
  • src/debug.ts (2 hunks)
  • src/macro.internal.ts (2 hunks)
  • src/pricing-fetcher.ts (2 hunks)
  • src/types.internal.ts (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @ryoppippi, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving code consistency and readability by enforcing a standardized naming convention for Valibot schemas. By aligning schema variable names with common JavaScript/TypeScript practices, the codebase becomes more intuitive and easier to navigate for developers. The changes are purely stylistic and include corresponding documentation updates to ensure adherence to the new guidelines.

Highlights

  • Code Style Standardization: I've standardized the naming conventions for Valibot schema variables across the codebase, transitioning them from PascalCase to camelCase to align with standard JavaScript/TypeScript variable naming practices.
  • Schema Renames: Specifically, I've renamed UsageDataSchema, ModelBreakdownSchema, DailyUsageSchema, SessionUsageSchema, MonthlyUsageSchema, and ModelPricingSchema to their camelCase equivalents (e.g., usageDataSchema). All references to these schemas, including type inferences and validation calls, have been updated accordingly.
  • Documentation Update: I've added a new section to CLAUDE.md outlining the adopted naming conventions for variables (camelCase), types (PascalCase), and constants (UPPER_SNAKE_CASE). This provides clear guidance for future development.
  • Minor Documentation Fix: I've also made a small correction in CLAUDE.md to clarify the bun run test command.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Jun 17, 2025

Open in StackBlitz

npm i https://pkg.pr.new/ryoppippi/ccusage@98

commit: d3037c6

@ryoppippi ryoppippi merged commit b1ba5c7 into main Jun 17, 2025
10 checks passed
@ryoppippi ryoppippi deleted the naming branch June 17, 2025 20:12
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request standardizes Valibot schema variable names to camelCase, aligning with common JavaScript/TypeScript conventions, and updates the CLAUDE.md documentation accordingly. The changes are applied consistently across all affected files, and the updated documentation clearly reflects the new naming conventions. This is a solid improvement for code clarity and maintainability, and no issues of medium or higher severity were found.

ryoppippi added a commit that referenced this pull request Jun 22, 2025
style: standardize schema naming conventions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant