Added quick pick to toggle all checkboxes in a document

PKief · PKief · commit 292d15d4b484 · 2018-04-08T22:36:11.000+02:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -5,7 +5,15 @@
     "version": "1.2.0",
     "publisher": "PKief",
     "engines": {
-        "vscode": "^1.4.0"
+        "vscode": "^1.22.1"
+    },
+    "scripts": {
+        "vscode:prepublish": "npm run compile",
+        "compile": "tsc -p ./",
+        "watch": "tsc -watch -p ./",
+        "postinstall": "node ./node_modules/vscode/bin/install",
+        "test": "npm run compile && node ./node_modules/vscode/bin/test",
+        "lint": "tslint ./src/**/*.ts -t stylish"
     },
     "categories": [
         "Other"
@@ -26,8 +34,8 @@
     },
     "activationEvents": [
         "onLanguage:markdown",
-        "onCommand:extension.createCheckbox",
-        "onCommand:extension.markCheckbox"
+        "onCommand:markdown-checkbox.createCheckbox",
+        "onCommand:markdown-checkbox.markCheckbox"
     ],
     "icon": "logo.png",
     "galleryBanner": {
@@ -39,23 +47,27 @@
     "contributes": {
         "commands": [
             {
-                "command": "extension.createCheckbox",
+                "command": "markdown-checkbox.createCheckbox",
                 "title": "Markdown: Create checkbox"
             },
             {
-                "command": "extension.markCheckbox",
+                "command": "markdown-checkbox.markCheckbox",
                 "title": "Markdown: Mark checkbox"
+            },
+            {
+                "command": "markdown-checkbox.showQuickPick",
+                "title": "Markdown: Pick checkboxes"
             }
         ],
         "keybindings": [
             {
-                "command": "extension.createCheckbox",
+                "command": "markdown-checkbox.createCheckbox",
                 "key": "ctrl+shift+c",
                 "mac": "cmd+shift+c",
                 "when": "editorTextFocus"
             },
             {
-                "command": "extension.markCheckbox",
+                "command": "markdown-checkbox.markCheckbox",
                 "key": "ctrl+shift+enter",
                 "mac": "cmd+shift+enter",
                 "when": "editorTextFocus"
@@ -65,14 +77,14 @@
             "editor/context": [
                 {
                     "when": "resourceLangId == markdown",
-                    "command": "extension.createCheckbox",
-                    "alt": "extension.createCheckbox",
+                    "command": "markdown-checkbox.createCheckbox",
+                    "alt": "markdown-checkbox.createCheckbox",
                     "group": "navigation"
                 },
                 {
                     "when": "resourceLangId == markdown",
-                    "command": "extension.markCheckbox",
-                    "alt": "extension.markCheckbox",
+                    "command": "markdown-checkbox.markCheckbox",
+                    "alt": "markdown-checkbox.markCheckbox",
                     "group": "navigation"
                 }
             ]
@@ -119,17 +131,11 @@
             }
         }
     },
-    "scripts": {
-        "vscode:prepublish": "npm run compile",
-        "compile": "tsc -p ./",
-        "postinstall": "node ./node_modules/vscode/bin/install",
-        "tslint": "tslint ./src/**/*.ts -t stylish"
-    },
     "devDependencies": {
         "@types/mocha": "^5.0.0",
-        "@types/node": "^9.6.0",
+        "@types/node": "^9.6.2",
         "tslint": "^5.9.1",
-        "typescript": "^2.7.2",
+        "typescript": "^2.8.1",
         "vscode": "^1.1.14"
     }
 }
diff --git a/src/checkbox.ts b/src/checkbox.ts
@@ -3,4 +3,6 @@ import { Position } from 'vscode';
 export default class Checkbox {
     checked: boolean;
     position: Position;
-}
+    text: string;
+    lineNumber: number;
+}
diff --git a/src/checkboxStatus.ts b/src/checkboxStatus.ts
@@ -1,13 +1,14 @@
-import * as helpers from './helpers';
-import { Disposable, StatusBarItem, StatusBarAlignment, window, workspace } from 'vscode';
 import * as vscode from 'vscode';
+import { Disposable, StatusBarAlignment, StatusBarItem, window, workspace } from 'vscode';
+import * as helpers from './helpers';
 
 export class CheckboxStatus {
     private _statusBarItem: StatusBarItem;
 
     public updateCheckboxStatus() {
         if (!this._statusBarItem) {
             this._statusBarItem = window.createStatusBarItem(StatusBarAlignment.Right, 200);
+            this._statusBarItem.command = 'markdown-checkbox.showQuickPick';
         }
 
         const editor = window.activeTextEditor;
@@ -17,11 +18,10 @@ export class CheckboxStatus {
         }
 
         const doc = editor.document;
-
         const showStatusBarItem = vscode.workspace.getConfiguration('markdown-checkbox').get('showStatusBarItem', true);
 
-        if (doc.languageId === "markdown" && showStatusBarItem) {
-            const allCheckboxes = helpers.getAllCheckboxes(doc);
+        if (doc.languageId === 'markdown' && showStatusBarItem) {
+            const allCheckboxes = helpers.getAllCheckboxes();
 
             if (allCheckboxes.length === 0) {
                 this._statusBarItem.hide();
@@ -66,4 +66,4 @@ export class CheckboxStatusController {
     public dispose() {
         this._disposable.dispose();
     }
-}
+}
diff --git a/src/commands/createCheckbox.ts b/src/commands/createCheckbox.ts
@@ -0,0 +1,16 @@
+import * as vscode from 'vscode';
+import { createCheckbox } from '../createCheckbox';
+import { getEditor } from '../helpers';
+
+export const createCheckboxCommand = vscode.commands.registerCommand('markdown-checkbox.createCheckbox', () => {
+    const editor = getEditor();
+
+    if (!editor) {
+        return;
+    }
+
+    const doc = editor.document;
+    if (doc.languageId === 'markdown') {
+        createCheckbox(editor);
+    }
+});
diff --git a/src/commands/markCheckbox.ts b/src/commands/markCheckbox.ts
@@ -0,0 +1,17 @@
+import * as vscode from 'vscode';
+import * as helpers from '../helpers';
+import { toggleCheckbox } from '../toggleCheckbox';
+
+export const markCheckboxCommand = vscode.commands.registerCommand('markdown-checkbox.markCheckbox', () => {
+    const editor = helpers.getEditor();
+
+    if (!editor) {
+        return;
+    }
+
+    const doc = editor.document;
+
+    if (doc.languageId === 'markdown') {
+        toggleCheckbox();
+    }
+});
diff --git a/src/commands/quickpick.ts b/src/commands/quickpick.ts
@@ -0,0 +1,61 @@
+import * as vscode from 'vscode';
+import Checkbox from '../checkbox';
+import { getAllCheckboxes, getEditor } from '../helpers';
+import { toggleCheckboxOfLine } from '../toggleCheckbox';
+
+/** Register command */
+export const showQuickPickCommand = vscode.commands.registerCommand('markdown-checkbox.showQuickPick', () => {
+    showQuickPick();
+});
+
+/** Command to toggle the folder icons. */
+const showQuickPick = () => {
+    const allCheckboxes: Checkbox[] = getAllCheckboxes();
+    showQuickPickItems(allCheckboxes).then(handleQuickPickActions);
+};
+
+/** Show QuickPick items to select prefered configuration for the folder icons. */
+const showQuickPickItems = (checkboxes: Checkbox[]) => {
+    const pickItems: vscode.QuickPickItem[] = checkboxes.map(checkbox => {
+        return {
+            description: checkbox.text,
+            picked: checkbox.checked,
+            label: 'line ' + checkbox.lineNumber.toString(),
+        } as vscode.QuickPickItem;
+    });
+    return vscode.window.showQuickPick(
+        pickItems, {
+            placeHolder: 'Toggle checkboxes',
+            ignoreFocusOut: false,
+            matchOnDescription: true,
+            canPickMany: true,
+        });
+};
+
+/** Handle the actions from the QuickPick. */
+const handleQuickPickActions = async (items: vscode.QuickPickItem[]) => {
+    const allCheckboxes: Checkbox[] = getAllCheckboxes();
+
+    // get all line numbers that must be checked
+    const linesToCheck: number[] = items.map(i => parseInt(getLineNumberOfLabel(i.label)));
+
+    // get all line numbers that must be unchecked
+    const linesToUncheck = allCheckboxes.filter(c => !linesToCheck.some(l => l === c.lineNumber)).map(c => c.lineNumber);
+
+    const editor = getEditor();
+
+    // check the checked items by the quickpick
+    for (let lineNumber of linesToCheck) {
+        const line = editor.document.lineAt(lineNumber);
+        await toggleCheckboxOfLine(line, true);
+    }
+
+    // uncheck the items that are not returned by the quick pick
+    for (let lineNumber of linesToUncheck) {
+        const line = editor.document.lineAt(lineNumber);
+        await toggleCheckboxOfLine(line, false);
+    }
+};
+
+// Get the line number out of the label of a quick pick item
+const getLineNumberOfLabel = (label: string) => label.match(/\d+/)[0];
diff --git a/src/createCheckbox.ts b/src/createCheckbox.ts
@@ -1,6 +1,5 @@
+import { Position, TextEditor, TextEditorEdit } from 'vscode';
 import * as helpers from './helpers';
-import * as vscode from 'vscode';
-import { Position, TextEditorEdit, TextEditor } from 'vscode';
 
 /** create a new checkbox at the current cursor position */
 export const createCheckbox = (editor: TextEditor): any => {
@@ -10,13 +9,13 @@ export const createCheckbox = (editor: TextEditor): any => {
 
     const line = editor.document.lineAt(helpers.getCursorPosition().line);
     const hasBullet = helpers.lineHasBulletPointAlready(line);
-    if (helpers.lineHasCheckbox(line) === null) {
+    if (!helpers.lineHasCheckbox(line)) {
         return editor.edit((editBuilder: TextEditorEdit) => {
             editBuilder.insert(new Position(
                 line.lineNumber,
                 hasBullet.pos
             ), (withBulletPoint && !hasBullet.bullet ? typeOfBulletPoint + ' ' : '') + '[ ] ');
         });
     }
-    return null;
-};
+    return undefined;
+};
diff --git a/src/extension.ts b/src/extension.ts
@@ -1,48 +1,24 @@
-'use strict';
 import * as vscode from 'vscode';
-import Checkbox from './checkbox';
-import * as helpers from './helpers';
-import { createCheckbox } from './createCheckbox';
-import { toggleCheckbox } from './toggleCheckbox';
 import { CheckboxStatus, CheckboxStatusController } from './checkboxStatus';
+import { createCheckboxCommand } from './commands/createCheckbox';
+import { markCheckboxCommand } from './commands/markCheckbox';
+import { showQuickPickCommand } from './commands/quickpick';
 
 export const activate = (context: vscode.ExtensionContext) => {
     // item in the status bar to show checkbox information
     const checkboxStatus = new CheckboxStatus();
     const controller = new CheckboxStatusController(checkboxStatus);
 
     // subscribe to changes to update the status bar
-    context.subscriptions.push(controller);
     context.subscriptions.push(checkboxStatus);
+    context.subscriptions.push(controller);
 
-    const extMarkCheckbox = vscode.commands.registerCommand('extension.markCheckbox', () => {
-        const editor = helpers.getEditor();
-        if (!editor) {
-            return;
-        }
-
-        const doc = editor.document;
-
-        if (doc.languageId === "markdown") {
-            toggleCheckbox();
-        }
-    });
-
-    const extCreateCheckbox = vscode.commands.registerCommand('extension.createCheckbox', () => {
-        const editor = helpers.getEditor();
-        if (!editor) {
-            return;
-        }
-        const doc = editor.document;
-        if (doc.languageId === "markdown") {
-            createCheckbox(editor);
-        }
-    });
-
-    context.subscriptions.push(extMarkCheckbox, extCreateCheckbox);
+    context.subscriptions.push(
+        markCheckboxCommand,
+        createCheckboxCommand,
+        showQuickPickCommand
+    );
 };
 
-// this method is called when your extension is deactivated
-export const deactivate = () => {
-    // loadStatusBarItem();
-};
+// this method is called when the extension is deactivated
+export const deactivate = () => { };
diff --git a/src/helpers.ts b/src/helpers.ts
diff --git a/src/toggleCheckbox.ts b/src/toggleCheckbox.ts
