HTML项目脚手架重构:基于Yeoman定制个性化HTML工程模版的方法

冬雪酱_6443

冬雪酱_6443

2026-07-15

291人浏览

原创

yeoman仍是html项目脚手架最稳妥方案,支持命令行交互与模板批量生成,但构建配置需手动集成;generator名必须为generator-xxx格式,npm publish后用户通过yo xxx调用。

html项目脚手架重构:基于yeoman定制个性化html工程模版的方法

直接说结论:Yeoman 仍是目前最稳妥、可维护性最强的 HTML 项目脚手架定制方案,尤其适合需要命令行交互 + 模板变量填充 + 多文件批量生成的场景;但别指望它自动处理构建流程,webpack 或 vite 配置得自己写、自己注入。

generator 名字必须是 generator-xxx 格式

这是 Yeoman 的硬性约定,不是建议。如果你 npm publish 一个叫 my-html-scaffold 的包,用户执行 yo my-html-scaffold 会报错:Error: Cannot find module 'generator-my-html-scaffold' —— 因为 yo 默认只找 generator- 开头的包。

实际操作时:

  • 初始化项目用 yarn init 或 npm init,包名填 generator-html-boilerplate
  • package.json 中的 name 字段必须严格匹配,不能带空格或下划线(只允许短横线)
  • 发布后,用户安装只需 npm install -g generator-html-boilerplate,然后运行 yo html-boilerplate(去掉 generator- 前缀)

prompting() 里用 this.prompt() 收集用户输入

Yeoman 内部用的是 Inquirer.js,支持 input、confirm、list、checkbox 等类型。关键点在于:所有异步操作必须 return promise,否则后续生命周期会跳过。

常见错误现象:

  • 用户没输完就直接生成文件 → 忘了 return this.prompt(...)
  • this.props.xxx 是 undefined → 在 writing() 里直接读取,但没在 prompting() 的 .then() 中赋值给 this.props
  • 默认值取不到 git 用户名 → 应该用 this.user.git.name(),而不是 process.env.USER

示例片段:

HTML Extract
HTML Extract

使用 MinerU 从 HTML 页面和文件中提取内容,将 HTML 转换为保持标题、列表、表格及文本层次结构的干净、结构化 Markdown。F...

下载
prompting() {
  return this.prompt([
    { type: 'input', name: 'projectName', message: '项目名称?', default: this.appname },
    { type: 'confirm', name: 'useBootstrap', message: '是否引入 Bootstrap?' }
  ]).then(answers => {
    this.props = answers; // 必须显式挂载
  });
}

模板文件放在 generators/app/templates/,用 this.fs.copyTpl() 渲染

EJS 是 Yeoman 默认模板引擎,语法就是 和 ...。注意路径和上下文传参方式:

  • this.templatePath('index.html') → 读取 templates/index.html
  • this.destinationPath('index.html') → 输出到用户当前目录根路径
  • this.fs.copyTpl(src, dest, context) → context 必须是 plain object,不能是 class 实例或函数
  • 如果模板里要条件渲染 CSS 引入,<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.3/dist/css/bootstrap.min.css">

容易踩的坑:

  • 模板中用了 ,但 context 里传的是 { name: 'xxx' } → 变量名不匹配,渲染成空字符串
  • 把 package.json 当纯文本 copy → 应该用 copyTpl,否则无法动态替换 name、version、description
  • 路径写错,比如 this.templatePath('src/main.js'),但实际模板在 templates/src/main.js → Yeoman 不会自动补前缀,报 ENOENT

install() 阶段执行 this.installDependencies() 要谨慎

这个方法默认调用 npm install,但它不会等你写完 package.json 就执行——因为 install() 在 writing() 之后、end() 之前运行。如果你在 writing() 里生成了 package.json,那没问题;但如果依赖是动态决定的(比如用户选了 TypeScript 就要加 @types/node),就得手动拼 dependencies 对象再写入。

更现实的做法:

  • 把 devDependencies 全写死在模板 package.json 里,靠 copyTpl 渲染基础字段
  • 避免在 install() 里做复杂逻辑,比如判断 Node 版本或自动选择包管理器;Yeoman 不处理这些,交由用户自己 npm install 或 yarn
  • 如果真要跑命令,用 this.spawnCommandSync('npm', ['install', '--no-save']),但注意 Windows 下可能找不到 npm,建议加 shell: true 参数

真正容易被忽略的是:Yeoman 不管构建产物目录(如 dist/)、不启动 dev server、不 watch 文件 —— 这些都得靠你往模板里塞 scripts 字段,或让用户自己配。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

HTML速学教程(入门课程)
HTML速学教程(入门课程)

HTML怎么学习?HTML怎么入门?HTML在哪学?HTML怎么学才快?不用担心,这里为大家提供了HTML速学教程(入门课程),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

html

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.14

5375

7

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

2023.06.21

3112

4

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.31

2750

5

html空格
html空格

html空格是一种用于在网页中添加间隔和对齐文本的特殊字符,被用于在网页中插入额外的空间,以改变元素之间的排列和对齐方式。本专题为大家提供html空格的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.01

2799

5

html是什么
html是什么

HTML是一种标准标记语言,用于创建和呈现网页的结构和内容,是互联网发展的基石,为网页开发提供了丰富的功能和灵活性。本专题为大家提供html相关的各种文章、以及下载和课程。

2023.08.11

4679

6

html字体大小怎么设置
html字体大小怎么设置

在网页设计中,字体大小的选择是至关重要的。合理的字体大小不仅可以提升网页的可读性,还能够影响用户对网页整体布局的感知。php中文网将介绍一些常用的方法和技巧,帮助您在HTML中设置合适的字体大小。

2023.08.11

2741

3

html转txt
html转txt

html转txt的方法有使用文本编辑器、使用在线转换工具和使用Python编程。本专题为大家提供html转txt相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.31

2529

3

html文本框代码怎么写
html文本框代码怎么写

html文本框代码:1、单行文本框【<input type="text" style="height:..;width:..;" />】;2、多行文本框【textarea style=";height:;"></textare】。

2023.09.01

2288

6

HTML嵌入CSS样式的方法
HTML嵌入CSS样式的方法

HTML嵌入CSS样式的方法有内联样式、内部样式表和外部样式表。本专题为大家提供CSS样式相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.20

2288

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 219人学习