vue-cli3 项目优化之经过 node 自动生成组件模板 generate View、Component

时间 2019-11-15

标签 vue cli3 cli 项目优化经过 node 自动生成组件模板 generate view component 繁體版

原文原文链接

介绍

作前端的你们都知道经过 vue 开发的项目每次建立新组建的时候，都要新建一个目录，而后新增 .vue 文件，在这个文件中再写入 template 、 script 、 style 这些内容，虽然在写入的时候你们都有本身的自动补全共计，不过这些都是模板性的，每次都要这样重复操做，很麻烦有没有。前端

本文就是经过node来帮助咱们，自动去执行这些重复操做，而咱们只须要告诉控制台咱们须要建立的组件名字就能够了。本文自动建立的组件包含两个文件：入口文件 index.js 、vue文件 main.vuevue

chalk工具

为了方便咱们能看清控制台输出的各类语句，咱们先安装一下 chalk npm install chalk --save-devnode

1. 建立views

在根目录中建立一个 scripts 文件夹
在 scripts 中建立 generateView 文件夹
在 generateView 中新建 index.js ，放置生成组件的代码
在 generateView 中新建 template.js ，放置组件模板的代码，模板内容可根据项目需求自行修改

index.js

// index.js
const chalk = require('chalk')
const path = require('path')
const fs = require('fs')
const resolve = (...file) => path.resolve(__dirname, ...file)
const log = message => console.log(chalk.green(`${message}`))
const successLog = message => console.log(chalk.blue(`${message}`))
const errorLog = error => console.log(chalk.red(`${error}`))
// 导入模板
const {
    vueTemplate,
    entryTemplate
} = require('./template')
// 生成文件
const generateFile = (path, data) => {
    if (fs.existsSync(path)) {
        errorLog(`${path}文件已存在`)
        return
    }
    return new Promise((resolve, reject) => {
        fs.writeFile(path, data, 'utf8', err => {
            if (err) {
                errorLog(err.message)
                reject(err)
            } else {
                resolve(true)
            }
        })
    })
}
log('请输入要生成的页面组件名称、会生成在 views/目录下')
let componentName = ''
process.stdin.on('data', async chunk => {
    // 组件名称
    const inputName = String(chunk).trim().toString()
    // Vue页面组件路径
    const componentPath = resolve('../../src/views', inputName)
    // vue文件
    const vueFile = resolve(componentPath, 'main.vue')
    // 入口文件
    const entryFile = resolve(componentPath, 'entry.js')
    // 判断组件文件夹是否存在
    const hasComponentExists = fs.existsSync(componentPath)
    if (hasComponentExists) {
        errorLog(`${inputName}页面组件已存在，请从新输入`)
        return
    } else {
        log(`正在生成 component 目录 ${componentPath}`)
        await dotExistDirectoryCreate(componentPath)
    }
    try {
        // 获取组件名
        if (inputName.includes('/')) {
            const inputArr = inputName.split('/')
            componentName = inputArr[inputArr.length - 1]
        } else {
            componentName = inputName
        }
        log(`正在生成 vue 文件 ${vueFile}`)
        await generateFile(vueFile, vueTemplate(componentName))
        log(`正在生成 entry 文件 ${entryFile}`)
        await generateFile(entryFile, entryTemplate(componentName))
        successLog('生成成功')
    } catch (e) {
        errorLog(e.message)
    }

    process.stdin.emit('end')
})
process.stdin.on('end', () => {
    log('exit')
    process.exit()
})

function dotExistDirectoryCreate(directory) {
    return new Promise((resolve) => {
        mkdirs(directory, function() {
            resolve(true)
        })
    })
}
// 递归建立目录
function mkdirs(directory, callback) {
    var exists = fs.existsSync(directory)
    if (exists) {
        callback()
    } else {
        mkdirs(path.dirname(directory), function() {
            fs.mkdirSync(directory)
            callback()
        })
    }
}
复制代码

template.js

// template.js
module.exports = {
    vueTemplate: compoenntName => {
        return `<template>
	<div class="${compoenntName}">
		${compoenntName}组件
	</div>
</template>
<script>
export default {
	name: '${compoenntName}'
};
</script>
<style lang="stylus" scoped>
.${compoenntName} {
};
</style>`
    },
    entryTemplate: compoenntName => {
        return `import ${compoenntName} from './main.vue'
export default [{
	path: "/${compoenntName}",
	name: "${compoenntName}",
	component: ${compoenntName}
}]`
    }
}
复制代码

1.1 配置package.json

"new:view": "node ./scripts/generateView/index"
复制代码

若是使用 npm 的话就是 npm run new:view 若是是 yarn 自行修改命令vue-cli

1.2 结果

2. 建立component

跟views基本同样的步骤
在 scripts 中建立 generateComponent 文件夹
在 generateComponent 中新建 index.js ，放置生成组件的代码
在 generateComponent 中新建 template.js ，放置组件模板的代码，模板内容可根据项目需求自行修改

index.js

// index.js`
const chalk = require('chalk')
const path = require('path')
const fs = require('fs')
const resolve = (...file) => path.resolve(__dirname, ...file)
const log = message => console.log(chalk.green(`${message}`))
const successLog = message => console.log(chalk.blue(`${message}`))
const errorLog = error => console.log(chalk.red(`${error}`))
const {
    vueTemplate,
    entryTemplate
} = require('./template')

const generateFile = (path, data) => {
    if (fs.existsSync(path)) {
        errorLog(`${path}文件已存在`)
        return
    }
    return new Promise((resolve, reject) => {
        fs.writeFile(path, data, 'utf8', err => {
            if (err) {
                errorLog(err.message)
                reject(err)
            } else {
                resolve(true)
            }
        })
    })
}
log('请输入要生成的组件名称、如需生成全局组件，请加 global/ 前缀')
let componentName = ''
process.stdin.on('data', async chunk => {
    const inputName = String(chunk).trim().toString()
        /**
         * 组件目录路径
         */
    const componentDirectory = resolve('../../src/components', inputName)

    /**
     * vue组件路径
     */
    const componentVueName = resolve(componentDirectory, 'main.vue')
        /**
         * 入口文件路径
         */
    const entryComponentName = resolve(componentDirectory, 'index.js')

    const hasComponentDirectory = fs.existsSync(componentDirectory)
    if (hasComponentDirectory) {
        errorLog(`${inputName}组件目录已存在，请从新输入`)
        return
    } else {
        log(`正在生成 component 目录 ${componentDirectory}`)
        await dotExistDirectoryCreate(componentDirectory)
            // fs.mkdirSync(componentDirectory);
    }
    try {
        if (inputName.includes('/')) {
            const inputArr = inputName.split('/')
            componentName = inputArr[inputArr.length - 1]
        } else {
            componentName = inputName
        }
        log(`正在生成 vue 文件 ${componentVueName}`)
        await generateFile(componentVueName, vueTemplate(componentName))
        log(`正在生成 entry 文件 ${entryComponentName}`)
        await generateFile(entryComponentName, entryTemplate)
        successLog('生成成功')
    } catch (e) {
        errorLog(e.message)
    }

    process.stdin.emit('end')
})
process.stdin.on('end', () => {
    log('exit')
    process.exit()
})

function dotExistDirectoryCreate(directory) {
    return new Promise((resolve) => {
        mkdirs(directory, function() {
            resolve(true)
        })
    })
}

// 递归建立目录
function mkdirs(directory, callback) {
    var exists = fs.existsSync(directory)
    if (exists) {
        callback()
    } else {
        mkdirs(path.dirname(directory), function() {
            fs.mkdirSync(directory)
            callback()
        })
    }
}
复制代码

template.js

// template.js
module.exports = {
    vueTemplate: compoenntName => {
        return `<template>
	<div class="${compoenntName}">
		${compoenntName}组件
	</div>
</template>
<script>
export default {
	name: '${compoenntName}'
};
</script>
<style lang="stylus" scoped>
.${compoenntName} {
};
</style>`
    },
    entryTemplate: `import Main from './main.vue'
export default Main`
}
复制代码

2.1 配置package.json

"new:comp": "node ./scripts/generateComponent/index"
复制代码

若是使用 npm 的话就是 npm run new:comp 若是是 yarn 自行修改命令npm

2.2 结果

经过以上的 vue-cli3 优化，咱们项目在开发的过程当中就能很是方便的经过命令快速建立公共组件和其余页面了，在页面、组件比较多的项目中，能够为咱们提升一些效率，也能够经过这样的命令，来控制团队内不一样人员新建文件的格式规范。json