简介
npm 包 cmaki_generator 是一个能够帮助前端开发者快速生成项目框架的工具。该工具基于 Yeoman 和 CMake ，可以生成具备高可用性和可扩展性的前端项目基础框架，支持开箱即用的单元测试，自动化文档生成以及 ESLint 规范等功能。
安装
在使用 cmaki_generator 之前，需要先安装 Node.js 、Yeoman 和 CMake 等工具，确保系统配置正确。安装方式如下：
--- ------- -- -- -----
接下来就可以安装 cmaki_generator 了。
--- ------- -- ---------------
使用
初始化工程
在命令行中输入以下指令来创建项目：
-- -----
根据提示输入相应的信息：项目名称、项目描述、作者、版本等。如果信息全部按照默认配置，则可在命令行中直接输入：
-- ----- ----------
cmaki_generator 会根据您输入的信息自动生成项目框架，包括文件夹结构、文件模板等。
生成代码
cmaki_generator 支持生成常用的前端代码，如组件、页面等。在命令行中输入以下指令来生成代码：
-- ---------------
根据提示输入相应的信息：组件名称、组件描述、组件所在文件夹等。cmaki_generator 会为您自动生成组件模板以及相关测试模板等。
在命令行中输入以下指令来生成页面：
-- ----------
根据提示输入相应的信息：页面名称、页面描述、页面所在文件夹、是否使用路由等。cmaki_generator 会为您自动生成页面模板以及相关测试模板等。
自动化文档生成
cmaki_generator 集成了自动化文档生成工具，可以自动根据代码注释生成文档。在 ES6 代码中，可以使用 JSDoc 注释格式来进行标注。当运行自动化文档生成命令时，cmaki_generator 会根据 JSDoc 注释自动生成文档网站。
在命令行中输入以下指令来生成文档：
-- ---------
cmaki_generator 会根据当前目录下所有符合要求的代码文件自动生成文档网站，并部署到 gh-pages 分支，方便进行在线浏览和分享。
单元测试
cmaki_generator 集成了单元测试工具，可以帮助您编写更加健壮的代码。在命令行中输入以下指令来运行单元测试：
--- ----
cmaki_generator 会自动运行所有单元测试，并反馈测试结果。如果有测试不通过，会自动打印错误信息以及失败的测试用例信息。
ESLint 集成
cmaki_generator 集成了 ESLint 工具，可以帮助您规范代码风格，避免常见的代码错误。在命令行中输入以下指令来运行 ESLint：
--- --- ----
cmaki_generator 会自动检查当前目录下所有符合要求的代码文件，并反馈错误信息以及建议性修改。
结尾
使用 cmaki_generator 能够帮助前端开发者快速生成高可用性和可扩展性的前端项目基础框架，使得开发更加高效、规范、健壮，能够大幅提高开发效率。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60055fc281e8991b448dd1ae