从零开始打造前端约定路由项目脚手架，让小demo开发告别重复配置

2023-09-07 02:51:09

前言

前端开发中，我们经常需要创建各种各样的demo项目来验证想法或展示功能。然而，每次创建新项目时，都需要进行许多重复的配置，例如创建项目目录、安装依赖、配置构建工具等。这些重复性的任务不仅耗时费力，而且容易出错。

为了解决这个问题，我们可以创建一个自己的前端约定路由项目脚手架工具。这个工具可以自动完成项目初始化、依赖安装、构建配置等任务，从而大大提高开发效率。

脚手架工具的搭建

1. 初始化项目

首先，我们需要创建一个新的Node.js项目作为脚手架工具的根目录。可以使用以下命令创建项目：

mkdir my-scaffold
cd my-scaffold
npm init -y

2. 安装依赖

接下来，我们需要安装脚手架工具所需的依赖包。可以使用以下命令安装依赖：

npm install --save-dev @vue/cli

3. 创建脚手架模板

脚手架模板是脚手架工具用于创建新项目的基础。我们需要创建一个名为template的目录，并在其中放置脚手架模板文件。

在template目录中，我们可以创建一个名为package.json的文件，并添加以下内容：

{
  "name": "my-scaffold-template",
  "version": "1.0.0",
  "description": "A Vue.js project template for my scaffold",
  "main": "index.js",
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "eslint --ext .js,.vue src"
  },
  "dependencies": {
    "vue": "^2.6.11"
  },
  "devDependencies": {
    "@vue/cli-plugin-babel": "~4.5.0",
    "@vue/cli-plugin-eslint": "~4.5.0",
    "@vue/cli-service": "~4.5.0",
    "eslint": "^8.2.0",
    "eslint-plugin-vue": "^8.2.0"
  }
}

在template目录中，我们还需要创建一个名为index.js的文件，并添加以下内容：

import Vue from 'vue'
import App from './App.vue'

Vue.config.productionTip = false

new Vue({
  render: h => h(App),
}).$mount('#app')

在template目录中，我们还需要创建一个名为App.vue的文件，并添加以下内容：

<template>
  <div id="app">
    <router-view/>
  </div>
</template>

<script>
export default {
  name: 'App'
}
</script>

<style>
#app {
  font-family: 'Avenir', Helvetica, Arial, sans-serif;
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
  text-align: center;
  color: #2c3e50;
  margin-top: 60px;
}
</style>

4. 创建脚手架命令

接下来，我们需要创建一个脚手架命令，以便我们可以使用脚手架工具创建新项目。

在package.json文件中，添加以下内容：

{
  "bin": {
    "my-scaffold": "bin/my-scaffold.js"
  }
}

在bin目录中，创建一个名为my-scaffold.js的文件，并添加以下内容：

#!/usr/bin/env node

const { execSync } = require('child_process')
const { join } = require('path')

const templateDir = join(__dirname, '../template')

const [, , projectName] = process.argv

if (!projectName) {
  console.error('Project name is required')
  process.exit(1)
}

const projectDir = join(process.cwd(), projectName)

execSync(`mkdir ${projectDir}`)
execSync(`cp -r ${templateDir} ${projectDir}`)

console.log(`Created project ${projectName}`)