# @zebing/vite-plugin-css-modules

> vitejs css modules 名称自动转化插件

Latest version **1.1.0** (published 2022-09-24) · ISC license · 0 weekly downloads

## Install

```sh
npm install @zebing/vite-plugin-css-modules
pnpm add @zebing/vite-plugin-css-modules
yarn add @zebing/vite-plugin-css-modules
bun add @zebing/vite-plugin-css-modules
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-09-24 |
| First published | 2021-03-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 97.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | zebing |
| Maintainers | zebing |
| Keywords | vue, vue3, babel, vite, css modules |

## Links

- npm: https://www.npmjs.com/package/@zebing/vite-plugin-css-modules
- Repository: https://github.com/zebing/vite-plugin-css-modules
- Homepage: https://github.com/zebing/vite-plugin-css-modules#readme
- Issues: https://github.com/zebing/vite-plugin-css-modules/issues
- npm.io page: https://npm.io/package/@zebing/vite-plugin-css-modules

## Dependencies (12)

- [precss](https://npm.io/package/precss.md) ^4.0.0
- [postcss](https://npm.io/package/postcss.md) ^8.2.4
- [querystring](https://npm.io/package/querystring.md) ^0.2.1
- [autoprefixer](https://npm.io/package/autoprefixer.md) ^10.2.6
- [postcss-modules](https://npm.io/package/postcss-modules.md) ^4.0.0
- [@vue/compiler-dom](https://npm.io/package/@vue/compiler-dom.md) ^3.0.11
- [@vue/compiler-sfc](https://npm.io/package/@vue/compiler-sfc.md) ^3.0.11
- [@vue/compiler-core](https://npm.io/package/@vue/compiler-core.md) ^3.0.11
- [postcss-modules-scope](https://npm.io/package/postcss-modules-scope.md) ^3.0.0
- [postcss-modules-values](https://npm.io/package/postcss-modules-values.md) ^4.0.0
- [postcss-modules-extract-imports](https://npm.io/package/postcss-modules-extract-imports.md) ^3.0.0
- [postcss-modules-local-by-default](https://npm.io/package/postcss-modules-local-by-default.md) ^4.0.0

## 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

- 1.1.0 (latest) — 2022-09-24
- 1.0.3 — 2021-06-09
- 1.0.2 — 2021-06-07
- 1.0.1 — 2021-06-07
- 1.0.0 — 2021-03-15

## README

# @zebing/vite-plugin-css-modules
@zebing/vite-plugin-css-modules 是一个vue css modules智能转化插件。让你在使用vue css modules的同时，无需通过`:class="$style.cssname"`, `class={styles.cssname}`等繁琐的方式调用，而是直接 `class="cssname"`, `class="cssname"`简单调用，极大的减小工作量，增加开发效率。

> 本插件仅适用 vue3.0+。

### 如何使用?
**安装**
```
npm install @zebing/vite-plugin-css-modules --save-dev
```
**使用**

在```vite.config.js``` 配置文件中加入配置
```
import vitePluginCssModules from '@zebing/vite-plugin-css-modules'
export default {
  plugins: [
    vitePluginCssModules()
  ]
}
```

**options**
### Options

|Name|Type|Description|Default|
|---|---|---|---|
|`cssFile`|`array`| css文件类型，不满足为文件将被过滤 |`['css', 'scss', 'less']`|
|`styleName`|`string`| class名称，插件会寻找该名称自动进行转换 |`class`|
|`autoImport`|`boolean`| 自动引入同级目录中的style.module.[css\|scss\|less]文件 | `false` |

### 代码中使用
> 通过 import 引入 css文件，务必在路径中保留文件名后缀， 如 `import './styles.module.css'`

**jsx写法**
```
import './styles.module.css';

export default {
  return (
    <div class="classname"> hello world</div>
  );
}
```
将会自动转换成
```
import styles from './styles.module.css';

export default {
  return (
    <div class={styles.classname}> hello world</div>
  );
}
```

**template写法**
```
<template>
  <div class="classname"> hello world</div>
</template>
<script>
import './styles.module.css';
</script>
<style module>
...
<style>
```
将会自动转换成
```
// 注，此处便于理解，实际已转化成js代码，而非template模板
<template>
  <div :class="$style.classname"> hello world</div>
</template>
<script>
import './styles.module.css';

export default {

}
</script>
<style module>
...
<style>
```

**styleName跟class共存**

以template方式为例
```
<div class="test" classname="test1"> hello world</div>
<div :class="['test']" classname="test1"> hello world</div>
<div :class="{test:true}" classname="test1"> hello world</div>
<div :class="'test'" classname="test1"> hello world</div>
```
将会自动转换成
```
<div class="test test1_module"> hello world</div>
<div :class="['test', test1_module]"> hello world</div>
<div :class="{test:true, [test1_module]:true}"> hello world</div>
<div class="test test1_module"> hello world</div>
```

### FAQ 
* templte方式可以通过`import`引入css吗？

  可以。templte通过`<style></style>`或直接`import`都可以。两者都可以共存。

* 如果`class="classname"`在css中并不存在会被转化吗？

  不会。在运行中如果没找到相应的css modules名称，插件将会保留原来的类名`classname`

---
_Source: https://npm.io/package/@zebing/vite-plugin-css-modules · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
