@@ -18,7 +18,12 @@ import * as express from "express"
18
18
*
19
19
* Plugins are just node modules.
20
20
*
21
- * code-server uses $CS_PLUGIN_PATH to find plugins. Each subdirectory in
21
+ * 1. code-server uses $CS_PLUGIN to find plugins.
22
+ *
23
+ * e.g. CS_PLUGIN=/tmp/will:/tmp/teffen will cause code-server to load
24
+ * /tmp/will and /tmp/teffen as plugins.
25
+ *
26
+ * 2. code-server uses $CS_PLUGIN_PATH to find plugins. Each subdirectory in
22
27
* $CS_PLUGIN_PATH with a package.json where the engine is code-server is
23
28
* a valid plugin.
24
29
*
@@ -29,16 +34,14 @@ import * as express from "express"
29
34
* ~/.local/share/code-server/plugins:/usr/share/code-server/plugins
30
35
* if unset.
31
36
*
32
- * code-server also uses $CS_PLUGIN to find plugins.
33
37
*
34
- * e.g. CS_PLUGIN=/tmp/will:/tmp/teffen will cause code-server to load
35
- * /tmp/will and /tmp/teffen as plugins.
38
+ * 3. Built in plugins are loaded from __dirname/../plugins
36
39
*
37
- * Built in plugins are also loaded from __dirname/../plugins
40
+ * Plugins are required as soon as they are found and then initialized.
41
+ * See the Plugin interface for details.
38
42
*
39
- * Priority is $CS_PLUGIN, $CS_PLUGIN_PATH and then the builtin plugins.
40
- * After the search is complete, plugins will be required in first found order and
41
- * initialized. See the Plugin interface for details.
43
+ * If two plugins are found with the exact same name, then code-server will
44
+ * use the first one and emit a warning.
42
45
*
43
46
* There is also a /api/applications endpoint to allow programmatic access to all
44
47
* available applications. It could be used to create a custom application dashboard
@@ -51,9 +54,6 @@ import * as express from "express"
51
54
* The plugin's name, description and version are fetched from its module's package.json
52
55
*
53
56
* The plugin's router will be mounted at <code-sever-root>/<plugin-name>
54
- *
55
- * If two plugins are found with the exact same name, then code-server will
56
- * use the last one and emit a warning.
57
57
*/
58
58
export interface Plugin {
59
59
/**
0 commit comments