# README

A Component Library for Vue 3.

Based on element-plus project, simplification for engineering, monorepo, build, lint, commitlint...

## 快速开始

### 完整引入

如果你对打包后的文件大小不是很在乎，那么使用完整导入会更方便。

```ts
// main.ts
import { createApp } from 'vue'
import Yhui from 'yhui-yuanhuan'
import 'yhui-yuanhuan/dist/index.css'
import App from './App.vue'

const app = createApp(App)

app.use(Yhui)
app.mount('#app')
```

## rename

### work rename

excludes `pnpm-lock.yaml, *.md, `

`element-plus(?!/icons)` to `new-name`
search `@element-plus/icons-vue`
doc `theme-chalk/package.json`

`Element Plus` to `New Name`

`ElementPlus` to `NewName`
`elementPlus` to `newName`
`ElementPlusAlias` to `NewNameAlias`
`ElementPlusLocale` to `NewNameLocale`
`ElementPlusError` to `NewNameError`

### prefix rename

excludes `pnpm-lock.yaml, *.md, `

`el-` to `nn-`
`El-` to `Nn-`

excludes `pnpm-lock.yaml, *.md, play, packages/utils, packages/test-utils, `
`el` to `nn`

`ElConfigProvider` to `NnConfigProvider`
search `\b(el)(?!ement\b|se\b)\w*\b`

### file or directory rename

`packages/element-plus` to `new-name`
`internal/build/src/plugins/element-plus-alias.ts` to `new-name-alias.ts`

## 开发常见问题

### 如果你遇到依赖相关问题 ​

```shell
rm -rf node_modules
pnpm i
```

### 链接本地依赖 ​

```shell
# 获取构建结果
pnpm build
cd dist/element-plus
# set cur element-plus to global `node_modules`
pnpm link --global
# for esm we also need link element-plus for dist
pnpm link --global element-plus

# 进入你的项目, 链接到 `element-plus`
cd your-project
pnpm link --global element-plus
```

更多信息查看 [pnpm link](https://pnpm.io/cli/link)

### 主题 ​

我们不应在 scss 文件中写入中文注释

那将会在 vite 构建下的 css 文件开头生成警告信息 `@charset "UTF-8"`;

更多信息见 [#3219](https://github.com/element-plus/element-plus/issues/3219)