prepare 0.3.0

Author: Meowcolm024

CHANGELOG.md

@@ -4,13 +4,12 @@ All notable changes to the *Haskell Runner 2* will be documented in this file.
 
 ## [Unreleased]
 
-- TODO: support `cabal build` and `cabal test`
+## [0.3.0]
 
-## [0.2.2]
-
-- added `cabal repl` support in cabal project
-- extension starts on a `cabal` file
-- able to reuse terminal
+- **!! config and command name changes !!**
+- reuse terminals by default
+- added `cabal repl/build/test` support in cabal projects
+- extension now starts on a `*.cabal` file
 
 ## [0.2.1]
 

README.md

@@ -7,7 +7,7 @@ Successor of the original `Haskell Runner`.
 A simple extension to run Haskell:
 
 - Load Haskell file/project to repl (GHCi)
-- Run `stack build/test/run` inside a stack project
+- *Build*, *Test* or *Run* inside a stack or cabal project
 - Send selected Haskell code to GHCi (`ctrl+alt+right`)
 
 ## Requirements
@@ -22,7 +22,7 @@ The following configurations are available:
 - `runner2.stackPath`: path for stack executable (default `stack`)
 - `runner2.cabalPath`: path for cabal executable (default `cabal`)
 - `runner2.replTool`: by `default`, it use `ghci` in single file and use `stack repl` (or `cabal repl`) in stack project. This can be overridden by choosing other options (`ghci` for ghci only, and `stack` (or `cabal`) for stack/cabal repl only)
-- `runner2.stackRun`: show "Stack Run" button, *reload required* (default `false`)
+- `runner2.showRunButton`: show "Stack/Cabal Run" button, *reload required* (default `false`)
 
 ## Release Notes
 

package.json

@@ -3,7 +3,7 @@
     "displayName": "Haskell Runner 2",
     "description": "Shortcut for GHCi and Stack",
     "publisher": "Meowcolm024",
-    "version": "0.2.2",
+    "version": "0.3.0",
     "license": "BSD3",
     "icon": "images/hr2.png",
     "engines": {
@@ -22,7 +22,7 @@
         "onLanguage:literate haskell",
         "onLanguage:cabal",
         "workspaceContains:stack.yaml",
-        "onCommand:runner2.ghci"
+        "workspaceContains:*.cabal"
     ],
     "main": "./out/extension.js",
     "contributes": {
@@ -33,18 +33,18 @@
                 "category": "Haskell Runner 2"
             },
             {
-                "command": "runner2.stacktest",
-                "title": "Stack Test",
+                "command": "runner2.hstest",
+                "title": "Haskell Run Tests",
                 "category": "Haskell Runner 2"
             },
             {
-                "command": "runner2.stackbuild",
-                "title": "Stack Build",
+                "command": "runner2.hsbuild",
+                "title": "Haskell Build Project",
                 "category": "Haskell Runner 2"
             },
             {
-                "command": "runner2.stackrun",
-                "title": "Stack Run",
+                "command": "runner2.hsrun",
+                "title": "Haskell Run Executable",
                 "category": "Haskell Runner 2"
             },
             {
@@ -82,10 +82,10 @@
                     "default": "default",
                     "description": "Decide when to use stack/cabal repl instead of GHCi"
                 },
-                "runner2.stackRun": {
+                "runner2.showRunButton": {
                     "type": "boolean",
                     "default": false,
-                    "description": "Show stack run button"
+                    "description": "Show stack/cabal run button"
                 }
             }
         },
@@ -109,6 +109,7 @@
               "command": "runner2.sendGhci",
               "key": "ctrl+alt+right",
               "mac": "ctrl+alt+right",
+              "linux": "ctrl+alt+right",
               "when": "resourceLangId == haskell"
             }
           ]

src/config.ts

@@ -1,14 +1,17 @@
 import * as vscode from 'vscode';
 
-export type Mode = "default" | "ghci" | "stack" | "cabal";
+// only used by config
+type Mode = "default" | "ghci" | "stack" | "cabal";
+// type of current project
 export type ProjectTy = "none" | "stack" | "cabal";
 
 export type Config = {
     mode: Mode,
     ghciPath: string,
     stackPath: string,
+    cabalPath: string,
     ghciTool: (proj: ProjectTy) => string,
-    enableStackRun: boolean,
+    showRun: boolean,
 };
 
 export function getConfig(): Config {
@@ -34,7 +37,8 @@ export function getConfig(): Config {
         mode: mode,
         ghciPath: ghci,
         stackPath: stack,
+        cabalPath: cabal,
         ghciTool: tool,
-        enableStackRun: config.get("runner2.stackRun", false)
+        showRun: config.get("runner2.showRunButton", false)
     };
 }

src/extension.ts

@@ -22,14 +22,15 @@ export async function activate(context: vscode.ExtensionContext) {
     let inproject = project !== "none";
 
     // GHCi command
-    let ghci = vscode.commands.registerCommand("runner2.ghci", () => {
+    const ghci = vscode.commands.registerCommand("runner2.ghci", () => {
+        // get current file name
         let filename = option.option(vscode.window.activeTextEditor)
             .map(e => e.document)
             .flatmap(option.filterOption(util.isHaskell))
             .map(s => `\"${s.fileName}\"`);
         // currently at GHCi
         const term = terminal.flatmap(option.filterOption(t => t.name === "GHCi"))
-            .or(util.getTermOption("GHCi")).map((term) => () => {
+            .or(util.getTermOption("GHCi")).map(term => () => {
                 filename
                     .map(f => f.split("\\").join("\\\\"))   // windows path may contain backslash
                     .map(f => term.sendText(inproject ? ":r" : (":l " + f)));
@@ -44,7 +45,7 @@ export async function activate(context: vscode.ExtensionContext) {
     context.subscriptions.push(ghci);
 
     // send selected code to GHCi
-    let sendGhci = vscode.commands.registerCommand("runner2.sendGhci", () =>
+    const sendGhci = vscode.commands.registerCommand("runner2.sendGhci", () =>
         option.option(vscode.window.activeTextEditor)
             .map(e => e.document.getText(
                 new vscode.Range(e.selection.start, e.selection.end)))
@@ -53,7 +54,7 @@ export async function activate(context: vscode.ExtensionContext) {
             .map(s => {
                 const term = terminal.flatmap(option.filterOption(t => t.name === "GHCi"))
                     .or(util.getTermOption("GHCi")).map(term => () => term).orelse(() => {
-                        let term = util.getTermOption("GHCi").orelse(vscode.window.createTerminal("GHCi"));
+                        let term = vscode.window.createTerminal("GHCi");
                         term.sendText(config.ghciTool(project));     // we're not loading the file here
                         return term;
                     })();
@@ -65,25 +66,32 @@ export async function activate(context: vscode.ExtensionContext) {
 
     // button for ghci
     util.resgisterStatButton(context, "Load GHCi", "runner2.ghci");
-    // button for stack project
+
+    const setupProject = (project: string, path: string) => {
+        // setup commands
+        util.registerSimplTerm(context, "runner2.hstest", project + " Test", path + " test");
+        util.registerSimplTerm(context, "runner2.hsbuild", project + " Build", path + " build");
+        util.registerSimplTerm(context, "runner2.hsrun", project + " Run", path + " run");
+        // setup buttons
+        util.resgisterStatButton(context, project + " Build", "runner2.hsbuild");
+        util.resgisterStatButton(context, project + " Test", "runner2.hstest");
+        if (config.showRun) {
+            util.resgisterStatButton(context, project + " Run", "runner2.hsrun");
+        }
+    };
+
     switch (project) {
         case "stack":
-            // setup commands
-            util.registerSimplTerm(context, "runner2.stacktest", "Stack Test", config.stackPath + " test");
-            util.registerSimplTerm(context, "runner2.stackbuild", "Stack Build", config.stackPath + " build");
-            util.registerSimplTerm(context, "runner2.stackrun", "Stack Run", config.stackPath + " run");
-            // setup buttons
-            util.resgisterStatButton(context, "Stack Build", "runner2.stackbuild");
-            util.resgisterStatButton(context, "Stack Test", "runner2.stacktest");
-            if (config.enableStackRun) {
-                util.resgisterStatButton(context, "Stack Run", "runner2.stackrun");
-            }
+            setupProject("Stack", config.stackPath);
+            break;
+        case "cabal":
+            setupProject("Cabal", config.cabalPath);
+            break;
+        case "none": // default behavior
+            util.registerPrompt(context, "runner2.hstest", "Not in a stack/cabal project!");
+            util.registerPrompt(context, "runner2.hsbuild", "Not in a stack/cabal project!");
+            util.registerPrompt(context, "runner2.hsrun", "Not in a stack/cabal project!");
             break;
-        default:
-            // default behavior
-            util.registerPrompt(context, "runner2.stacktest", "Not in a stack project!");
-            util.registerPrompt(context, "runner2.stackbuild", "Not in a stack project!");
-            util.registerPrompt(context, "runner2.stackrun", "Not in a stack project!");
     }
 
 }

src/util.ts

@@ -34,7 +34,9 @@ export function registerSimplTerm(
     cmd: string
 ) {
     context.subscriptions.push(vscode.commands.registerCommand(command, () => {
-        let term = getTermOption(name).orelse(vscode.window.createTerminal(name));
+        let term = getTermOption(name)
+            .map(t => () => t)  // new terminal need to be created lazily
+            .orelse(() => vscode.window.createTerminal(name))();    
         term.sendText(cmd);
         term.show();
     }));