从0-1搭建一个web项目vue3+vite+ts+element-plus(脚手架分析)

本章分析从0-1的搭建脚手架依赖

在这里插入图片描述

ObJack-Admin一款基于 Vue3.3、TypeScript、Vite3、Pinia、Element-Plus 开源的后台管理框架。在一定程度上节省您的开发效率。另外本项目还封装了一些常用组件、hooks、指令、动态路由、按钮级别权限控制等功能。感兴趣的小伙伴可以访问源码点个赞 地址

本文主要对packge.json文件进行详解 scripts、dependencies、devDependencies等配置项

  1. 创建项目

create vite 项目名称
  1. 脚本配置

项目脚本配置详解
在项目的 package.json 文件中,scripts 部分通常包含了各种命令和脚本,用于自动化项目的开发、构建、测试和部署等过程。下面是对一个典型的 scripts 配置的详细解释。

这里我先先看一下scripts的配置项

"scripts": {
   
   
    "dev": "vite",
    "serve": "vite",
    "build:dev": "vue-tsc && vite build --mode development",
    "build:test": "vue-tsc && vite build --mode test",
    "build:pro": "vue-tsc && vite build --mode production",
    "type:check": "vue-tsc --noEmit --skipLibCheck",
    "preview": "npm run build:dev && vite preview",
    "lint:eslint": "eslint --fix --ext .js,.ts,.vue ./src",
    "lint:prettier": "prettier --write \"src/**/*.{js,ts,json,tsx,css,less,scss,vue,html,md}\"",
    "lint:stylelint": "stylelint --cache --fix \"**/*.{vue,less,postcss,css,scss}\" --cache --cache-location node_modules/.cache/stylelint/",
    "lint:lint-staged": "lint-staged",
    "prepare": "husky install",
    "release": "standard-version",
    "commit": "git add -A && czg && git push"
  },
对于以上配置项有些可能不太理解 下面我对配置项进行了一一的解释方便大家在配置的时候进行选择
  • 开发环境
"dev":
命令: vite
描述: 使用 vite 启动开发服务器,进入开发模式。
"serve":
命令: vite
描述:"dev" 命令相同,通常用于与其他工具或框架的约定保持一致。
构建
"build:dev":
命令: vue-tsc && vite build --mode development
描述: 先使用 vue-tsc 进行 TypeScript 代码检查,然后使用 vite 进行构建,指定为开发模式。
"build:test":
命令: vue-tsc && vite build --mode test
描述:"build:dev" 类似,但指定为测试模式,可能生成用于测试环境的构建版本。
"build:pro":
命令: vue-tsc && vite build --mode production
描述: 进行生产模式的构建,首先进行 TypeScript 检查,然后生成优化过的构建版本。
类型检查
"type:check":
命令: vue-tsc --noEmit --skipLibCheck
描述: 使用 vue-tsc 进行 TypeScript 类型检查,但不生成输出,并跳过库的类型检查。
预览
"preview":
命令: npm run build:dev && vite preview
描述: 先运行 "build:dev" 命令进行开发模式的构建,然后使用 vite 
preview 命令启动一个预览服务器,以便查看构建后的应用。
代码检查与格式化
"lint:eslint":
命令: eslint --fix --ext .
### 安装和配置 Element Plus 要在 Vue3Vite 项目中安装和配置 Element Plus,可以按照以下方法操作: #### 1. 创建 Vue3 项目 如果尚未创建 Vue3 项目,则可以通过 Vite 脚手架快速搭建环境。运行以下命令初始化一个新的 Vue3 项目[^2]: ```bash pnpm create vite my-project --template vue cd my-project ``` #### 2. 安装 Element Plus 及其依赖项 在项目的根目录下执行以下命令来安装 `element-plus` 和它的图标库: ```bash pnpm install element-plus @element-plus/icons-vue ``` 这一步会将必要的包添加到项目的依赖列表中。 #### 3. 配置 main.ts 文件 打开项目的入口文件 `src/main.ts` 并完成如下配置以实现全局注册 Element Plus 组件以及设置语言为中文[^3]: ```typescript import { createApp } from &#39;vue&#39; import App from &#39;./App.vue&#39; // 导入ElementPlus核心功能及其样式表 import ElementPlus from &#39;element-plus&#39;; import &#39;element-plus/dist/index.css&#39;; // 如果需要使用图标库则单独导入 import * as Icons from &#39;@element-plus/icons-vue&#39;; const app = createApp(App); app.use(ElementPlus); // 设置国际化为中国地区,默认情况下是英文 import zhCn from &#39;element-plus/es/locale/lang/zh-cn&#39;; app.config.globalProperties.$ELEMENT = { size: &#39;small&#39;, zIndex: 3000 }; app.use(ElementPlus, { locale: zhCn }); Icons.forEach((icon) => { app.component(icon.name, icon); }); app.mount(&#39;#app&#39;); ``` 上述代码完成了对 Element Plus 的基本集成工作,并通过 `$ELEMENT` 属性定义了一些默认参数如组件大小与 z-index 值。 #### 4. 使用组件 现在可以在任何 `.vue` 文件里直接调用 Element Plus 提供的各种 UI 控件而无需额外声明或引入它们[^1]。例如,在某个页面组件中加入按钮控件非常简单: ```html <el-button type="primary">Primary Button</el-button> ``` 以上过程即实现了基于 Vue3Vite 构建的应用程序中成功集成了 Element Plus 库的功能。
评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

下一站丶

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值