# babel-plugin-style-import

> 按需加载组件库样式 loader

Latest version **0.0.4** (published 2019-05-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install babel-plugin-style-import
pnpm add babel-plugin-style-import
yarn add babel-plugin-style-import
bun add babel-plugin-style-import
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2019-05-21 |
| First published | 2019-05-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 27.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | pyrine.law |
| Maintainers | pyrinelaw |
| Keywords | style-import, components-style-import, babel-plugin-style-import, component-style-import |

## Links

- npm: https://www.npmjs.com/package/babel-plugin-style-import
- Repository: https://github.com/pyrinelaw/babel-plugin-style-import
- Homepage: https://github.com/pyrinelaw/babel-plugin-style-import#readme
- Issues: https://github.com/pyrinelaw/babel-plugin-style-import/issues
- npm.io page: https://npm.io/package/babel-plugin-style-import

## Dependencies (10)

- [colors](https://npm.io/package/colors.md) ^1.0.3
- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [hash-sum](https://npm.io/package/hash-sum.md) ^1.0.2
- [lru-cache](https://npm.io/package/lru-cache.md) ^4.0.1
- [babel-core](https://npm.io/package/babel-core.md) ^6.26.0
- [babel-types](https://npm.io/package/babel-types.md) ^6.26.0
- [loader-utils](https://npm.io/package/loader-utils.md) ^1.2.3
- [@babel/parser](https://npm.io/package/@babel/parser.md) ^7.1.6
- [@babel/generator](https://npm.io/package/@babel/generator.md) ^7.1.6
- [vue-template-compiler](https://npm.io/package/vue-template-compiler.md) ^2.1.8

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2019-05-21
- 0.0.3 — 2019-05-09
- 0.0.2 — 2019-05-09
- 0.0.1 — 2019-05-08

## README

### babel-plugin-style-import

webpack loader 组件，组件样式单独引入

达到类似效果：
``` javascript
import {
    DatePicker, 
    message, 
    Alert,
} from 'antd';
// => 
import 'antd/lib/date-picker/style/index.less';
import 'antd/lib/message/style/index.less';
import 'antd/lib/alert/style/index.less';
import {
    DatePicker, 
    message, 
    Alert,
} from 'antd';
```

### 配置示例
babel-plugin-style-import 需要在 loader 中优先执行，而 webpack 中
loader 又是倒序执行的，所以 babel-plugin-style-import 配置需要放置在最后

以 antd 与 vant 为例
``` javascript
const styleOptions = {
    list: [
        {
            // 组件库名称
            name: 'antd',
            // 文件转换规则，默认为'_',
            // 传入 style 参数为 Function 类型时， splitChart 将不生效
            splitChart: '-',
            // 样式文件名，css/scss/less 均可
            // 最终导出为 {{name}}/{{style}}
            style: 'lib/{{name}}/style/index.less',
        },
        {
            // npm 组件库名称
            name: 'vant',
            // 文件转换规则，默认使用下划线
            splitChart: undefined,
            // 自定义样式文件名，css/scss/less 均可
            // 最终生成路径 {{name}}/{{style}}
            // 未返回路径时，将不会 导入样式文件
            style: function(name, libraryOptions) {
                const stylePath = `lib/vant-css/${util.convertName(name, '-')}.css`;
                const completeStylePath = path.resolve(__dirname, `./node_modules/vant/${stylePath}`);
                
                if (fs.existsSync(completeStylePath)) {
                    return stylePath;
                } else {
                    console.warn(`The file ${stylePath} is not exists！`);
                }
            },
        }
    ]
};

rules: [
    {
        test: /\.vue$/,
        use: [
            {
                loader: 'vue-loader',
                options: {
                   ...
                },
            },
            {
                loader: 'babel-plugin-style-import',
                options: styleOptions,
            },
        ],
    },
    {
        test: /\.js$/,
        exclude: /node_modules/,
        use: [
            {
                loader: 'babel-loader',
                options: {
                    ...
                },
            },
            {
                loader: 'babel-plugin-style-import',
                options: styleOptions,
            },
        ],
    },
],
```

### 配置 Api
list [array]

| 参数 | 类型 | 是否必传 | 默认值 | 说明 |
| :------ | :------ | :------ | :------ | :------ | 
|name |String |是 | 无 |组件库名 | 
|splitChart |String |否 |'_' |组件文件夹拆分字符，('HeadBack', '_') => 'head_back'| 
|style |String 或 Function |否 |无 | 样式文件名，使用“{{name}}”进行替换，或者返回用户自定义style | 

style arguments [function]

| 参数 | 类型 | 说明 |
| :------ | :------ | :------ |
|name |String |子组件名 | 
|@return |String | 返回样式文件路径，不返回的情况下忽略输出 |

babel-import-style-import/util

``` javascript
const util = require('babel-plugin-style-import/lib/util.js');
util.convertName('HeadBack', '-');  // output 'head-back'
```

### github
[https://github.com/pyrinelaw/babel-plugin-style-import](https://github.com/pyrinelaw/babel-plugin-style-import)

### test 目录
- /test

---
_Source: https://npm.io/package/babel-plugin-style-import · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
