-
Notifications
You must be signed in to change notification settings - Fork 71
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
Add guide on using Chai with ESM and plugins #206
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43081j
reviewed
May 3, 2024
43081j
approved these changes
May 3, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good work here!
it may be worth mentioning, if we continue supporting root mutation, that you now need to use the return value:
import {use} from 'chai';
import somePlugin from 'chai-whatever';
const chai = use(somePlugin);
chai.somePluginRootExport();
Figured I'd piggy-back on this PR to land some docs for chaijs/chai#1617 as well. |
koddsson
pushed a commit
that referenced
this pull request
May 15, 2024
Revert "Merge pull request #206 from chaijs/koddsson/add-esm-guide"
koddsson
pushed a commit
that referenced
this pull request
May 15, 2024
Add guide on using Chai with ESM and plugins
koddsson
pushed a commit
that referenced
this pull request
May 16, 2024
Add guide on using Chai with ESM and plugins
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a comprehensive guide on using Chai with ECMAScript Modules (ESM) and plugins, specifically focusing on the chai-http plugin and best practices for plugin authors to expose globals sustainably.
_guides/index.md
file is updated to include a link to the new guide under the "Basics" section, ensuring easy access for users looking to integrate Chai with ESM and plugins._guides/index.md
, a new subsection is introduced, offering guidance to plugin authors on how to expose globals in a sustainable manner, with examples of good and potentially problematic practices.See chaijs/chai#1569 (comment)
For more details, open the Copilot Workspace session.