feat: Add configuration option to control QuickPick Esc behavior (#63)

* Initial plan

* Add configuration option for QuickPick Esc behavior

Co-authored-by: PKief <[email protected]>

* Update README.md to include Quick Pick ESC behavior configuration

* Add quickPickEscBehavior and dateTemplate to default settings

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: PKief <[email protected]>
Co-authored-by: Philipp Kief <[email protected]>

Author: Copilot

README.md

@@ -1,176 +1,189 @@
-<h1 align="center">
-  <br>
-    <img src="https://raw.githubusercontent.com/PKief/vscode-markdown-checkbox/main/logo.png" alt="logo" width="200">
-  <br><br>
-  Markdown Checkbox
-  <br>
-  <br>
-</h1>
-
-<h4 align="center">Create and toggle checkboxes in Markdown documents</h4>
-
-<p align="center">
-    <a href="https://marketplace.visualstudio.com/items?itemName=PKief.markdown-checkbox"><img src="https://vsmarketplacebadges.dev/version/PKief.markdown-checkbox.svg?style=for-the-badge&colorA=252526&colorB=43A047&label=VERSION" alt="Version"></a>&nbsp;
-    <a href="https://marketplace.visualstudio.com/items?itemName=PKief.markdown-checkbox"><img src="https://vsmarketplacebadges.dev/rating-short/PKief.markdown-checkbox.svg?style=for-the-badge&colorA=252526&colorB=43A047&label=Rating" alt="Rating"></a>&nbsp;
-    <a href="https://marketplace.visualstudio.com/items?itemName=PKief.markdown-checkbox"><img src="https://vsmarketplacebadges.dev/installs-short/PKief.markdown-checkbox.svg?style=for-the-badge&colorA=252526&colorB=43A047&label=Installs" alt="Installs"></a>&nbsp;
-    <a href="https://marketplace.visualstudio.com/items?itemName=PKief.markdown-checkbox"><img src="https://vsmarketplacebadges.dev/downloads-short/PKief.markdown-checkbox.svg?style=for-the-badge&colorA=252526&colorB=43A047&label=Downloads" alt="Downloads"></a>
-</p>
-
-## Description
-
-With this extension for Visual Studio Code it's possible to create todo lists in markdown. The extension provides shortcuts and some workspace configurations to create checkboxes and mark them with a shortcut.
-
-## How to use
-
-![Preview](https://raw.githubusercontent.com/PKief/vscode-extension-markdown-checkbox/main/images/preview.gif)
-
-## Information in status bar
-
-![Preview of status bar information](https://raw.githubusercontent.com/PKief/vscode-extension-markdown-checkbox/main/images/statusbar_preview.png)
-
-_At least one checkbox must exist in a file to see this information._
-
-## Pick Checkboxes
-
-Toggle all checkboxes in the current document with the Multi-Select QuickPick:
-
-![Preview of Multi-Select QuickPick](images/pick_checkboxes.gif)
-
-The QuickPick can be opened either from the command palette or by clicking on the status bar item.
-
-## Keybindings
-
-| Command           | Windows                                               | Mac                                            |
-| ----------------- | ----------------------------------------------------- | ---------------------------------------------- |
-| Create a checkbox | <kbd>CTRL</kbd> + <kbd>Shift</kbd> + <kbd>c</kbd>     | <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>c</kbd>     |
-| Toggle checkbox   | <kbd>CTRL</kbd> + <kbd>Shift</kbd> + <kbd>Enter</kbd> | <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>Enter</kbd> |
-
-These are the initial keyboard shortcuts, which can be customized by the [Keyboard Shortcuts](https://code.visualstudio.com/docs/getstarted/keybindings) settings in VS Code.
-
-## Configuration
-
-This extension can be customized with the following options.
-
-### Bullet points
-
-If bullet points before the checkboxes are required, then they can be enabled with the following setting:
-
-    options: true | false
-
-```json
-"markdown-checkbox.withBulletPoint": true
-```
-
-Example:
-
-```
-* [ ] todo
-```
-
-### Type of bullet points
-
-Select a type of bullet point:
-
-    options: "*" | "-" | "+"
-
-```json
-"markdown-checkbox.typeOfBulletPoint": "*"
-```
-
-Example
-
-```
-* [ ] asterisk
-- [ ] minus
-+ [ ] plus
-```
-
-### Type of checkmark
-
-Select a type of checkmark:
-
-    options: "X" | "x"
-
-```json
-"markdown-checkbox.checkmark": "X"
-```
-
-Example
-
-```
-- [X] uppercase checkmark
-- [x] lowercase checkmark
-```
-
-### Italic
-
-Italic font style of line of the checkbox after the checkbox has been checked:
-
-    options: true | false
-
-```json
-"markdown-checkbox.italicWhenChecked": true
-```
-
-Preview
-
-- [x] _this line is italic_
-
-### Strikethrough
-
-Strikethrough the line of the checkbox after the checkbox has been checked:
-
-    options: true | false
-
-```json
-"markdown-checkbox.strikeThroughWhenChecked": true
-```
-
-Preview:
-
-- [x] ~~_this line has been crossed out_~~
-
-### Date when checked
-
-Add date behind the checkbox item after the checkbox has been checked:
-
-    options: true | false
-
-```json
-"markdown-checkbox.dateWhenChecked": true
-```
-
-Preview:
-
-- [x] ~~_sample with date_~~ [2017-11-23]
-
-### Format date
-
-If dates are enabled, they can be formatted with the following user setting:
-
-```json
-"markdown-checkbox.dateFormat": "YYYY-MM-DD"
-```
-
-It makes use of the JavaScript library [moment.js](https://momentjs.com/docs/#/parsing/string-format/) which means that the date format patterns can be found there.
-
-In addition the syntax around in which the date is placed can be defined via template. `{date}` will be replaced by the actual date value:
-
-```json
-"markdown-checkbox.dateTemplate": "({date})"
-```
-
-Preview:
-
-- [x] ~~_sample with date_~~ (2017-11-23)
-
-### Specify language IDs
-
-Besides markdown, this extension can also be used for other languages in VS Code. The language IDs can be specified in the user settings like this:
-
-```json
-"markdown-checkbox.languages": [
-    "markdown",
-    "plaintext"
-]
-```
+<h1 align="center">
+  <br>
+    <img src="https://raw.githubusercontent.com/PKief/vscode-markdown-checkbox/main/logo.png" alt="logo" width="200">
+  <br><br>
+  Markdown Checkbox
+  <br>
+  <br>
+</h1>
+
+<h4 align="center">Create and toggle checkboxes in Markdown documents</h4>
+
+<p align="center">
+    <a href="https://marketplace.visualstudio.com/items?itemName=PKief.markdown-checkbox"><img src="https://vsmarketplacebadges.dev/version/PKief.markdown-checkbox.svg?style=for-the-badge&colorA=252526&colorB=43A047&label=VERSION" alt="Version"></a>&nbsp;
+    <a href="https://marketplace.visualstudio.com/items?itemName=PKief.markdown-checkbox"><img src="https://vsmarketplacebadges.dev/rating-short/PKief.markdown-checkbox.svg?style=for-the-badge&colorA=252526&colorB=43A047&label=Rating" alt="Rating"></a>&nbsp;
+    <a href="https://marketplace.visualstudio.com/items?itemName=PKief.markdown-checkbox"><img src="https://vsmarketplacebadges.dev/installs-short/PKief.markdown-checkbox.svg?style=for-the-badge&colorA=252526&colorB=43A047&label=Installs" alt="Installs"></a>&nbsp;
+    <a href="https://marketplace.visualstudio.com/items?itemName=PKief.markdown-checkbox"><img src="https://vsmarketplacebadges.dev/downloads-short/PKief.markdown-checkbox.svg?style=for-the-badge&colorA=252526&colorB=43A047&label=Downloads" alt="Downloads"></a>
+</p>
+
+## Description
+
+With this extension for Visual Studio Code it's possible to create todo lists in markdown. The extension provides shortcuts and some workspace configurations to create checkboxes and mark them with a shortcut.
+
+## How to use
+
+![Preview](https://raw.githubusercontent.com/PKief/vscode-extension-markdown-checkbox/main/images/preview.gif)
+
+## Information in status bar
+
+![Preview of status bar information](https://raw.githubusercontent.com/PKief/vscode-extension-markdown-checkbox/main/images/statusbar_preview.png)
+
+_At least one checkbox must exist in a file to see this information._
+
+## Pick Checkboxes
+
+Toggle all checkboxes in the current document with the Multi-Select QuickPick:
+
+![Preview of Multi-Select QuickPick](images/pick_checkboxes.gif)
+
+The QuickPick can be opened either from the command palette or by clicking on the status bar item.
+
+## Keybindings
+
+| Command           | Windows                                               | Mac                                            |
+| ----------------- | ----------------------------------------------------- | ---------------------------------------------- |
+| Create a checkbox | <kbd>CTRL</kbd> + <kbd>Shift</kbd> + <kbd>c</kbd>     | <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>c</kbd>     |
+| Toggle checkbox   | <kbd>CTRL</kbd> + <kbd>Shift</kbd> + <kbd>Enter</kbd> | <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>Enter</kbd> |
+
+These are the initial keyboard shortcuts, which can be customized by the [Keyboard Shortcuts](https://code.visualstudio.com/docs/getstarted/keybindings) settings in VS Code.
+
+## Configuration
+
+This extension can be customized with the following options.
+
+### Bullet points
+
+If bullet points before the checkboxes are required, then they can be enabled with the following setting:
+
+    options: true | false
+
+```json
+"markdown-checkbox.withBulletPoint": true
+```
+
+Example:
+
+```
+* [ ] todo
+```
+
+### Type of bullet points
+
+Select a type of bullet point:
+
+    options: "*" | "-" | "+"
+
+```json
+"markdown-checkbox.typeOfBulletPoint": "*"
+```
+
+Example
+
+```
+* [ ] asterisk
+- [ ] minus
++ [ ] plus
+```
+
+### Type of checkmark
+
+Select a type of checkmark:
+
+    options: "X" | "x"
+
+```json
+"markdown-checkbox.checkmark": "X"
+```
+
+Example
+
+```
+- [X] uppercase checkmark
+- [x] lowercase checkmark
+```
+
+### Italic
+
+Italic font style of line of the checkbox after the checkbox has been checked:
+
+    options: true | false
+
+```json
+"markdown-checkbox.italicWhenChecked": true
+```
+
+Preview
+
+- [x] _this line is italic_
+
+### Strikethrough
+
+Strikethrough the line of the checkbox after the checkbox has been checked:
+
+    options: true | false
+
+```json
+"markdown-checkbox.strikeThroughWhenChecked": true
+```
+
+Preview:
+
+- [x] ~~_this line has been crossed out_~~
+
+### Date when checked
+
+Add date behind the checkbox item after the checkbox has been checked:
+
+    options: true | false
+
+```json
+"markdown-checkbox.dateWhenChecked": true
+```
+
+Preview:
+
+- [x] ~~_sample with date_~~ [2017-11-23]
+
+### Format date
+
+If dates are enabled, they can be formatted with the following user setting:
+
+```json
+"markdown-checkbox.dateFormat": "YYYY-MM-DD"
+```
+
+It makes use of the JavaScript library [moment.js](https://momentjs.com/docs/#/parsing/string-format/) which means that the date format patterns can be found there.
+
+In addition the syntax around in which the date is placed can be defined via template. `{date}` will be replaced by the actual date value:
+
+```json
+"markdown-checkbox.dateTemplate": "({date})"
+```
+
+Preview:
+
+- [x] ~~_sample with date_~~ (2017-11-23)
+
+### Specify language IDs
+
+Besides markdown, this extension can also be used for other languages in VS Code. The language IDs can be specified in the user settings like this:
+
+```json
+"markdown-checkbox.languages": [
+    "markdown",
+    "plaintext"
+]
+```
+
+### Change the Quick Pick ESC behavior
+
+The Quick Pick can be closed with the ESC key. The behavior can be configured with the following setting:
+
+```json
+"markdown-checkbox.quickPickEscBehavior": "doNothing"
+```
+
+Possible values are:
+
+- `doNothing`: Do nothing when ESC is pressed
+- `uncheckAll`: Uncheck all checkboxes when ESC is pressed

package.json

@@ -167,6 +167,15 @@
           "type": "string",
           "default": "[{date}]",
           "markdownDescription": "The date template `{date}` is replaced by the actual date."
+        },
+        "markdown-checkbox.quickPickEscBehavior": {
+          "type": "string",
+          "enum": [
+            "doNothing",
+            "uncheckAll"
+          ],
+          "default": "doNothing",
+          "description": "Behavior when pressing Esc in the QuickPick panel. 'doNothing' preserves current state, 'uncheckAll' unchecks all checkboxes."
         }
       }
     }