Skip to content

Latest commit

 

History

History

plugin

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

介绍

siu CLI 使用了一套基于插件的架构。基于插件的架构使得 Siu CLI 灵活且高扩展;如果你对开发一个插件感兴趣,那我们就开始吧:

插件命名

官方插件都是以@siujs/plugin-开头,具体的列表可以去plugins查看;

其他插件都是以siujs-plugin-或者@xxx/siujs-plugin-开头;

siu.config.js定义如下:

module.exports = {
	plugins: ["bar", "@siujs/foo", "@xxx/siujs-plugin-foo2"]
};

// or

// 通过defineConfig获取智能提示
const { defineConfig } = require("@siujs/cli");
module.exports = defineConfig({
	plugins: ["bar", "@siujs/foo", "@xxx/siujs-plugin-foo2"]
});

// will to be : siujs-plugin-bar , @siujs/plugin-foo, @xxx/siujs-plugin-foo2

项目本地的插件

如果需要在项目里直接使用,而不去通过npm repo的情况下,可以按照如下方式定义如下:

// in siu.config.js

module.exports = {
	plugins: ["./siujs-plugin-xxxx"]
};

// in siu.config.ts
export default {
	plugins: ["./siujs-plugin-xxxx"]
};

// in package.json
{
    "siu":{
        "plugins":["./siujs-plugin-xxxx"]
    }
}