使用 Vue.js 编写命令行界面,前端开发 CLI 的利器

前言

大家好,使用我是webfansplz[1].继将 Vue 渲染到嵌入式液晶屏[2]后,今天要跟大家分享的是如何将Vue渲染到命令行工具 :).关于命令行工具,大家应该都比较熟悉了,比如vue-cli、Vite等.我们在编写前端应用面向用户时,写命通常会非常关注用户体验,作为开发者,我们在使用工具时,它给予我们的开发者体验(DX)我们也会十分关注.团队在今年有自研脚手架的计划,作为前端,我就在想是否能有较低成本的研发方案能让团队的小伙伴参与进来,大家可以像编写前端应用一样搞定它.因此,Temir[3]应运而生.

Temir

介绍

Temir[4],一个用Vue组件来编写命令行界面应用的工具.开发者只需要使用Vue就可以编写命令行应用,不需要任何额外的学习成本.

import { ref } from @vue/runtime-core

import { TBox, TText } from @temir/core

const counter = ref(0)

setInterval(() => {

counter.value++

}, 100)

{ { counter }} tests passed

复制代码组件

Temir[5]提供了一些基础组件帮助开发者编写与扩展命令行工具:

文本组件 (Text)

文本组件可以显示文本,将其样式更改为粗体、下划线、令行利器斜体或删除线.

I am green

I am black on 界面white

I am white

I am bold

I am italic

I am underline

I am strikethrough

I am inversed

复制代码盒子组件 (Box)

<Box>是构建布局必不可少的Temir组件.就像在浏览器中<div style=display: flex>.它提供了一些构建布局的常用属性,比如尺寸、内外边距、源码库前端对齐方式等.

X

// [X ]

X

// [ X ]

X

// [ X]

X

Y

// [X Y]

X

Y

// [ X Y ]

复制代码换行组件 (Newline)

添加一个或多个换行符(\n)。使用 必须在<Text>组件中使用。写命

import { TBox,令行利器 TNewline, TText } from @temir/core

Hello

World

复制代码填充组件 (Spacer)

沿其包含布局的主轴展开的灵活空间。 作为填充元素之间所有可用空间的界面快捷方式，它非常有用。前端

例如，使用在具有默认伸缩方向(row)的写命<Box>中使用<Spacer>将把"Left"定位到左边，并将"Right"推到右边。令行利器

import { TBox,界面 TSpacer, TText } from @temir/core

Left

Right

复制代码超链接组件 (Link)

import { TBox, TText } from @temir/core

import TLink from @temir/link

:margin="5"

width="20"

border-style="round"

justify-content="center"

>

Hi

Github

复制代码加载中组件 (Spinner)

import { TBox, TText } from @temir/core

import TSpinner from @temir/spinner

:margin="5"

width="20"

border-style="round"

justify-content="center"

>

Loading

复制代码标签页组件 (Tab)

import { computed, ref } from @vue/runtime-core

import { TBox, TText } from @temir/core

import { TTab, TTabs } from @temir/tab

const tabs = [Vue, React, Angular, Solid, Svelte]

const activeIndex = ref(0)

const selectedText = computed(() => tabs[activeIndex.value])

Selected Text :

{ { selectedText }}

{ { item }}

复制代码选择组件

import TSelectInput from @temir/select-input

const items = [

{

label: Vue,

value: Vue,

},

{

label: Vite,

value: Vite,

},

{

label: Temir,

value: Temir,

},

]

function onSelect(value) {

console.log(selected, value)

}

复制代码安装

npm install @temir/core

复制代码使用

import { ref } from @vue/runtime-core

import { TBox, TText } from @temir/core

const counter = ref(0)

setInterval(() => {

counter.value++

}, 100)

{ { counter }} tests passed

复制代码HMR支持

前面我们提到了开发者体验(DX),在现在的前端工程中,对开发者很有帮助且提效的就是HMR,这么香的东西Temir[6]没有理由不拥有它,话不多说,直接展示:

开箱即用

使用Temir[7]定制化CLI非常简单,我们提供了\@temir/cli[8]帮助你快速构建一个基于Temir[9]的服务器租用CLI.

mkdir my-temir-cli

cd my-temir-cli

touch main.ts

npm install @temir/cl

# Dev (开发)

temir main.ts

# Build (打包)

temir build main.ts

复制代码

你可以通过下载这个 例子[10] 来快速开始，你也可以打开 repl.it sandbox[11]来在线体验和尝试它。前端

演示

Hi Temir[12]

Borders[13]

Table[14]

Vitest[15]

实现

 createRenderer

Temir的实现主要得益于Vue3出色的跨平台能力,我们可以通过createRenderer[16] API创建一个自定义渲染器,通过创建宿主环境中对应的Node和Element,并对元素进行增删改查操作.

 Yoga

Vue提供了跑在命令行界面的接口,那我们就还缺少一个布局引擎就能把Vue 跑在命令行工具了.Temir使用了Yoga,一款Flexbox布局引擎.使用你在构建浏览器应用时使用过的类似CSS的属性，为你的CLI构建出色的用户界面。

致谢

 这个项目的灵感来源于ink[17] vite-node[18]为实现HMR提供了强力的支持

结语

文章到这里就结束了,如果我的文章和项目对你有所启发和帮助,请给一个star[19]支持作者 ✌

很赞哦!（4）