当前位置：首页 > news >正文

从零开始的＜vue2项目脚手架＞搭建：vite+vue2+eslint

news 文章来源：https://blog.csdn.net/tangran0526/article/details/139417312 2024/10/25 0:33:01

前言

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

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

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

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

分成两步实现：

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

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 脚手架自动生成的，称为 “成果项目”，它应该和 “模板项目” 长得一致

目标功能

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

开发功能

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

需要注意的是，在功能3的 commit 之前，“成果项目” 中必须存在 .gitignore（不然成果项目/node_modules 也会被commit）。
但是在使用你发布的包时，npm 不会保留你包里的 .gitignore 文件（具体解释见另一篇文章）。有两种解决方案：

给 template/.gitignore 文件改名（比如改成 template/gitignore，去掉最前面的.)，这时就可以成功 publish 到 npm 仓库了。在脚本中写代码，对成果项目进行 git 操作前，先把 gitignore 文件的名字改回来
干脆把 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。
我尝试了多种方法： unlink、uninstall -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 源码的时候，发现还蛮简单的，所以才决定自己试试。

前言