从零开始的<vue2项目脚手架>搭建:vite+vue2+eslint

news/2024/7/14 20:57:04

前言

为了写 demo 或者研究某些问题,我经常需要新建空项目。每次搭建项目都要从头配置,很麻烦。所以我决定自己搭建一个项目初始化的脚手架(取名为 lily-cli)。

脚手架(scaffolding):创建项目时,自动完成的创建初始文件等初始化工作。这些工作往往是每次新建工程都要进行的重复性工作。

目标:我只需要执行 npm init lily-cli,就会自动创建一个符合我要求(vite+vue2+eslint)的空项目。

碎碎念:
现在 vue3 是主主主主流。我作为一个不得不使用 vue2 的开发者,在 vue3 浪潮下想要搜索 vue2 的内容真的有一点点麻烦——比如说,vite 已经不提供 vue2 的官方初始化模板了,而 vite 的社区模板也没有适合我的,所以我还是自己搭建一个吧。

分成两步实现:

  1. 手动创建一个 vite+vue2+eslint 的项目
  2. 以上一步的项目作为模板,写一个脚本自动创建新项目

Step 1:手动创建项目 vite+vue2+eslint

初始化

新建文件夹 template_vite_vue2_eslint
npm init -y

vite + vue2

在 vite 中使用 vue2.7+,要用 @vitejs/plugin-vue2。这个插件已经不再更新了,安装时可以直接锁定最新版本 2.3.1。

vite 和 vue 的版本要看 @vitejs/plugin-vue2 的要求:

// @vitejs/plugin-vue2 最新版本的 package.json"peerDependencies": {"vite": "^3.0.0 || ^4.0.0 || ^5.0.0","vue": "^2.7.0-0"},

pnpm i vite@"^5.0.0" vue@"^2.7.0" @vitejs/plugin-vue2@2.3.1

在 package.json 中添加 scripts:

  "scripts": {"dev": "vite","build": "vite build","preview": "vite preview"},

新建 vite.config.js

import vue from '@vitejs/plugin-vue2'export default {plugins: [vue()]
}

创建 main.js 等文件

// src/main.js
import Vue from "vue";
import App from "./App.vue";Vue.config.productionTip = false;
Vue.config.devtools = true;new Vue({el: "#app",render: (h) => h(App),
});
// src/App.vue
<template><section>{{ message }}</section>
</template><script setup>
import { ref } from "vue";
const message = ref("模板");
</script>
// index.html
<!DOCTYPE html>
<html><head><meta charset="UTF-8" /><meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Vite + Vue</title></head><body><div id="app"></div><script type="module" src="/src/main.js"></script></body>
</html>

eslint

配置 eslint npm init @eslint/config@latest

如有问题可参考 《vscode 中 eslint 无效?npm init 是什么?》


Step 2:搭建脚手架,让一切自动化

npm init、bin

在前言中说了,我的目标是 “执行 npm init lily-cli,就会自动创建项目”。所以有必要了解一下 npm init 这个命令

点这里查看 npm init 官方文档

npm init 有两种用法:

  • npm init 在一连串问题后,根据你的回答自动创建 package.json 文件。-y 可以跳过问题
  • npm init <initializer>:根据指定的 initializer 初始化项目。通过 npx 安装 create-<initializer> 包并执行它的 bin。

在这里插入图片描述

我的脚手架名称是 lily-cli,所以 npm package 名字应该是 create-lily-cli。并且要设置 bin 字段。

简单了解一下 bin 字段,点这里查看官方文档:

在这里插入图片描述
注意:bin 的入口文件必须以 #!/usr/bin/env node 开头,告诉操作系统要用 nodejs 运行此脚本。不然的话,在 npm exec 时会报错 800A03EA:

在这里插入图片描述

初始化项目

  • 新建文件夹 create-lily-cli
  • git init,新建 .gitignore
  • npm init -y
  • 在 package.json 中设置 "type": "module" (个人习惯使用 import/export 语法)
  • 新建 index.js
  • 在 package.json 中设置 "bin": "./index,js"

为了防止歧义,明确一下称呼:

  • Step 1 中创建的 template_vite_vue2_eslint 为 “模板项目”。它是为了给 “脚手架项目” 提供参考的模板
  • Step 2 中创建的 create-lily-cli 为 “脚手架项目”。它的作用是一键生成 “成果项目”
  • 使用 create-lily-cli 脚手架自动生成的,称为 “成果项目”,它应该和 “模板项目” 长得一致

目标功能

  1. 自动生成项目所有文件
  2. 自动安装依赖
  3. 自动初始化 git 并 commit

开发功能

实现思路:
在脚手架项目中新建文件夹 template,把 “模板项目” 的文件都复制到这个文件夹下( .git 文件夹、node_modules 文件夹和 pnpm-lock.yaml 除外)。
编写脚本,使每次执行脚本时复制 /template 下的所有内容到目标路径,这就实现了 功能1:自动生成项目所有文件
功能2和3更简单,让脚本自动执行命令。

需要注意的是,在功能3的 commit 之前,“成果项目” 中必须存在 .gitignore(不然成果项目/node_modules 也会被commit)。
但是 npm 在 publish package 时,不会把 .gitignore 文件上传到 npm 仓库(TODO 这里不具体解释了,以后会写文章专门讨论这个问题)。有两种解决方案:

  1. template/.gitignore 文件改名(比如改成 template/gitignore,去掉最前面的.),这时就可以成功 publish 到 npm 仓库了。在脚本中写代码,对成果项目进行 git 操作前,先把 gitignore 文件的名字改回来
  2. 干脆把 template/.gitignore 文件去掉。在脚本中给成果项目创建 .gitignore 文件

index.js:

#!/usr/bin/env node
import process from "process";
import path from "path";
import { cp, writeFile, rename, rm } from "fs/promises";
import spawn from "cross-spawn"; // 用法同 nodejs 内置的 child_process 模块,但解决了跨平台的兼容性问题
import { fileURLToPath } from "url";
import { dirname } from "path";const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename); // __dirname 当前文件所在目录;process.cwd() 执行命令的目录async function run() {const target_path = path.join(process.cwd(), "lily-template-project");await generateFiles(target_path); // 根据模板生成文件installDeps(target_path); // 安装依赖await initGit(target_path); // 初始化 git
}run();async function generateFiles(target_path) {const src_path = path.join(__dirname, "template");await cp(src_path, target_path, { recursive: true }); // 将模板中的所有文件递归复制到目标路径
}function installDeps(dirPath) {spawn.sync("pnpm i", { stdio: "inherit", cwd: dirPath });
}async function initGit(dirPath) {const spawnOptions = { stdio: "inherit", cwd: dirPath };spawn.sync("git init", spawnOptions);// 为了解决《npm 在 publish package 时,不会把 .gitignore 文件上传到 npm 仓库》,有两种方案:await rename(path.join(dirPath, "gitignore"), path.join(dirPath, ".gitignore")); // 方案1:template中给.gitignore改名。这里再改回来// await writeFile(path.join(dirPath, ".gitignore"), "node_modules"); // 方案2:直接用代码创建 .gitignorespawn.sync("git add .", spawnOptions);spawn.sync("git commit", ["-m", "init project"], spawnOptions);
}

插播:别用 npm link!别用 npm link!别用 npm link
在开发阶段我用 npm link + npx create-lily-cli 进行本地调试。调试完成准备发布,我需要解除本地 link。
我尝试了多种方法: unlinkuninstall -g、清除 npm cache、清除 npx cache,但都清理不掉 npx 中的缓存!(npm 的 link 应该是清理干净了,npm i create-lily-cli 已经不生效了)。
在我 publish 了之后再执行 npx,它还是用的之前本地 link 的版本。我最后是卸载 nodejs 重装才清理掉。。。。
在这里插入图片描述

发布到 npm

npm publish

执行命令

执行 npm init lily-cli,成功!


写这个脚手架是受 @eslint/config 的启发 在这里插入图片描述
之前以为写这类东西很复杂,但是在研究 @eslint/config 源码的时候,发现还蛮简单的,所以才决定自己试试。


http://www.mrgr.cn/p/86112866

相关文章

互联网应用主流框架整合之SpringMVC基础组件开发

多种传参方式 在前一篇文章互联网应用主流框架整合之SpringMVC初始化及各组件工作原理中讨论了最简单的参数传递&#xff0c;而实际情况要复杂的多&#xff0c;比如REST风格&#xff0c;它往往会将参数写入请求路径中&#xff0c;而不是以HTTP请求参数传递&#xff1b;比如查询…

DockerCompose+Jenkins+Pipeline流水线打包Vue项目(解压安装配置Node)入门

场景 DockerComposeJenkinsPipeline流水线打包SpringBoot项目(解压安装配置JDK、Maven等)入门&#xff1a; DockerComposeJenkinsPipeline流水线打包SpringBoot项目(解压安装配置JDK、Maven等)入门-CSDN博客 以上使用流水线配置和打包springboot后台项目&#xff0c;如果要使…

Oracle 入门--前提

目录 1.sqlplus 2.dual是什么&#xff1f; 3.SQL语句的种类 4.Oracle是如何工作的 5.Oracle查看配置文件 6.修改配置文件 7.常用的参数设置 1.sqlplus 管理数据库&#xff1a;启动&#xff0c;关闭&#xff0c;创建&#xff0c;删除对象......查看数据库的运行状态&…

工厂方法模式实战之某商场一次促销活动

目录 1.5.1、前言1.5.2、实战场景简介1.5.3、开发环境1.5.4、用传统的if-else语句实现1.5.4.1、工程结构1.5.4.2、if-else需求实现1.5.4.3、测试验证 1.5.5、工厂模式优化代码1.5.5.1、工程结构1.5.5.2、代码实现1.5.5.2.1、定义各种商品发放接口及接口实现1.5.5.2.2、定义工厂…

c++_0基础_讲解7 练习

这一讲我为大家准备了几道题目&#xff0c;大家试着独自做一下&#xff08;可能来自不同网站&#xff09; 整数大小比较 - 洛谷 题目描述 输入两个整数&#xff0c;比较它们的大小。若 x>yx>y &#xff0c;输出 > &#xff1b;若 xyxy &#xff0c;输出 &#xff…

​单级高频谐振小放

目录 高频交流等效电路 质量指标 增益 通频带 选择性 高频交流等效电路 质量指标 增益 YL撇是怎么来的。 通频带 选择性

快手爬票概述

自学python如何成为大佬(目录):https://blog.csdn.net/weixin_67859959/article/details/139049996?spm1001.2014.3001.5501 无论是出差还是旅行&#xff0c;都无法离开交通工具的支持。现如今随着科技水平的提高&#xff0c;高铁与动车成为人们喜爱的交通工具。如果想要知道…

nlp学习笔记

目录 很多入门例子 bert chinese 很多入门例子 https://github.com/lansinuote/Huggingface_Toturials bert chinese import torch import torch.nn as nn from transformers import AutoTokenizer, AutoModel, BertModel, TFBertModel, BertTokenizer# youpath = D:/bert-…

redis 笔记2之哨兵

文章目录 一、哨兵1.1 简介1.2 实操1.2.1 sentinel.conf1.2.2 问题1.2.3 哨兵执行流程和选举原理1.2.4 使用建议 一、哨兵 1.1 简介 上篇说了复制&#xff0c;有个缺点就是主机宕机之后&#xff0c;从机只会原地待命&#xff0c;并不能升级为主机&#xff0c;这就不能保证对外…

HCIA-Datacom H12-811 题库

LDP 邻居发现有不同的实现机制和规定&#xff0c;下面关于LDP 邻居发现的描述错误的是&#xff1a; A&#xff1a;LDP发现机制包括LDP基本发现机制和LDP扩展发现机制 B&#xff1a;LDP基本发现机制可以自动发现直连在同条链路上的LDP Peers C&#xff1a;LDP扩展发现机制够发现…

基于Matlab的车牌识别停车场出入库计时计费管理系统(含GUI界面)【W6】

简介&#xff1a; 在当今城市化进程加快的环境下&#xff0c;停车管理成为了一个日益重要和复杂的问题。城市中的停车资源有限&#xff0c;如何高效利用和管理这些资源&#xff0c;不仅关乎市民出行便利性&#xff0c;也涉及到城市交通拥堵、环境污染等诸多问题的解决。 传统的…

Mongodb使用$pop删除数组中的元素

学习mongodb&#xff0c;体会mongodb的每一个使用细节&#xff0c;欢迎阅读威赞的文章。这是威赞发布的第67篇mongodb技术文章&#xff0c;欢迎浏览本专栏威赞发布的其他文章。如果您认为我的文章对您有帮助或者解决您的问题&#xff0c;欢迎在文章下面点个赞&#xff0c;或者关…

【SpringBoot】SpringBoot:构建实时聊天应用

文章目录 引言项目初始化添加依赖 配置WebSocket创建WebSocket配置类创建WebSocket处理器 创建前端页面创建聊天页面 测试与部署示例&#xff1a;编写单元测试 部署扩展功能用户身份验证消息持久化群组聊天 结论 引言 随着实时通信技术的快速发展&#xff0c;聊天应用在现代We…

HTTP协议 快速入门

http概述 无状态性&#xff1a;HTTP是一个无状态协议&#xff0c;这意味着服务器不会在请求之间保存任何会话信息。每个请求都是独立的&#xff0c;服务器不会记住之前的请求。 请求-响应模型&#xff1a;HTTP通信是基于客户端发送请求和服务器返回响应的模型。客户端&#xf…

C语言,struct 结构体、union共用体的使用

//状态字节&#xff0c;根据数据定义几个标志&#xff0c;标志位依据联合体内部结构体进行变量定义 //目的&#xff0c;节省内存空间&#xff0c;省去特定字节 struct STATDATA {union{unsigned char stat;struct {unsigned stat0:1;unsigned stat1:1;unsigned stat2:1;unsign…

热门开源项目ChatTTS: 国内语音技术突破,实现弯道超车

✨✨ 欢迎大家来访Srlua的博文&#xff08;づ&#xffe3;3&#xffe3;&#xff09;づ╭❤&#xff5e;✨✨ &#x1f31f;&#x1f31f; 欢迎各位亲爱的读者&#xff0c;感谢你们抽出宝贵的时间来阅读我的文章。 我是Srlua小谢&#xff0c;在这里我会分享我的知识和经验。&am…

OpenVX使用案例分析

OpenVX使用案例分析 用例 1 第一个用例涉及 2 个vx_reference,一个已经为vx_reference分配了内存缓冲区,另一个没有。 (注意:有关何时发生内存缓冲区分配的更多信息,请参阅 TIOVX 中的内存管理。这些用例图描述了如何成功地将内存缓冲区从一个vx_reference导入到下一个,而…

如何将NextJs中的File docx保存到Prisma ORM

背景/引言 在现代 Web 开发中&#xff0c;Next.js 是一个备受欢迎的 React 框架&#xff0c;它具有许多优点&#xff0c;如&#xff1a; 服务器端渲染 (SSR)&#xff1a;Next.js 支持服务器端渲染&#xff0c;可以提高页面加载速度&#xff0c;改善 SEO&#xff0c;并提供更好…

Flask快速入门(路由、CBV、请求和响应、session)

Flask快速入门&#xff08;路由、CBV、请求和响应、session&#xff09; 目录 Flask快速入门&#xff08;路由、CBV、请求和响应、session&#xff09;安装创建页面Debug模式快速使用Werkzeug介绍watchdog介绍快速体验 路由系统源码分析手动配置路由动态路由-转换器 Flask的CBV…

Unity 3D 物体的Inspector面板

1、Transform&#xff1a;位置、旋转、大小 2、Mesh Filter&#xff1a;物体的形状 3、Mesh Renderer&#xff1a;物体渲染&#xff08;物体的衣服&#xff09; 4、Collider&#xff1a;碰撞体