组件库依赖 ant-design-vue
, vue
, @ant-design/icons-vue
和 lodash-es
. 请确保这些依赖已经安装.
::: tip 如果你使用 npm 版本 >= 8, npm 将自动安装这些依赖. :::
npm install @nbicc/common-components
import { createApp } from "vue";
import Antd from "ant-design-vue";
import App from "./App";
import "ant-design-vue/dist/antd.css";
import CommonComponents from "@nbicc/common-components";
import "@nbicc/common-components/dist/style.css";
const app = createApp(App);
app.use(Antd).use(CommonComponents).mount("#app");
与 Ant Design Vue 一样, 需要引入样式文件. 一般来说会在 main.js
中引入.
组件库使用 Vite 构建, 文档使用 VitePress 构建.
- nodejs >= 16
- 16 以下的版本不支持自动安装对等依赖
- vuejs/language-tools 存在已知的问题, 需要 16 以上的版本才能正常工作.
npm install
使用 vitepress 的文档服务器作为开发服务器, 会自动监听文件变化并重新编译. 文档位于 docs
目录下.
npm run docs:dev
随便改点什么...
运行单元测试 (Vitest)
不需要, 因为没有单元测试.
npm run test:unit
提交前请阅读关于 Commit Message 的规范 Conventional Commits.
Commit Message 需要遵循 Angular Commit Message Guidelines.
提交前会运行 ESLint 和 Prettier, 检查未通过时会中断提交.
VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).
TypeScript cannot handle type information for .vue
imports by default, so we replace the tsc
CLI with vue-tsc
for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue
types.
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:
- Disable the built-in TypeScript Extension
- Run
Extensions: Show Built-in Extensions
from VSCode's command palette - Find
TypeScript and JavaScript Language Features
, right click and selectDisable (Workspace)
- Run
- Reload the VSCode window by running
Developer: Reload Window
from the command palette.