blob: 6fb0f9d1ed3e8dea7d13780a7f696f3dff3335ae (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
## Introduction
XMake supports the plugin module and we can develop ourself plugin module conveniently.
We can run command `xmake -h` to look over some builtin plugins of xmake
```
Plugins:
l, lua Run the lua script.
m, macro Run the given macro.
doxygen Generate the doxygen document.
hello Hello xmake!
project Create the project file.
```
* lua: Run a given lua script.
* macro: Record and playback some xmake commands repeatly.
* doxygen：Generate doxygen document automatically.
* hello: The demo plugin and only print: 'hello xmake!'
* project：Generate project file for IDE, only generate makefile now and will generate vs, xcode project in the future
## Quick Start
Now we write a simple plugin demo for printing 'hello xmake!'
```lua
-- define a plugin task
task("hello")
-- set the category for showing it in plugin category menu (optional)
set_category("plugin")
-- the main entry of the plugin
on_run(function ()
-- print 'hello xmake!'
print("hello xmake!")
end)
-- set the menu options, but we put empty options now.
set_menu {
-- usage
usage = "xmake hello [options]"
-- description
, description = "Hello xmake!"
-- options
, options = {}
}
```
The file tree of this plugin:
```
hello
- xmake.lua
```
Now one of the most simple plugin finished, how was it to be xmake detected it, there are three ways:
1. Put this plugin directory into xmake/plugins the source codes as the builtin plugin.
2. Put this plugin directory into ~/.xmake/plugins as the global user plugin.
3. Put this plugin directory to anywhere and call `add_plugindirs("./hello")` in xmake.lua as the local project plugin.
## Run Plugin
Next we run this plugin
```bash
xmake hello
```
The results is
```
hello xmake!
```
Finally, we can also run this plugin in the custom scripts of `xmake.lua`
```lua
target("demo")
-- run this plugin after building target
after_build(function (target)
-- import task module
import("core.project.task")
-- run the plugin task
task.run("hello")
end)
```
|
