plugin: Plugin modules now export a single top level identifier

nhooyr · nhooyr · commit 14f408a837cb · 2020-11-06T10:13:01.000-05:00
Makes typing much easier. Addresse's Will's last comment.
diff --git a/src/node/plugin.ts b/src/node/plugin.ts
@@ -189,11 +189,16 @@ export class PluginAPI {
       )
     }
 
+    const pluginModule = require(dir)
+    if (!pluginModule.plugin) {
+      throw new Error("plugin module does not export a plugin")
+    }
+
     const p = {
       name: packageJSON.name,
       version: packageJSON.version,
       modulePath: dir,
-      ...require(dir),
+      ...pluginModule.plugin,
     } as Plugin
 
     if (!p.displayName) {
diff --git a/test/test-plugin/src/index.ts b/test/test-plugin/src/index.ts
@@ -2,33 +2,35 @@ import * as express from "express"
 import * as fspath from "path"
 import * as pluginapi from "../../../typings/pluginapi"
 
-export const displayName = "Test Plugin"
-export const routerPath = "/test-plugin"
-export const homepageURL = "https://example.com"
-export const description = "Plugin used in code-server tests."
+export const plugin: pluginapi.Plugin = {
+  displayName: "Test Plugin",
+  routerPath: "/test-plugin",
+  homepageURL: "https://example.com",
+  description: "Plugin used in code-server tests.",
 
-export function init(config: pluginapi.PluginConfig) {
-  config.logger.debug("test-plugin loaded!")
-}
+  init: (config) => {
+    config.logger.debug("test-plugin loaded!")
+  },
 
-export function router(): express.Router {
-  const r = express.Router()
-  r.get("/goland/icon.svg", (req, res) => {
-    res.sendFile(fspath.resolve(__dirname, "../public/icon.svg"))
-  })
-  return r
-}
+  router: () => {
+    const r = express.Router()
+    r.get("/goland/icon.svg", (req, res) => {
+      res.sendFile(fspath.resolve(__dirname, "../public/icon.svg"))
+    })
+    return r
+  },
 
-export function applications(): pluginapi.Application[] {
-  return [
-    {
-      name: "Test App",
-      version: "4.0.0",
-      iconPath: "/icon.svg",
-      path: "/test-app",
+  applications: () => {
+    return [
+      {
+        name: "Test App",
+        version: "4.0.0",
+        iconPath: "/icon.svg",
+        path: "/test-app",
 
-      description: "This app does XYZ.",
-      homepageURL: "https://example.com",
-    },
-  ]
+        description: "This app does XYZ.",
+        homepageURL: "https://example.com",
+      },
+    ]
+  },
 }
diff --git a/typings/pluginapi.d.ts b/typings/pluginapi.d.ts
@@ -16,7 +16,8 @@ import * as express from "express"
 /**
  * Plugins
  *
- * Plugins are just node modules.
+ * Plugins are just node modules that contain a top level export "plugin" that implements
+ * the Plugin interface.
  *
  * 1. code-server uses $CS_PLUGIN to find plugins.
  *
@@ -78,7 +79,7 @@ import * as express from "express"
  */
 
 /**
- * Your plugin module must implement this interface.
+ * Your plugin module must have a top level export "plugin" that implements this interface.
  *
  * The plugin's router will be mounted at <code-sever-root>/<plugin-path>
  */

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,8 @@ import * as express from "express"`
`16`	`16`	`/**`
`17`	`17`	`* Plugins`
`18`	`18`	`*`
`19`		`- * Plugins are just node modules.`
	`19`	`+ * Plugins are just node modules that contain a top level export "plugin" that implements`
	`20`	`+ * the Plugin interface.`
`20`	`21`	`*`
`21`	`22`	`* 1. code-server uses $CS_PLUGIN to find plugins.`
`22`	`23`	`*`
`@@ -78,7 +79,7 @@ import * as express from "express"`
`78`	`79`	`*/`
`79`	`80`
`80`	`81`	`/**`
`81`		`- * Your plugin module must implement this interface.`
	`82`	`+ * Your plugin module must have a top level export "plugin" that implements this interface.`
`82`	`83`	`*`
`83`	`84`	`* The plugin's router will be mounted at <code-sever-root>/<plugin-path>`
`84`	`85`	`*/`