plugin.ts: Describe private counterpart functions

nhooyr · nhooyr · commit 90d46cbdcc45 · 2020-11-03T21:18:03.000-05:00
Addresses Will's comments.
diff --git a/src/node/plugin.ts b/src/node/plugin.ts
@@ -110,6 +110,13 @@ export class PluginAPI {
     await this._loadPlugins(path.join(__dirname, "../../plugins"))
   }
 
+  /**
+   * _loadPlugins is the counterpart to loadPlugins.
+   *
+   * It differs in that it loads all plugins in a single
+   * directory whereas loadPlugins uses all available directories
+   * as documented.
+   */
   private async _loadPlugins(dir: string): Promise<void> {
     try {
       const entries = await fsp.readdir(dir, { withFileTypes: true })
@@ -149,6 +156,11 @@ export class PluginAPI {
     }
   }
 
+  /**
+   * _loadPlugin is the counterpart to loadPlugin and actually
+   * loads the plugin now that we know there is no duplicate
+   * and that the package.json has been read.
+   */
   private _loadPlugin(dir: string, packageJSON: PackageJSON): Plugin {
     dir = path.resolve(dir)
 
diff --git a/src/node/routes/apps.ts b/src/node/routes/apps.ts
@@ -1,6 +1,9 @@
 import * as express from "express"
 import { PluginAPI } from "../plugin"
 
+/**
+ * Implements the /api/applications endpoint
+ */
 export function router(papi: PluginAPI): express.Router {
   const router = express.Router()
 
diff --git a/test/plugin.test.ts b/test/plugin.test.ts
@@ -17,19 +17,19 @@ describe("plugin", () => {
     assert.deepEqual(
       [
         {
-          name: "test app",
+          name: "Test App",
           version: "4.0.0",
 
-          description: "my description",
+          description: "This app does XYZ.",
           iconPath: "/icon.svg",
 
           plugin: {
             name: "test-plugin",
             version: "1.0.0",
             modulePath: path.join(__dirname, "test-plugin"),
 
-            description: "Plugin used in code-server tests.",
             displayName: "Test Plugin",
+            description: "Plugin used in code-server tests.",
             path: "/test-plugin",
           },
         },
diff --git a/test/test-plugin/src/index.ts b/test/test-plugin/src/index.ts
@@ -21,11 +21,11 @@ export function router(): express.Router {
 export function applications(): pluginapi.Application[] {
   return [
     {
-      name: "test app",
+      name: "Test App",
       version: "4.0.0",
       iconPath: "/icon.svg",
 
-      description: "my description",
+      description: "This app does XYZ.",
     },
   ]
 }

Original file line number	Diff line number	Diff line change
`@@ -21,11 +21,11 @@ export function router(): express.Router {`
`21`	`21`	`export function applications(): pluginapi.Application[] {`
`22`	`22`	`return [`
`23`	`23`	`{`
`24`		`- name: "test app",`
	`24`	`+ name: "Test App",`
`25`	`25`	`version: "4.0.0",`
`26`	`26`	`iconPath: "/icon.svg",`
`27`	`27`
`28`		`- description: "my description",`
	`28`	`+ description: "This app does XYZ.",`
`29`	`29`	`},`
`30`	`30`	`]`
`31`	`31`	`}`