当前位置:首页 » 新媒体运营 » 正文

自动书名生成器,自定义Yeoman生成器(一)

8077 人参与  2023年03月25日 12:11  分类 : 新媒体运营  评论

自定义Yeoman生成器

生成器(脚手架都可以)是Yeoman生态系统中的重要组成部分,yo通过插件的方式运行生成器,为终端用户生成文件。

通过这篇文章,你将学会如何创建和发布自定义的生成器

组织你的生成器

创建node模块

生成器本质上就是一个node.js的模块

首先、创建一个文件夹,例如:generator-net。文件夹的命名必须是:generator-name(其中name就是你要自定义的生成器的名字),这一点非常重要,因为Yeoman就是根据文件系统去发现可用的生成器。

然后,进入到刚创建的文件夹:cd generator-net,通过npm init 创建package.json文件,文件内容如下:

{  "name": "generator-net",  "version": "1.0.0",  "description": "",  "files": [    "generators"
  ],  "keywords": ["yeoman-generator"],  "dependencies": {    "yeoman-generator": "^1.1.1"
  }
}

注意:name必须是generator开头,keywords属性必须要包含“yeoman-generator”,files属性必须是一个文件和文件夹的数组项(具体参考文件结构说明)

为了确保依赖项yeoman-generator是最新的,可以通过运行如下命令:npm install --save yeoman-generator

请参考
https://docs.npmjs.com/files/package.json 说明给package.json添加其他需要的属性

目录结构

Yeoman的功能依赖于如何去组织目录结构。每一个子生成器也都有自己的目录

当你执行yo name 命令时,使用的是app默认的生成器,包含在app目录下

输入yo name:subcommand就是执行子生成器,文件的目录名和子生成器的名字一样。

目录结构可以参考如下示例:

├───package.json
└───generators/
    ├───app/
    │   └───index.js
    └───subnet/
        └───index.js


自动书名生成器,自定义Yeoman生成器(一)-百度竞价优化_微商推广_今日头条自媒体_新媒体运营_剑谦网络


如图的生成器就会提供yo net 和 yo net:subnet两个命令

Yeoman提供了两种不同的目录结构,会在generators目录下注册可用的生成器

上面的示例也可以采用如下的目录结构:

├───package.json
├───app/
│   └───index.js
└───subnet/
    └───index.js

但是必须要修改package.json文件中files的属性为:

{  "files": [    "app",    "subnet"
  ]
}

编写生成器

组织好了目录结构,接下来就可以写生成器相关的代码了

Yeoman提供一个生成器的基类,该基类提供了大部分的功能,以减少我们的工作量,我们也可以继承该基类去实现一些自定义的逻辑

修改生成器的index.js文件,引入yeoman-generator并继承Generator基类:

var Generator = require('yeoman-generator');module.exports = class extends Generator {};

具体怎么样使用module.exports,可以参考
https://nodejs.org/api/modules.html#modules_module_exports 使用说明

重写构造函数

有些方法只能在构造函数中执行,例如:构建一些状态而且作用域在构造函数中

我们可以按照如下的方式进行构造函数的重写

module.exports = class extends Generator {  // The name `constructor` is important here  constructor(args, opts) {    // Calling the super constructor is important so our generator is correctly set up    super(args, opts);    // Next, add your custom code    this.option('babel'); // This method adds support for a `--babel` flag
  }
};

添加自定义的功能

每一个被添加的方法都将按顺序执行。但是,下一章节中,我们也能看到有些特殊的方法执行顺序也比较固定。

我们来添加一些方法:

module.exports = class extends Generator {
  m1() {    this.log('m1 just ran');
  }

  m2() {    this.log('m2 just ran');
  }
};

执行 yo net,将看到如下的输出信息:

自动书名生成器,自定义Yeoman生成器(一)-百度竞价优化_微商推广_今日头条自媒体_新媒体运营_剑谦网络


执行生成器

此时,你应该有一个可以工作的生成器,接下来,验证一下创建的生成器是否能正常工作。

因为是在本地开发的生成器,所以还不是一个全局的node模块。可以通过命令npm link,去创建一个全局的node模块并链接到我们开发的本地模块。注意需要在生成器的根目录下执行命令:generator-name/ 目录,执行完命令之后,我们就能执行命令:yo net并能在控制台中看到输出的日志信息

发现项目的根目录

当运行一个生成器时,Yeoman将试图根据它运行的上下文推断出一些东西。

最关键的是,Yeoman将在文件目录中查找.yo-rc.json的文件,如果找到了,则把该文件所在的目录当作是项目的根目录,Yeoman会自动在后台更改当前的目录为.yo-rc.json文件所在的目录并执行生成器的请求。

.yo-rc.json文件是通过存储模块创建的。在生成器中只有第一次执行的时候才会生成.yo-rc.json文件:

自动书名生成器,自定义Yeoman生成器(一)-百度竞价优化_微商推广_今日头条自媒体_新媒体运营_剑谦网络


本文链接:https://www.woshiqian.com/post/202967.html

<< 上一篇 下一篇 >>

  • 评论(0)
  • 赞助本站

       

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。