search

shogo82148 / a1notation

MIT License
0 stars 0 forks source link

make A1Notation immutable #6

Closed shogo82148 closed 4 months ago

shogo82148 commented 4 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The recent changes to the A1Notation class in mod.ts improve its design by making key properties read-only, thereby enhancing integrity and preventing modifications post-instantiation. The constructor logic has been streamlined for direct assignment of parsed values, promoting immutability and predictability. Furthermore, tests have been updated to reflect these changes, ensuring that invalid inputs are handled appropriately.

Changes

Files Change Summary
mod.ts Converted properties sheetName, left, top, right, and bottom to read-only. Updated constructor logic to streamline object creation.
mod.test.ts Introduced new test cases for invalid parameters in A1Notation. Modified existing tests to directly pass values to the constructor, improving conciseness.

Poem

In the garden where the code does play,
A rabbit hops, with changes on the way.
Properties now locked tight like a treasure,
Immutable delight, oh what a pleasure!
With each hop and bound, the code feels bright,
In this land of logic, everything’s just right! 🐇✨

Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` - `@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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@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.` 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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 97.06%. Comparing base (bb45ad2) to head (080ff82).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #6 +/- ## ========================================== + Coverage 96.85% 97.06% +0.21% ========================================== Files 1 1 Lines 286 307 +21 Branches 75 89 +14 ========================================== + Hits 277 298 +21 Misses 9 9 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.