swc-plugin-another-transform-imports

Another wasm plugin for swc, inspired from babel-plugin-transform-imports.

Installation

npm install --save-dev swc-plugin-another-transform-imports
# or
yarn add -D swc-plugin-another-transform-imports

Usage

It follows resolving rule of node.js, can be use in .swcrc，webpack.config.js or next.config.js and so on. For Example:

{
  "jsc": {
    "experimental": {
      "plugins": [
        [
          "swc-plugin-another-transform-imports",
          {
            "antd": {
              "transform": "antd/lib/${member}",
              "skipDefaultConversion": false,
              "preventFullImport": true,
              "style": "antd/lib/${member}/style",
              "memberTransformers": ["dashed_case"]
            },
            "lodash": {
              "transform": "lodash/${member}",
              "preventFullImport": true
            }
          }
        ]
      ]
    }
  }
}

Can convert the following lines:

import { Button as MyButton, BackTop } from 'antd';
import { merge } from 'lodash';

To:

import MyButton from 'antd/lib/button';
import BackTop from 'antd/lib/back-top';
import 'antd/lib/back-top/style';
import 'antd/lib/button/style';
import merge from 'lodash/merge';

For next.js users

Ensure you read next.js compiler docs first!!!!

Since the semantic version association of @swc/core (npm) and swc_core (rust) for next.js is still experimental. next.js has a lot of breaking change in the swc native plugin mechanism between major and even minor versions.

It is possible that as next.js and swc are updated, the current plugin will fail in the new version. Hopefully the new plugin api for swc will be stable soon. Here is the current version correspondence.

| next.js versions | This package version | |------------------|----------------------| | 12.3.x | 0.1.5 | | 13.0.x | 0.2.1 | | 13.2.4 ~ 13.3.1 | not support https://github.com/vercel/next.js/issues/46989#issuecomment-1486989081 | | 13.3.1 ~ 13.4.3 | 0.2.3 | | 13.4.3-canary.2 ~ 13.4.7(@swc/[email protected] ~ @swc/[email protected]) | 0.2.4 | | 13.4.8 ~ v13.4.10-canary.0(@swc/[email protected] ~ @swc/[email protected]) | 0.2.5 | | 13.4.10-canary.1 ~ (@swc/[email protected] ~ @swc/[email protected]) | 0.2.6 | | Unpublished (@swc/[email protected] ~ ) | 0.2.7 |

@swc/core and swc_core version mappings

For antd users

antd/es/xxx/style and antd/lib/xxx/style will introduce less, please add less-loader by yourself.

If you use antd and next.js at the same time, it will be a bit troublesome to work with them, you can use next-plugin-antd-less for convenience, see issue 1 for an example.

Options

| Name | Type | Required | Default | Description | |-------------------------|----------------------------|----------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------| | transform | string | yes | undefined | The library name to use instead of the one specified in the import statement. ${member} will be replaced with the member, aka Grid/Row/Col/etc. | | preventFullImport | boolean | no | true | Whether or not to throw when an import is encountered which would cause the entire module to be imported. | | skipDefaultConversion | boolean | no | false | When set to true, will preserve import { X } syntax instead of converting to import X. | | style | string | no | false | The style path of the member, ${member} will be replaced with the member, aka Grid/Row/Col/etc. | | memberTransformers | Array<MemberTransformer> | no | [] | Member transformers |

1. type MemberTransformer

type MemberTransformer = "camel_case" | "kebab_case" | "pascal_case" | "snake_case" | "upper_case" | "upper_first" | "lower_case" | "lower_first" | "dashed_case"

Common Issues

Usually upgrading to the latest version of @swc/core and other swc tools will solve the problem, see the following issue for typical solution:

1. plugin-styled-components crashes with 'Error while importing "env"."__get_transform_plugin_config": unknown import.'
2. about next.js and antd
3. about next.js 13+

Fork & Modify

You can simply fork this plugin, modify its source code to suit your custom needs. For fast validation, you don't necessarily have to publish the modified project, but simply require your wasm file to the project. For example:

cargo prepublish

or

npm run prepublish

Then copy your wasm target file, and set your config to:

module.exports = {
  ...,
  "jsc": {
    "experimental": {
      "plugins": [
        [
          require.resolve("./path/to/your-modified-plugin.wasm"),
          {
            ..your options
          }
        ]
      ]
    }
  },
  ...
}