feat: refine the type of CellStateStyle.elbow

[tbouffard]

This property can only take two values but the type allowed to specify any string.
Its type is now more precise to better guide usage.

Summary by CodeRabbit

• Refactor
  • Enhanced internal configuration by restricting orientation settings to only allow "horizontal" or "vertical" values, reducing the risk of incorrect configurations and promoting a more consistent experience.

[coderabbitai]

Walkthrough

This change updates the type definition for the elbow property in the CellStateStyle type. Instead of accepting any string, elbow is now restricted to only allow the literal values 'horizontal' or 'vertical'. This stricter type enforcement prevents invalid string assignments and increases type safety.

Changes

File(s)	Change Summary
packages/core/src/types.ts	Updated the elbow property in the CellStateStyle type from string to the union type `'horizontal'

Possibly related PRs

• refactor: migrate the "Animation" story to TypeScript #635: This PR introduced related type definitions around CellStyle with a focus on enhanced type safety, connecting it to the modifications made in this update.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • 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 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 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 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 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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/core/src/types.ts (1)

201-201: Good type refinement for better developer experience.

This change restricts the elbow property to only accept its documented valid values ('horizontal' or 'vertical'), improving type safety and discoverability through IDE autocompletion.

The change correctly matches the documentation comment above (lines 195-199) which states that the possible values are 'horizontal' and 'vertical'. This helps prevent errors where incorrect values might be passed to this property.

Since the default value is mentioned in the comment as 'horizontal', consider enforcing this in the type system:

-  elbow?: 'horizontal' | 'vertical';
+  elbow?: 'horizontal' | 'vertical' | undefined;

Even better would be to add a dedicated type for these values:

+export type ElbowValue = 'horizontal' | 'vertical';
+
/* ... */

-  elbow?: 'horizontal' | 'vertical';
+  elbow?: ElbowValue;

This would allow for reuse if this value type appears elsewhere in the codebase.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 18755d6 and daf2985.

📒 Files selected for processing (1)

• packages/core/src/types.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: build (windows-2022)
• GitHub Check: build (macos-14)
• GitHub Check: build (ubuntu-22.04)