feat: add doc command (#306)

flix · Sep 10, 2023 · 91882ed · 91882ed
1 parent cec1058
commit 91882ed
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/client/src/extension.ts b/client/src/extension.ts
@@ -143,6 +143,7 @@ export async function activate(context: vscode.ExtensionContext, launchOptions:
   registerCommand('flix.cmdBuildPkg', handlers.cmdBuildPkg(context, launchOptions))
   registerCommand('flix.cmdRunProject', handlers.cmdRunProject(context, launchOptions))
   registerCommand('flix.cmdTests', handlers.cmdTests(context, launchOptions))
+  registerCommand('flix.cmdDoc', handlers.cmdDoc(context, launchOptions))
   registerCommand('flix.showParserAst', handlers.showAst(client, 'Parser'))
   registerCommand('flix.showWeederAst', handlers.showAst(client, 'Weeder'))
   registerCommand('flix.showKinderAst', handlers.showAst(client, 'Kinder'))

diff --git a/client/src/handlers/handlers.ts b/client/src/handlers/handlers.ts
@@ -507,6 +507,19 @@ export function cmdTests(context: vscode.ExtensionContext, launchOptions: Launch
   return runCmd(context, launchOptions, ':test')
 }
 
+/**
+ * builds the documentation for the current project using the command `java -jar flix.jar doc`
+ *
+ * @param context vscode.ExtensionContext
+ *
+ * @param launchOptions LaunchOptions
+ *
+ * @returns function handler
+ */
+export function cmdDoc(context: vscode.ExtensionContext, launchOptions: LaunchOptions = defaultLaunchOptions) {
+  return runCmd(context, launchOptions, ':doc')
+}
+
 /**
  * show the ast of a given phase
  *

diff --git a/package.json b/package.json
@@ -55,6 +55,10 @@
         "command": "flix.cmdTests",
         "title": "Flix: test"
       },
+      {
+        "command": "flix.cmdDoc",
+        "title": "Flix: doc"
+      },
       {
         "command": "flix.showParserAst",
         "title": "Flix: Show Parser AST"