Skip to content

Fix FormError component TypeScript error: make name prop truly optional with default '_form'#117

Merged
jaruesink merged 3 commits into
mainfrom
copilot/fix-a8efc617-34f3-479f-9120-1d323e282ceb
Aug 7, 2025
Merged

Fix FormError component TypeScript error: make name prop truly optional with default '_form'#117
jaruesink merged 3 commits into
mainfrom
copilot/fix-a8efc617-34f3-479f-9120-1d323e282ceb

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 7, 2025

Problem

The FormError component was causing a TypeScript error when used without props, even though it has a default value for the name prop:

// This should work but caused TypeScript error:
<FormError />

// Error: Property 'name' is missing in type '{}' but required in type 'FormErrorProps'

Root Cause

The issue was in the FormErrorProps type definition:

export type FormErrorProps = Omit<FormErrorFieldProps, 'control'> & {
  name?: string;
};

This created a type conflict where:

  1. Omit<FormErrorFieldProps, 'control'> kept name as required (from the original FormErrorFieldProps)
  2. The intersection & { name?: string } tried to make it optional
  3. TypeScript resolved this conflict by keeping name required

Solution

Replaced the problematic Omit + intersection approach with an explicit type definition:

export type FormErrorProps = {
  name?: string;
  className?: string;
  components?: Partial<FieldComponents>;
};

This makes the name prop truly optional while maintaining all functionality and type safety.

Validation

The fix enables all these usage patterns to work correctly:

// Default behavior (uses '_form')
<FormError />

// Explicit default
<FormError name="_form" />

// Custom error key
<FormError name="loginError" />

// With additional props
<FormError className="error-styles" />
  • ✅ TypeScript compilation passes
  • ✅ Component builds successfully
  • ✅ Generated .d.ts shows name?: string (properly optional)
  • ✅ Runtime behavior unchanged - name defaults to '_form'
  • ✅ All existing tests pass
  • ✅ Backward compatible with existing usage

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • storybook.js.org
    • Triggering command: /usr/local/bin/node /home/REDACTED/work/forms/forms/node_modules/storybook/bin/index.cjs build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 7, 2025

📝 Storybook Preview: View Storybook

This preview will be updated automatically when you push new changes to this PR.

Note: The preview will be available after the workflow completes and the PR is approved for deployment.

… '_form'

Co-authored-by: jaruesink <4207065+jaruesink@users.noreply.github.com>
Copilot AI changed the title [WIP] I'll help you diagnose this TypeScript error with your FormError component. Let me first examine the component's implementation and then look at how it's being used in the LoginForm.tsx file.Looking at your FormError component code, I can see the i... Fix FormError component TypeScript error: make name prop truly optional with default '_form' Aug 7, 2025
Copilot AI requested a review from jaruesink August 7, 2025 01:35
@jaruesink jaruesink marked this pull request as ready for review August 7, 2025 01:39
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Aug 7, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

Support

Need help? Join our Discord community for assistance with any issues or questions.

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

@jaruesink
Copy link
Copy Markdown
Contributor

@codegen-sh please use npm to patch my components package with a summary message, don't publish it to npm we'll do that when it gets merged

1 similar comment
@jaruesink
Copy link
Copy Markdown
Contributor

@codegen-sh please use npm to patch my components package with a summary message, don't publish it to npm we'll do that when it gets merged

- Fixed FormError component TypeScript error by making name prop truly optional
- Resolved type conflict between Omit and intersection types
- Enables usage without props: <FormError />
- Maintains backward compatibility with existing code

Co-authored-by: Jake Ruesink <jake@lambdacurry.com>
@jaruesink jaruesink merged commit 461abfe into main Aug 7, 2025
5 checks passed
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.

2 participants