效能工具：执行 npm start 可直接切换proxy代理UR后直接启动项目

news2024/12/25 23:47:00

1) 背景:

我们项目是2个前端3个后端的配置。前端和每个后端都有需要调试的接口。
因此经常切换vite.congig.js中的proxy后端代理链接，是挺麻烦的。

于是我研究如何能快速切换后端URL，所幸懒人有懒福，我找到了Inquirer 和 fs，
实现执行 npm start 可直接切换vite.config.js中proxy的代理URL，然后直接启动项目。

在这里插入图片描述

2) inquirer 和 fs npm包

先来说说Inquirer ，Inquirer是一个流行的 Node.js 库，用于构建交互式命令行界面。
fs是用于读取，写入，修改文件的工具。

简单介绍一下他的用法。
目前项目背景：vue: ^3.4.29 inquirer: ^10.0.1

// 需要定义，命令行可选范围
// name是展示在命令行
// value是选中name后可获得相对的value
const targetList = [
  {
    name: '张三',
    value: "\t\t\t\ttarget: 'http://33.33.33.33:3333',",
  },
  {
    name: '李四',
    value: "\t\t\t\ttarget: 'http://44.44.44.44:4444',",
  },
  {
    name: '王二',
    value: "\t\t\t\ttarget: 'http://22.22.22.22:2222',",
  },
  {
    name: '麻子',
    value: "\t\t\t\ttarget: 'http://55.55.55.55:5555',",
  },
]
// 调用inquirer方法，进行基础配置
const choose = inquirer.prompt([
  {
    type: 'list', // 用于提供一个列表选择。用户可以从列表中选择一个选项作为答案。
    name: 'serve', // 自取名
    message: '请选择开发环境下需要连接的后端服务', // 展示给用户的标题行
    choices: targetList, // 选取的列表值
    default: targetList[0].value // 进入命令行，默认选项
  }
])

3) 思路

首先使用fs模块读取vite.config.js文件，找到target内容
将我们在命令行选中的值替换掉刚刚找到target内容
将替换成功的内容，重新写入vite.config.js文件
在package.json 中npm start 修改命令

4) 完整代码如下：

// nodeTab.js
// Vue2中引入fs模块使用require，Vue3使用import
import fs from 'fs';
// inquirer这个库来创建交互式的命令行界面
import inquirer from 'inquirer';

// 需要定义，命令行可选范围
// name是展示在命令函
// value用来替换proxy中代码
const targetList = [
  {
    name: '张三',
    value: "\t\t\t\ttarget: 'http://33.33.33.33:3333',",
  },
  {
    name: '李四',
    value: "\t\t\t\ttarget: 'http://44.44.44.44:4444',",
  },
  {
    name: '王二',
    value: "\t\t\t\ttarget: 'http://22.22.22.22:2222',",
  },
  {
    name: '麻子',
    value: "\t\t\t\ttarget: 'http://55.55.55.55:5555',",
  },
]
// 去找到target这一行代码
function findTarget(file) {
  let arr = file.split('\n')
  let targetStr = ''
  for (let i = 0; i < arr.length; i++) { // 通过循环找到对应行
    if (arr[i].includes('target:')) {
      targetStr = arr[i] // 赋值一下，找到了
      break
    }
  }
  return targetStr
}
// 选择方法
async function selectServe() {
  try {
    // 在命令行进行选择
    const choose = await inquirer.prompt([
      {
        type: 'list',
        name: 'serve',
        message: '请选择开发环境下需要连接的后端服务',
        choices: targetList,
        default: targetList[0].value
      }
    ])
    // 读取了文件vite.config.js为string格式
    let file = fs.readFileSync('./vite.config.js', 'utf-8')
    // 找到target这一行
    let proxyTarget = findTarget(file)
    // 替换我们新选的后端服务地址
    const newFile = file.replace(proxyTarget, choose.serve)
    // 重新写入vite.config.js
    fs.writeFileSync('./vite.config.js', newFile)
  } catch (error) {
    throw error
  }
}
selectServe()

// package.json
// 这里就展示部分代码，在start启动项目前，先执行node program/nodeTab.js这个脚本
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "dev": "vite  --mode development",
    "build": "vite build --mode production",
    "builds": "node program/ssh.js && vite build --mode production",
    "start": "node program/nodeTab.js && vite --mode production",
    "build:env": "vite build --mode development"
  },