-
-
Notifications
You must be signed in to change notification settings - Fork 98
docs: add descriptions to plugin README.tmpl.md files #598
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| # @swc/plugin-jest | ||
|
|
||
| `@swc/plugin-jest` is a drop-in replacement for `babel-jest` that uses SWC to transform your code, enabling significantly faster Jest-based testing. It integrates with Jest's transformation pipeline so you can run your test suite with minimal configuration changes. | ||
|
|
||
| ${CHANGELOG} | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| # @swc/plugin-noop | ||
|
|
||
| `@swc/plugin-noop` is a no-operation SWC plugin that passes code through without any transformation. It is useful for testing the SWC plugin system, benchmarking plugin infrastructure overhead, and as a template for building new plugins. | ||
|
|
||
| ${CHANGELOG} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| # @swc/plugin-styled-jsx | ||
|
|
||
| `@swc/plugin-styled-jsx` transforms `<style jsx>` tags in JSX components into scoped CSS, providing component-level style isolation. It is the SWC equivalent of the `styled-jsx` Babel plugin used by Next.js. | ||
|
|
||
| ${CHANGELOG} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| # @swc/plugin-swc-sdk | ||
|
|
||
| `@swc/plugin-swc-sdk` provides build-time transformations from the `@swc/sdk` package. It supports converting static imports annotated with `/*#__DYNAMIC__*/` into dynamic imports, and processes `markAsPure` annotations so the SWC minifier can tree-shake the marked expressions. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This summary advertises a transform that the plugin source does not implement. In the code I checked, Useful? React with 👍 / 👎. |
||
|
|
||
| # Usage | ||
|
|
||
| .swcrc: | ||
|
|
||
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.
Users who choose packages from the README summary will install the wrong tool here.
packages/jest/src/lib.rs:20-94only implements Jest-hoist-style reordering ofjest.mock/unmock/enableAutomockcalls invisit_mut_stmt_like; it does not provide Jest's transformer interface. Describing this package as a “drop-in replacement forbabel-jest” will send Jest users to a plugin that cannot run their test suite on its own.Useful? React with 👍 / 👎.