Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Resolve a Type conflict on FlatfileClient #52

Closed
wants to merge 3 commits into from

Conversation

theycallmeswift
Copy link

Currently we have a conflict between the FlatfileClient type namespace and the class itself. If you try to instantiate a FlatfileClient object, you will get the following error:

Type 'typeof FlatfileClient' has no construct signatures.

  const client = new FlatfileClient();

I've also added a Jest test that will fail if this regresses in the future.

Copy link

coderabbitai bot commented Jul 26, 2024

Warning

Rate limit exceeded

@theycallmeswift has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 33 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

Files that changed from the base of the PR and between 4d1788c and 254773c.

Walkthrough

The recent updates introduce significant enhancements to the CI workflow, formatting rules for YAML files, and the FlatfileClient API. A new testing step has been added to the CI process to ensure that tests are executed immediately after building, improving code quality. Additionally, the visibility of internal interfaces in the FlatfileClient has been enhanced by exporting them, and the test suite for FlatfileClient has been restructured to ensure effective coverage.

Changes

File Change Summary
.github/workflows/ci.yml Added a "Run tests" job to execute yarn run test after the "Compile" job, enhancing CI processes.
.prettierrc.yml Introduced overrides to set tabWidth: 2 for *.yml files, while maintaining the default tabWidth: 4 for others.
src/Client.ts Exported Options and RequestOptions interfaces in the FlatfileClient namespace for better modularity.
tests/client.test.ts Replaced previous content with a focused test suite to verify instantiation of FlatfileClient.

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

@theycallmeswift theycallmeswift changed the title Resolve a Type conflict on FlatfileClient Fix: Resolve a Type conflict on FlatfileClient Jul 26, 2024
@theycallmeswift theycallmeswift self-assigned this Jul 26, 2024
@theycallmeswift theycallmeswift added the bug Something isn't working label Jul 26, 2024
@theycallmeswift
Copy link
Author

This is actually a non-issue. Closing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant