1.0.0 • Published 1 year ago

swc-plugin-transform-imp v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

swc-plugin-transform-imp

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

Installation

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

Usage

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

{
  "jsc": {
    "experimental": {
      "plugins": [
        [
          "swc-plugin-transform-imp",
          {
            "antd": {
              "transform": "antd/es/${member}",
              "skipDefaultConversion": false,
              "preventFullImport": true,
              "style": "antd/es/${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/es/button';
import BackTop from 'antd/es/back-top';
import 'antd/es/back-top/style';
import 'antd/es/button/style';
import merge from 'lodash/merge';

Options

NameTypeRequiredDefaultDescription
transformstringyesundefinedThe 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.
preventFullImportbooleannotrueWhether or not to throw when an import is encountered which would cause the entire module to be imported.
skipDefaultConversionbooleannofalseWhen set to true, will preserve import { X } syntax instead of converting to import X.
stylestringnofalseThe style path of the member, ${member} will be replaced with the member, aka Grid/Row/Col/etc.
memberTransformersArray<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"

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
          }
        ]
      ]
    }
  },
  ...
}