Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ant-design/babel-plugin-import
Modularly import plugin for babel.
https://github.com/ant-design/babel-plugin-import
Last synced: 3 months ago
JSON representation
Modularly import plugin for babel.
- Host: GitHub
- URL: https://github.com/ant-design/babel-plugin-import
- Owner: umijs
- Created: 2015-11-19T08:54:04.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T12:41:03.000Z (6 months ago)
- Last Synced: 2024-05-19T08:43:48.057Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.51 MB
- Stars: 3,144
- Watchers: 43
- Forks: 402
- Open Issues: 130
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - babel-plugin-import - Modularly import plugin for babel. (JavaScript)
- awesome-list - babel-plugin-import - design | 2761 | (JavaScript)
- awesome-made-by-chinese - babel-plugin-import
README
# babel-plugin-import
Modular import plugin for babel, compatible with [antd](https://github.com/ant-design/ant-design), [antd-mobile](https://github.com/ant-design/ant-design-mobile), lodash, [material-ui](http://material-ui.com/), and so on.
[](https://npmjs.org/package/babel-plugin-import)
[](https://travis-ci.org/ant-design/babel-plugin-import)
----
## Why babel-plugin-import
- [English Instruction](https://ant.design/docs/react/getting-started#Import-on-Demand)
- [中文说明](https://ant.design/docs/react/getting-started-cn#%E6%8C%89%E9%9C%80%E5%8A%A0%E8%BD%BD)
## Where to add babel-plugin-import
- [babelrc](https://babeljs.io/docs/usage/babelrc/)
- [babel-loader](https://github.com/babel/babel-loader)
## Example
#### `{ "libraryName": "antd" }`
```javascript
import { Button } from 'antd';
ReactDOM.render(xxxx);
↓ ↓ ↓ ↓ ↓ ↓
var _button = require('antd/lib/button');
ReactDOM.render(<_button>xxxx);
```
#### `{ "libraryName": "antd", style: "css" }`
```javascript
import { Button } from 'antd';
ReactDOM.render(xxxx);
↓ ↓ ↓ ↓ ↓ ↓
var _button = require('antd/lib/button');
require('antd/lib/button/style/css');
ReactDOM.render(<_button>xxxx);
```
#### `{ "libraryName": "antd", style: true }`
```javascript
import { Button } from 'antd';
ReactDOM.render(xxxx);
↓ ↓ ↓ ↓ ↓ ↓
var _button = require('antd/lib/button');
require('antd/lib/button/style');
ReactDOM.render(<_button>xxxx);
```
Note : with `style: true` css source files are imported and optimizations can be done during compilation time. With `style: "css"`, pre bundled css files are imported as they are.
`style: true` can reduce the bundle size significantly, depending on your usage of the library.
## Usage
```bash
npm install babel-plugin-import --save-dev
```
Via `.babelrc` or babel-loader.
```js
{
"plugins": [["import", options]]
}
```
### options
`options` can be object.
```javascript
{
"libraryName": "antd",
"style": true, // or 'css'
}
```
```javascript
{
"libraryName": "lodash",
"libraryDirectory": "",
"camel2DashComponentName": false, // default: true
}
```
```javascript
{
"libraryName": "@material-ui/core",
"libraryDirectory": "components", // default: lib
"camel2DashComponentName": false, // default: true
}
```
~`options` can be an array.~ It's not available in babel@7+
For Example:
```javascript
[
{
"libraryName": "antd",
"libraryDirectory": "lib", // default: lib
"style": true
},
{
"libraryName": "antd-mobile"
},
]
```
`Options` can't be an array in babel@7+, but you can add plugins with name to support multiple dependencies.
For Example:
```javascrit
// .babelrc
"plugins": [
["import", { "libraryName": "antd", "libraryDirectory": "lib"}, "antd"],
["import", { "libraryName": "antd-mobile", "libraryDirectory": "lib"}, "antd-mobile"]
]
```
#### style
- `["import", { "libraryName": "antd" }]`: import js modularly
- `["import", { "libraryName": "antd", "style": true }]`: import js and css modularly (LESS/Sass source files)
- `["import", { "libraryName": "antd", "style": "css" }]`: import js and css modularly (css built files)
If option style is a `Function`, `babel-plugin-import` will auto import the file which filepath equal to the function return value. This is useful for the components library developers.
e.g.
- ``["import", { "libraryName": "antd", "style": (name) => `${name}/style/2x` }]``: import js and css modularly & css file path is `ComponentName/style/2x`
If a component has no style, you can use the `style` function to return a `false` and the style will be ignored.
e.g.
```js
[
"import",
{
"libraryName": "antd",
"style": (name: string, file: Object) => {
if(name === 'antd/lib/utils'){
return false;
}
return `${name}/style/2x`;
}
}
]
```
#### styleLibraryDirectory
- `["import", { "libraryName": "element-ui", "styleLibraryDirectory": "lib/theme-chalk" }]`: import js and css modularly
If `styleLibraryDirectory` is provided (default `null`), it will be used to form style file path,
`style` will be ignored then. e.g.
```javascript
{
"libraryName": "element-ui",
"styleLibraryDirectory": "lib/theme-chalk",
}
import { Button } from 'element-ui';
↓ ↓ ↓ ↓ ↓ ↓
var _button = require('element-ui/lib/button');
require('element-ui/lib/theme-chalk/button');
```
#### customName
We can use `customName` to customize import file path.
For example, the default behavior:
```typescript
import { TimePicker } from "antd"
↓ ↓ ↓ ↓ ↓ ↓
var _button = require('antd/lib/time-picker');
```
You can set `camel2DashComponentName` to `false` to disable transfer from camel to dash:
```typescript
import { TimePicker } from "antd"
↓ ↓ ↓ ↓ ↓ ↓
var _button = require('antd/lib/TimePicker');
```
And finally, you can use `customName` to customize each name parsing:
```js
[
"import",
{
"libraryName": "antd",
"customName": (name: string, file: object) => {
const filename = file.opts.filename;
if (name === 'TimePicker'){
return 'antd/lib/custom-time-picker';
}
if (filename.indexOf('/path/to/my/different.js') >= 0) {
return 'antd/lib/custom-name';
}
return `antd/lib/${name}`;
}
}
]
```
So this result is:
```typescript
import { TimePicker } from "antd"
↓ ↓ ↓ ↓ ↓ ↓
var _button = require('antd/lib/custom-time-picker');
```
In some cases, the transformer may serialize the configuration object. If we set the `customName` to a function, it will lost after the serialization.
So we also support specifying the customName with a JavaScript source file path:
```js
[
"import",
{
"libraryName": "antd",
"customName": require('path').resolve(__dirname, './customName.js')
}
]
```
The `customName.js` looks like this:
```js
module.exports = function customName(name) {
return `antd/lib/${name}`;
};
```
#### customStyleName
`customStyleName` works exactly the same as customName, except that it deals with style file path.
#### transformToDefaultImport
Set this option to `false` if your module does not have a `default` export.
### Note
babel-plugin-import will not work properly if you add the library to the webpack config [vendor](https://webpack.js.org/concepts/entry-points/#separate-app-and-vendor-entries).