Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 1.95 KB

use-plugin.md

File metadata and controls

61 lines (37 loc) · 1.95 KB

使用tiny插件

tiny插件介绍

tiny插件,是符合一定规则的 npm 模块,插件主要是用来扩展命令行,可以通过插件来增加 tiny 命令行的命令。插件专注于某个比较单一的功能,解决工作中零散、重复的任务。

插件是对套件的一个补充,套件解决的是前端工作的主要生命周期,而套件无法覆盖到的地方,将由插件来补充。

比如:在套件的源码打包与构建阶段(tiny build),套件的主要任务是将src目录的源码进行压缩、编译到build目录。而在这个过程中,可以同时使用一些辅助插件:

  1. tiny eslint 插件,可以在build的过程中做代码规范检测
  2. tiny console 插件,可以检测源码中是否包含有console信息
  3. tiny check 插件,可以检测dependencies中的依赖是否有新版本

这些细小的功能点,本身具有业务通用性,不需要每个套件去实现一遍,将这些插件穿插在套件的生命周期中一起使用,相互配合,最终提高开发效率,改善开发体验。

在命令行中使用

插件的使用基本格式是: tiny [pluginName] [command]

其中:

  • pluginName为插件的名字,如tiny-plugin-console插件,pluginName则是console
  • command为插件的具体命令,每个插件的命令可能不一样,需要看插件文档。
# 使用console插件的detect命令
$ tiny console detect

# 使用console插件的strip命令
$ tiny console strip

在配置文件中使用

tiny的插件可以在tiny.config.js配置文件中使用。

如下面的例子,在tiny build命令中进行使用,执行tiny build后,会先执行tiny console detect命令的功能,再执行套件本身的build任务。

//tiny.config.js

module.exports = {

  tasks : {
    //省略其他配置...
    build : [
      {
        // console检测
        command : 'tiny console detect'
      }
    ]
  }
};