From f15acc8069559d0b3e1e266919106fa6e50936ec Mon Sep 17 00:00:00 2001 From: Cedric Halbronn Date: Thu, 7 Sep 2023 17:04:35 +0100 Subject: [PATCH 1/5] minor contributing docs --- docs/contributing/CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/contributing/CONTRIBUTING.md b/docs/contributing/CONTRIBUTING.md index 8ad61eac25..adefb606ce 100644 --- a/docs/contributing/CONTRIBUTING.md +++ b/docs/contributing/CONTRIBUTING.md @@ -45,22 +45,22 @@ extension](#running--testing-extension-locally). You may also find the [VSCode A where `some.extension` is the id of the extension you'd like to install into the sandbox -6. Copy / symlink `cursorless-talon-dev` into your Talon user directory for some useful voice commands for developing Cursorless. +6. Copy / symlink [`cursorless-talon-dev`](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless. ## Running / testing extension locally In order to test out your local version of the extension or to run unit tests locally, you need to run the extension in debug mode. To do so you need to run the `workbench.action.debug.selectandstart` command in VSCode and then select either "Run -Extension" or "Extension Tests". +extension" or "Extension tests". ### Running a subset of tests The entire test suite takes a little while to run (1-2 mins), so you may want to run just a subset of the tests. -To specify the set of tests to run, say `"debug generate subset"`, or if you haven't installed the cursorless-talon-dev files, run the VSCode task "Generate test subset file". To do this, choose "Tasks: Run Task" from the command pallete. +To specify the set of tests to run, say `"debug generate subset"`, or if you haven't installed the cursorless-talon-dev files, run the VSCode task "Generate test subset file". To do this, choose "Tasks: Run Task" from the command palette. -To run the specified subset of tests, use the "Run test subset" launch config instead of the usual "Extension Tests". +To run the specified subset of tests, use the "Extension tests subset" launch config instead of the usual "Extension tests". If you need to edit the subset of tests to run in the future, you can say `"debug edit subset"`. From e855e88eb4b545306a5037f4ce97adab00825715 Mon Sep 17 00:00:00 2001 From: Cedric Halbronn <387346+saidelike@users.noreply.github.com> Date: Wed, 13 Dec 2023 10:29:38 +0000 Subject: [PATCH 2/5] attempt to use a relative link --- docs/contributing/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/CONTRIBUTING.md b/docs/contributing/CONTRIBUTING.md index adefb606ce..98cdce95ea 100644 --- a/docs/contributing/CONTRIBUTING.md +++ b/docs/contributing/CONTRIBUTING.md @@ -45,7 +45,7 @@ extension](#running--testing-extension-locally). You may also find the [VSCode A where `some.extension` is the id of the extension you'd like to install into the sandbox -6. Copy / symlink [`cursorless-talon-dev`](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless. +6. Copy / symlink [`cursorless-talon-dev`](cursorless/cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless. ## Running / testing extension locally From 0a5abafd291936a212139efb2b226735226f2391 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Tue, 14 Jan 2025 15:42:14 +0100 Subject: [PATCH 3/5] Update docs/contributing/CONTRIBUTING.md --- docs/contributing/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/CONTRIBUTING.md b/docs/contributing/CONTRIBUTING.md index 98cdce95ea..adefb606ce 100644 --- a/docs/contributing/CONTRIBUTING.md +++ b/docs/contributing/CONTRIBUTING.md @@ -45,7 +45,7 @@ extension](#running--testing-extension-locally). You may also find the [VSCode A where `some.extension` is the id of the extension you'd like to install into the sandbox -6. Copy / symlink [`cursorless-talon-dev`](cursorless/cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless. +6. Copy / symlink [`cursorless-talon-dev`](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless. ## Running / testing extension locally From c92008452052449f2fbd6bda199183756115102a Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Tue, 14 Jan 2025 15:48:57 +0100 Subject: [PATCH 4/5] Update relative link --- docs/contributing/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/CONTRIBUTING.md b/docs/contributing/CONTRIBUTING.md index adefb606ce..ff1c2f5b9c 100644 --- a/docs/contributing/CONTRIBUTING.md +++ b/docs/contributing/CONTRIBUTING.md @@ -45,7 +45,7 @@ extension](#running--testing-extension-locally). You may also find the [VSCode A where `some.extension` is the id of the extension you'd like to install into the sandbox -6. Copy / symlink [`cursorless-talon-dev`](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless. +6. Copy / symlink [`cursorless-talon-dev`](../../cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless. ## Running / testing extension locally From d1ede6080293d1e86255b122dad95fa04afd9aab Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Tue, 14 Jan 2025 15:51:34 +0100 Subject: [PATCH 5/5] Update launch configs --- docs/contributing/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contributing/CONTRIBUTING.md b/docs/contributing/CONTRIBUTING.md index ff1c2f5b9c..78ff7818b0 100644 --- a/docs/contributing/CONTRIBUTING.md +++ b/docs/contributing/CONTRIBUTING.md @@ -51,8 +51,8 @@ extension](#running--testing-extension-locally). You may also find the [VSCode A In order to test out your local version of the extension or to run unit tests locally, you need to run the extension in debug mode. To do so you need to run -the `workbench.action.debug.selectandstart` command in VSCode and then select either "Run -extension" or "Extension tests". +the `workbench.action.debug.selectandstart` command in VSCode and then select either "VSCode: Run" +or "VSCode: Test". ### Running a subset of tests @@ -60,7 +60,7 @@ The entire test suite takes a little while to run (1-2 mins), so you may want to To specify the set of tests to run, say `"debug generate subset"`, or if you haven't installed the cursorless-talon-dev files, run the VSCode task "Generate test subset file". To do this, choose "Tasks: Run Task" from the command palette. -To run the specified subset of tests, use the "Extension tests subset" launch config instead of the usual "Extension tests". +To run the specified subset of tests, use the ": Test (subset)" launch config instead of the usual "VSCode: Test". If you need to edit the subset of tests to run in the future, you can say `"debug edit subset"`.