docs: add descriptions to plugin README.tmpl.md files

[kdy1]

Add descriptive introductions to 12 plugin README.tmpl.md files that were missing explanations of what the plugins do.

Fixes #200

Generated with Claude Code

[changeset-bot]

⚠️ No Changeset found

Latest commit: 0ed50bf

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[claude]

PR Review: docs: add descriptions to plugin README.tmpl.md files

Overall this is a helpful documentation improvement — adding plugin descriptions makes it much easier for users to understand what each package does at a glance. Most descriptions are accurate and well-written. However, there is one factual issue that should be addressed before merging.

Bug: Inaccurate description for @swc/plugin-jest

The description currently reads:

@swc/plugin-jest is a drop-in replacement for babel-jest that uses SWC to transform your code, enabling significantly faster Jest-based testing.

This is incorrect. Looking at the source code (packages/jest/src/lib.rs), @swc/plugin-jest is a SWC WASM plugin that hoists jest.mock(), jest.unmock(), jest.enableAutomock(), jest.disableAutomock(), and jest.deepUnmock() calls to the top of files — the same behavior as babel-plugin-jest-hoist.

The actual drop-in replacement for babel-jest is the separate @swc/jest package. This plugin runs within SWC's plugin system and handles the mock-hoisting transform specifically.

Suggested replacement:

`@swc/plugin-jest` is a SWC plugin that hoists `jest.mock()`, `jest.unmock()`, and related Jest API calls to the top of each file, matching the hoisting behavior of `babel-plugin-jest-hoist`. It is used alongside `@swc/jest` (the `babel-jest` replacement) to ensure Jest mocks work correctly when SWC is your compiler.

Minor observations (non-blocking)

• packages/relay/README.tmpl.md: Uses ### (H3) for the top-level heading while all other packages use # (H1). This is a pre-existing inconsistency, but worth noting since you're touching the file — aligning it would improve consistency.

• packages/swc-sdk/README.tmpl.md: Uses # Usage (H1) for the Usage section heading while other packages conventionally use ## Usage (H2). Also pre-existing.

• packages/transform-imports/README.tmpl.md: The example given (import Button from 'react-bootstrap/lib/Button') accurately matches the Config section immediately below, which is a nice touch.

• All other descriptions (loadable-components, noop, react-remove-properties, relay, remove-console, styled-components, styled-jsx, swc-confidential, swc-magic, swc-sdk, transform-imports) are factually accurate and well-written.

Summary

Please fix the @swc/plugin-jest description — it currently mischaracterizes the package in a way that could mislead users into thinking they don't need @swc/jest. The rest of the changes are good to go.

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0ed50bfd02

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[chatgpt-codex-connector]

Stop calling @swc/plugin-jest a babel-jest replacement

Users who choose packages from the README summary will install the wrong tool here. packages/jest/src/lib.rs:20-94 only implements Jest-hoist-style reordering of jest.mock/unmock/enableAutomock calls in visit_mut_stmt_like; it does not provide Jest's transformer interface. Describing this package as a “drop-in replacement for babel-jest” will send Jest users to a plugin that cannot run their test suite on its own.

Useful? React with 👍 / 👎.

[chatgpt-codex-connector]

Remove the nonexistent markAsPure claim from swc-sdk

This summary advertises a transform that the plugin source does not implement. In the code I checked, packages/swc-sdk/transform/src/config.rs:7-35 only exposes flag and dynamicImports settings, and packages/swc-sdk/transform/src/lib.rs:388-391 only invokes transform_flag in addition to the /*#__DYNAMIC__*/ handling earlier in the visitor. There is no markAsPure matcher or visitor anywhere under packages/swc-sdk/transform/src, so readers who depend on this documented behavior will not get the optimization they were promised.

Useful? React with 👍 / 👎.