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

本文主要是介绍从零开始的<vue2项目脚手架>搭建:vite+vue2+eslint,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

前言

为了写 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 lily-cli,就会自动创建项目”。所以有必要了解一下 npm init 这个命令

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
  • 因为我习惯用 import/export 语法,在 package.json 中设置 "type": "module",
  • 新建 index.js
  • 在 package.json 中设置 "bin": "./index,js",

实现功能

在项目根目录下新建文件夹 template,把 Step1 中创建好的模板项目复制到这个文件夹下(模板项目中的 git 文件 和 node_modules 不用复制过来)

index.js:

TODO 修改中


TODO rephrase
插一句:别用 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

注意:.npmignore 文件指明发布包时忽略哪些文件。被忽略的文件不会上传到 npm 仓库。具体说明看这里。
有一些文件默认被 npm 忽略,如果想要添加“白名单”,就设置 package.json 的 files 字段。

但是 npm 对待 .gitignore 文件很特殊:它是被默认忽略的。如果你通过设置 files 成功吧 .gitignore 文件发布了,那么 npm 也会把它自动重命名为 .npmignore。
TODO rephrase

执行命令

执行 npm init lily-cli,成功创建项目!


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

这篇关于从零开始的<vue2项目脚手架>搭建:vite+vue2+eslint的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1059365

相关文章

tomcat多实例部署的项目实践

《tomcat多实例部署的项目实践》Tomcat多实例是指在一台设备上运行多个Tomcat服务,这些Tomcat相互独立,本文主要介绍了tomcat多实例部署的项目实践,具有一定的参考价值,感兴趣的可... 目录1.创建项目目录,测试文China编程件2js.创建实例的安装目录3.准备实例的配置文件4.编辑实例的

Vue中组件之间传值的六种方式(完整版)

《Vue中组件之间传值的六种方式(完整版)》组件是vue.js最强大的功能之一,而组件实例的作用域是相互独立的,这就意味着不同组件之间的数据无法相互引用,针对不同的使用场景,如何选择行之有效的通信方式... 目录前言方法一、props/$emit1.父组件向子组件传值2.子组件向父组件传值(通过事件形式)方

css中的 vertical-align与line-height作用详解

《css中的vertical-align与line-height作用详解》:本文主要介绍了CSS中的`vertical-align`和`line-height`属性,包括它们的作用、适用元素、属性值、常见使用场景、常见问题及解决方案,详细内容请阅读本文,希望能对你有所帮助... 目录vertical-ali

springboot集成Deepseek4j的项目实践

《springboot集成Deepseek4j的项目实践》本文主要介绍了springboot集成Deepseek4j的项目实践,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录Deepseek4j快速开始Maven 依js赖基础配置基础使用示例1. 流式返回示例2. 进阶

SpringBoot项目启动报错"找不到或无法加载主类"的解决方法

《SpringBoot项目启动报错找不到或无法加载主类的解决方法》在使用IntelliJIDEA开发基于SpringBoot框架的Java程序时,可能会出现找不到或无法加载主类com.example.... 目录一、问题描述二、排查过程三、解决方案一、问题描述在使用 IntelliJ IDEA 开发基于

SpringBoot项目使用MDC给日志增加唯一标识的实现步骤

《SpringBoot项目使用MDC给日志增加唯一标识的实现步骤》本文介绍了如何在SpringBoot项目中使用MDC(MappedDiagnosticContext)为日志增加唯一标识,以便于日... 目录【Java】SpringBoot项目使用MDC给日志增加唯一标识,方便日志追踪1.日志效果2.实现步

浅析CSS 中z - index属性的作用及在什么情况下会失效

《浅析CSS中z-index属性的作用及在什么情况下会失效》z-index属性用于控制元素的堆叠顺序,值越大,元素越显示在上层,它需要元素具有定位属性(如relative、absolute、fi... 目录1. z-index 属性的作用2. z-index 失效的情况2.1 元素没有定位属性2.2 元素处

Python实现html转png的完美方案介绍

《Python实现html转png的完美方案介绍》这篇文章主要为大家详细介绍了如何使用Python实现html转png功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 1.增强稳定性与错误处理建议使用三层异常捕获结构:try: with sync_playwright(

Vue 调用摄像头扫描条码功能实现代码

《Vue调用摄像头扫描条码功能实现代码》本文介绍了如何使用Vue.js和jsQR库来实现调用摄像头并扫描条码的功能,通过安装依赖、获取摄像头视频流、解析条码等步骤,实现了从开始扫描到停止扫描的完整流... 目录实现步骤:代码实现1. 安装依赖2. vue 页面代码功能说明注意事项以下是一个基于 Vue.js

CSS @media print 使用详解

《CSS@mediaprint使用详解》:本文主要介绍了CSS中的打印媒体查询@mediaprint包括基本语法、常见使用场景和代码示例,如隐藏非必要元素、调整字体和颜色、处理链接的URL显示、分页控制、调整边距和背景等,还提供了测试方法和关键注意事项,并分享了进阶技巧,详细内容请阅读本文,希望能对你有所帮助...