Skip to content

Commit bdaf2f5

Browse files
kdy1github-actions[bot]
kdy1
and
github-actions[bot]
authored
docs: add descriptions to plugin README.tmpl.md files (#598)
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](https://claude.ai/code) Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Donny/강동윤 <kdy1@users.noreply.github.com>
1 parent c84bfc9 commit bdaf2f5

12 files changed

Lines changed: 22 additions & 2 deletions

File tree

‎packages/jest/README.tmpl.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# @swc/plugin-jest
22

3+
`@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.
4+
35
${CHANGELOG}

‎packages/loadable-components/README.tmpl.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# loadable-components
22

3+
`@swc/plugin-loadable-components` transforms `@loadable/component` dynamic imports to support server-side rendering (SSR) and code splitting. It is the SWC equivalent of the `@loadable/babel-plugin` and enables the full `@loadable/component` SSR workflow when using SWC as your compiler.
4+
35
## Config
46

57
```json

‎packages/noop/README.tmpl.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# @swc/plugin-noop
22

3+
`@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.
4+
35
${CHANGELOG}

‎packages/react-remove-properties/README.tmpl.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# react-remove-properties
22

3-
See https://nextjs.org/docs/architecture/nextjs-compiler#remove-react-properties for more information.
3+
`@swc/plugin-react-remove-properties` removes React component properties (such as `data-testid`) from your production builds. This is useful for stripping test-only attributes that you don't want shipped to end users. See https://nextjs.org/docs/architecture/nextjs-compiler#remove-react-properties for more information.
44

55
## Config
66

‎packages/relay/README.tmpl.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
### `@swc/plugin-relay`
22

3+
`@swc/plugin-relay` compiles Relay GraphQL `graphql` tagged template literals into the corresponding Relay-generated artifact imports. It is the SWC equivalent of `babel-plugin-relay`, enabling projects that use the Relay framework to leverage SWC for faster compilation.
4+
35
#### Setup
46

57
```sh

‎packages/remove-console/README.tmpl.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# remove-console
22

3-
See https://nextjs.org/docs/architecture/nextjs-compiler#remove-console for more information.
3+
`@swc/plugin-remove-console` strips `console.*` calls from your production builds, helping to reduce bundle size and avoid leaking debug information to end users. You can optionally exclude specific console methods (e.g. `console.error`) from removal. See https://nextjs.org/docs/architecture/nextjs-compiler#remove-console for more information.
44

55
## Config
66

‎packages/styled-components/README.tmpl.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
### `@swc/plugin-styled-components`
22

3+
`@swc/plugin-styled-components` is the SWC equivalent of `babel-plugin-styled-components`. It adds display names to styled-components for better debugging, generates deterministic class names for server-side rendering (SSR), and enables other optimizations provided by the styled-components Babel plugin.
4+
35
#### Setup
46

57
```sh

‎packages/styled-jsx/README.tmpl.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# @swc/plugin-styled-jsx
22

3+
`@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.
4+
35
${CHANGELOG}

‎packages/swc-confidential/README.tmpl.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @swc/plugin-swc-confidential
22

3+
`@swc/plugin-swc-confidential` encrypts string literals marked with the `/*#__CONFIDENTIAL__*/` comment using AES encryption at build time. This lets you ship sensitive strings (such as feature flag names or identifiers) in an obfuscated form so they are not trivially readable in your production bundle.
4+
35
## Usage
46

57
.swcrc:

‎packages/swc-magic/README.tmpl.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @swc/plugin-swc-magic
22

3+
`@swc/plugin-swc-magic` processes magic annotations from the `@swc/magic` package, such as `markAsPure`, which annotates expressions so the SWC minifier can eliminate them as dead code during tree-shaking.
4+
35
## Usage
46

57
.swcrc:

0 commit comments

Comments
 (0)