如何完整搭建一个前端脚手架?搭建vue3组件库实操

相信大家在前端开发中都使用过很多前端脚手架,如vue-cli,create-vite,create-vue等;本篇文章将会为大家详细介绍这些前端脚手架是如何实现的,并且从零实现一个create-kitty脚手架发布到npm上。

pnpm搭建Monorepo环境

使用pnpm管理对项目进行管理是非常方便的,极大的解决了多个包在本地调试繁琐的问题。

什么是Monorepo?

就是指在一个大的项目仓库中,管理多个模块/包(package),这种类型的项目大都在项目根目录下有一个packages文件夹,分多个项目管理。大概结构如下:

-- packages  -- pkg1    --package.json  -- pkg2    --package.json--package.json

简单来说就是单仓库 多项目

目前很多我们熟知的项目都是采用这种模式,如Vant,ElementUI,Vue3等。打造一个Monorepo环境的工具有很多,如:lerna、pnpm、yarn等,这里我们将使用pnpm来开发我们的UI组件库。

使用pnpm

安装

首先新建文件kitty-ui;然后执行

npm install pnpm -g

初始化package.json

pnpm init

新建配置文件 .npmrc

shamefully-hoist = true

这里简单说下为什么要配置shamefully-hoist

如果某些工具仅在根目录的node_modules时才有效,可以将其设置为true来提升那些不在根目录的node_modules,就是将你安装的依赖包的依赖包的依赖包的...都放到同一级别(扁平化)。说白了就是不设置为true有些包就有可能会出问题。

monorepo的实现

接下就是pnpm如何实现monorepo的了。

为了我们各个项目之间能够互相引用我们要在根目录下新建一个pnpm-workspace.yaml文件将我们的包关联起来

packages:
    - 'packages/**'

这样就能将我们项目下的packages目录下的所有包关联起来了,当然如果你想关联更多目录你只需要往里面添加即可。根据上面的目录结构很显然你在根目录下新packages文件夹,packages文件夹新建create-kitty以及测试用的cli-demo文件夹,并分别执行pnpm init

脚手架简单实现

create-kittypackage.json中新增bin属性然后指向index.js。这里去掉了main属性,因为我们开发的不是工具包。

{  name: create-kitty,  version: 1.0.0,  description: ,  bin: index.js,  scripts: {    test: echo \Error: no test specified\ && exit 1
  },  keywords: [],  author: ,  license: ISC}

当然,bin也支持对象格式,让脚手架可以使用多个命令

bin: {    create-kitty: index.js,    create-app: index.js  },

新建create-kitty/index.js作为脚手架入口

#! /usr/bin/env nodeconsole.log(hello kitty)

注意cli入口文件需要加#! /usr/bin/env node指定脚本的解释程序为node,否则会报错

本地测试脚手架

来到测试包cli-demo文件夹下直安装create-kitty

pnpm add create-kitty

然后就会发现cli-demo下的package出现依赖,同时加上scripts

{  name: cli-demo,  version: 1.0.0,  description: ,  main: index.js,  scripts: {    create-kitty: create-kitty
  },  keywords: [],  author: ,  license: ISC,  dependencies: {    create-kitty: workspace:^1.0.0
  }
}

后执行pnpm run create-kitty

image.png

说明

当我们上线的时候可以直接执行npm create kitty或者npm init kitty,它们其实就是执行npx create-kitty

解析用户输入参数

一般脚手架都会根据用户输入不同命令来做出不同操作,比如用户输入kitty-ui -v提示版本号,kitty-ui -h显示帮助信息等。而实现这些基本原理就是process.argv

create-kitty下的入口文件index.js修改

#! /usr/bin/env nodeconsole.log(process.argv);

后执行这个文件并带几个参数

GIF10.gif

然后会发现用户传的参数在process.argv数组的第二位以后,这样我们就可以根据用户输入不同参数做不同操作了。但是这样很不方便,所以我们可以使用框架来解决

使用第三方库解析参数

首先安装command-line-args

pnpm add command-line-args -S

接下来看它是如何获取用户输入参数的

#! /usr/bin/env nodeimport commandLineArgs from 'command-line-args';//配置命令参数const optionDeFinitions = [
  { name: 'version', alias: 'v', type: Boolean },
  { name: 'arg1', type: String },
  { name: 'arg2', type: Number },
];const options = commandLineArgs(optionDeFinitions);console.log(options);

GIF.gif

注意这里使用了es6的语法,所以需要将package.json中的type指定为module

接下来实战一些,检测用户输入--help指令,然后我们输出一个帮助的配置。

首先安装command-line-usage

pnpm add command-line-usage -S

首先引入commandLineUsage,然后写个配置

import commandLineUsage from 'command-line-usage';//帮助内容const helpSections = [
  {    header: 'create-kitty',    content: '一个快速生成组件库搭建环境的脚手架',
  },
  {    header: 'Options',    optionList: [
      {        name: 'version',        typeLabel: '{underline boolean}',        description: '版本号',
      },
      {        name: 'arg1',        typeLabel: '{underline string}',        description: '参数1',
      },
      {        name: 'arg2',        typeLabel: '{underline number}',        description: '参数2',
      },
    ],
  },
];

command-line-args中配置个help命令,当获取help的时候直接打印

const optionDeFinitions = [
  { name: 'help', alias: 'h', type: Boolean },
  { name: 'version', alias: 'v', type: Boolean },
  { name: 'arg1', type: String },
  { name: 'arg2', type: Number },
];const options = commandLineArgs(optionDeFinitions);if (options.help) console.log(commandLineUsage(helpSections))

GIF2.gif

但是这样好像不太好看

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


可以通过min-width属性来设置el-table-column的最小宽度。以下是一个示例: <template> <el-table :data="tableData"> <el-table-column prop="item_no&q
yarn dev,当文件变动后,会自动重启。 yanr start不会自动重启 nodemon会监听文件变动,跟yarn dev和yarn start无关。
ref 用于创建一个对值的响应式引用。这个值可以是原始值(如数字或字符串)或对象。当 ref 的值发生变化时,Vue 会自动更新 DOM 或任何其他使用该 ref 的响应式依赖。 使用示例: import { ref } from 'vue'; const count = ref(0
通过修改 getWK005 函数来实现这一点。这里的 query 参数就是发送 GET 请求时的查询参数。你可以将需要的条件作为 query 对象的属性传递进去。比如,如果你想要按照特定的条件查询信息,你可以在调用 getWK005 函数时传递这些条件。例如: getWK005({ conditio
<el-form-item label="入库类型" prop="mt_type"> <el-select v-model="form.mt_type" filterable placeholder="请选择&q
API 变动 样式类名变化: 一些组件的样式类名有所变动,可能需要更新你的自定义样式。 事件名和属性名变化: 某些组件的事件名和属性名发生了变化,需要检查 Element Plus 文档 以了解详细信息。 使用 setup 函数: 在 Vue 3 中,可以使用 Composition API(如 s
安装和引入方式 Element UI (Vue 2): // main.js import Vue from 'vue'; import ElementUI from 'element-ui'; import 'element-ui/lib/theme-cha
排查400 (Bad Request)和解决这个问题,可以按照以下步骤进行: 检查URL和端点:确保URL http://127.0.0.1:8008/basicApp/BS037HModel/ 是正确的,并且该端点在服务器上存在。 检查请求参数:确认发送请求时的任何参数都是正确的,包括查询参数、请
在 Vue.js 中,<template> 标签是一种特殊的标签,它用于定义组件的模板,但不会直接渲染为 HTML 元素。它的主要用途是在编写组件和使用插槽时提供灵活的模板定义。以下是关于 <template> 标签的一些关键概念和使用示例。 基本用法 组件模板:在单文件组件
el-config-provider是Element Plus库中的一个组件,用于提供全局的配置。它是Element Plus在2.0版本中引入的新组件。 el-config-provider组件的作用是允许你在应用程序中统一配置Element Plus的一些全局属性和样式,这些配置将被应用于所有E
onMounted 是一个生命周期钩子函数,在组件挂载到 DOM 后运行。在这里你可以执行需要在组件可用后进行的操作,比如获取数据、设置订阅或初始化第三方库。 使用示例: import { onMounted } from 'vue'; onMounted(() => { //
mt_qty: (this.temp.id && this.temp.mt_qty) ? this.temp.mt_qty : event.wo_wip,在这个修正后的代码中,使用了条件三元运算符来判断 this.temp.id 是否存在且 mt_qty 是否已被赋值。如果条件成立,
Axios是一个基于Promise的易用、简洁且高效的HTTP请求插件,可以用于浏览器和Node.js。首先执行yarn命令安装依赖,安装成功时在package.json文件的dependencies下多出了Axios及其版本号,笔者写此书时,安装的版本为0.26.1,如所示。 yarn add a
async 关键字用于声明一个异步函数,这个函数会返回一个 Promise 对象。与 await 关键字配合使用时,可以在异步函数中暂停代码执行,直到 Promise 解决或拒绝,从而使异步代码的处理更简单和同步化。 使用 async 的示例 下面是一个完整的 Vue 3 组件示例,展示了如何使用
Promise 是 JavaScript 中用于处理异步操作的一种对象。它代表了一个异步操作的最终完成(或失败)及其结果值。在处理异步操作时,Promise 提供了一种更干净、更可读的方式来管理回调函数。 Promise 的状态 一个 Promise 对象有三种状态: Pending(进行中):初始
在 JavaScript 中,await 是一个用于处理异步操作的关键字。它只能在 async 函数内部使用,并且用于等待一个 Promise 对象的解析。在 Vue 3 中,await 关键字常用于在组合式 API 的 setup 函数中处理异步操作,比如数据获取。 使用 await 的示例 以下
引入样式 Element UI (Vue 2): import 'element-ui/lib/theme-chalk/index.css'; Element Plus (Vue 3): import 'element-plus/dist/index.css';
-D和-S区别 安装的环境不同 -D是--save-dev的简写,会安装在开发环境中(production)中的devPendencies中 -S是--save的简写,会安装在生产环境中(development)中的dependencies中
Element-plus的徽章组件el-badge Element Plus 是一个基于 Vue.js 的 UI 组件库,它提供了一系列的常用 UI 组件供开发者使用。其中,徽章组件(el-badge)是其中之一。 徽章组件(el-badge)可以在其他元素上展示一个小圆点或者一个数字,用于标记某种
vscode element-plus/lib/theme-chalk/index.css报错路径找不到 import { createApp } from 'vue' import './style.css' import App from './App.v