Skip to content

Conversation

@tbouffard
Copy link
Member

@tbouffard tbouffard commented Aug 27, 2025

Use a single type for the input parameter and declare the returned type explicitly.

Summary by CodeRabbit

  • Refactor
    • Improved internal TypeScript typings to enhance type safety and editor tooling without changing runtime behavior or user-facing outcomes.
  • Documentation
    • Clarified inline developer guidance about nullish vs. falsy values to improve readability and maintenance for contributors.

Use a single type for the input parameter and declare the returned type explicitly.
@tbouffard tbouffard added the refactor Code refactoring label Aug 27, 2025
@coderabbitai
Copy link

coderabbitai bot commented Aug 27, 2025

Walkthrough

Converted the exported isNullish utility in packages/core/src/internal/utils.ts from a typed boolean-returning function to a TypeScript type guard (v is null | undefined), added a private JSDoc describing its intended use with falsy values, and kept the runtime check (v === null || v === undefined).

Changes

Cohort / File(s) Summary
Nullish utility update
packages/core/src/internal/utils.ts
Changed isNullish signature from `(v: string

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between cba343d and 6e80995.

📒 Files selected for processing (1)
  • packages/core/src/internal/utils.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/core/src/internal/utils.ts
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch refactor/internal_isNullish_improve_types_in_signature

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/core/src/internal/utils.ts (1)

37-42: Clarify JSDoc: this checks only null/undefined (not other falsy values).

Current wording suggests it handles falsy values too and uses “objects” inaccurately. Tighten the doc to prevent misuse.

-/**
- * Use this function to check for null or undefined values for objects having falsy values in addition to nullish values:
- *
- * - boolean (false)
- * - number (0)
- * - string (empty)
- *
- * @private not part of the public API, can be removed or changed without prior notice
- */
+/**
+ * Returns true if the input is null or undefined.
+ * Note: falsy-but-defined values (false, 0, '') are NOT considered nullish.
+ * Use this when you must allow falsy values but reject absent ones.
+ *
+ * @private not part of the public API, can be removed or changed without prior notice
+ */
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 25d024b and cba343d.

📒 Files selected for processing (1)
  • packages/core/src/internal/utils.ts (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: tbouffard
PR: maxGraph/maxGraph#849
File: packages/html/stories/DragSource.stories.js:98-101
Timestamp: 2025-06-13T07:48:10.300Z
Learning: User tbouffard prefers answers in English; avoid switching to other languages in future replies.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: build
  • GitHub Check: build (macos-14)
  • GitHub Check: build (ubuntu-24.04)
  • GitHub Check: build (windows-2022)
🔇 Additional comments (1)
packages/core/src/internal/utils.ts (1)

45-46: isNullish type-guard usage verified – safe to merge

All scans across .ts/.tsx files for array callbacks (filter, some, every, find), boolean‐typed function assignments, and re-exports returned no matches. There are no breaking usages introduced by this change. Merge away!

@sonarqubecloud
Copy link

@tbouffard tbouffard merged commit 336d4a6 into main Aug 27, 2025
2 checks passed
@tbouffard tbouffard deleted the refactor/internal_isNullish_improve_types_in_signature branch August 27, 2025 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

refactor Code refactoring

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant