From d1a05e3d17ff8b591d3cadf851cf8e8e3e3b1d85 Mon Sep 17 00:00:00 2001 From: Colton Loftus <70598503+C-Loftus@users.noreply.github.com> Date: Fri, 1 Mar 2024 15:54:56 -0500 Subject: [PATCH 1/6] Create visualAccessibility.md --- docs/user/visualAccessibility.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/user/visualAccessibility.md diff --git a/docs/user/visualAccessibility.md b/docs/user/visualAccessibility.md new file mode 100644 index 0000000000..2d7c851175 --- /dev/null +++ b/docs/user/visualAccessibility.md @@ -0,0 +1,22 @@ +# Visual Accessibility + +Cursorless has multiple settings that can be customized to improve accessibility for users with color blindness or other vision impairments. You can read or configure a list of all [IDE-side settings](./customization.md/#ide-side-settings) related to visual display by saying `cursorless settings` while your IDE is focused. + +If you are a user with color blindness, it may be helpful to disable a subset or all colors and enable more shapes instead. If you are a user that prefers larger hats, you can also increase their baseline size and vertical offset, beyond what will be automatically scale based on your IDE zoom percentage. + +One notable colorscheme is the [Greyscale for Night Owl theme](https://github.com/cursorless-dev/cursorless/wiki/Color-schemes#greyscale-for-night-owl-theme), which is designed to reduce visual stimulation and be compatible with most forms of color blindness. The colors are as follows, but can be changed easily to fit your preferences: + +``` +"default": "#848384", +"bright": "#ffffff", +"dark": "#333333", +``` + +To use this or any colorscheme, do the following: + +- Say `cursorless settings` within your IDE +- Find your list of colors in `cursorless.colors.light` or `cursorless.colors.dark` depending on your preferred mode +- Replace the colors with the ones from the colorscheme +- Disable colors you do not want to see in `cursorless.hatEnablement.color` +- Change spoken forms if desired within your Cursorless settings folder located at`cursorless-settings/hat_styles.csv` + - _Note: this is within your Talon configuration, not the IDE settings_ From fc27b15f8ce2d7080f0cf7766cfbbfed999e7ab9 Mon Sep 17 00:00:00 2001 From: Colton Loftus <70598503+C-Loftus@users.noreply.github.com> Date: Fri, 1 Mar 2024 16:02:37 -0500 Subject: [PATCH 2/6] visual a11y info --- docs/user/visualAccessibility.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/visualAccessibility.md b/docs/user/visualAccessibility.md index 2d7c851175..b2771abb39 100644 --- a/docs/user/visualAccessibility.md +++ b/docs/user/visualAccessibility.md @@ -1,6 +1,6 @@ # Visual Accessibility -Cursorless has multiple settings that can be customized to improve accessibility for users with color blindness or other vision impairments. You can read or configure a list of all [IDE-side settings](./customization.md/#ide-side-settings) related to visual display by saying `cursorless settings` while your IDE is focused. +Cursorless has multiple settings that can be customized to improve accessibility for users with color blindness or other vision impairments. All IDE settings, including those relevant to visual accessibility, can be found by saying `cursorless settings` while your IDE is focused. If you are a user with color blindness, it may be helpful to disable a subset or all colors and enable more shapes instead. If you are a user that prefers larger hats, you can also increase their baseline size and vertical offset, beyond what will be automatically scale based on your IDE zoom percentage. From 43893b2b8b333eb9a8a03334d3ef890dcfb45045 Mon Sep 17 00:00:00 2001 From: Pokey Rule <755842+pokey@users.noreply.github.com> Date: Thu, 14 Mar 2024 17:18:42 +0000 Subject: [PATCH 3/6] tweaks --- docs/user/README.md | 2 +- docs/user/visualAccessibility.md | 36 +++++++++++++++++++------------- 2 files changed, 22 insertions(+), 16 deletions(-) diff --git a/docs/user/README.md b/docs/user/README.md index 5b425e8f81..25eb4fd2ef 100644 --- a/docs/user/README.md +++ b/docs/user/README.md @@ -66,7 +66,7 @@ The following colors are supported. Note that to target the default (gray) hat y You can enable or disable colors in your VSCode settings, by searching for `cursorless.hatEnablement.colors` and checking the box next to the internal ID for the given shape as listed above. To navigate to your VSCode settings, either say "show settings", or go to File --> Preferences --> Settings. -You can also tweak the visible colors for any of these colors in your VSCode settings, by searching for `cursorless.colors` and changing the hex color code next to the internal ID for the given shape as listed above. Note that you can configure different colors for dark and light themes. +You can also tweak the visible colors for any of these colors in your VSCode settings, by searching for `cursorless.colors` and changing the hex color code next to the internal ID for the given shape as listed above. Note that you can configure different colors for dark and light themes. See our [visual accessibility guide](visualAccessibility.md) for more on visual accessibility. If you find these color names unintuitive / tough to remember, their spoken forms can be [customized](customization.md) like any other spoken form diff --git a/docs/user/visualAccessibility.md b/docs/user/visualAccessibility.md index b2771abb39..37b4bdb612 100644 --- a/docs/user/visualAccessibility.md +++ b/docs/user/visualAccessibility.md @@ -1,22 +1,28 @@ # Visual Accessibility -Cursorless has multiple settings that can be customized to improve accessibility for users with color blindness or other vision impairments. All IDE settings, including those relevant to visual accessibility, can be found by saying `cursorless settings` while your IDE is focused. +Cursorless has multiple settings that can be customized to improve accessibility for users with color blindness or other vision impairments. This guide has a few techniques to help you customize Cursorless to fit your needs. The primary visual elements of Cursorless are the [hats](./README.md#decorated-symbol), so this guide will focus on customizing the hats. -If you are a user with color blindness, it may be helpful to disable a subset or all colors and enable more shapes instead. If you are a user that prefers larger hats, you can also increase their baseline size and vertical offset, beyond what will be automatically scale based on your IDE zoom percentage. +## Make the hats bigger -One notable colorscheme is the [Greyscale for Night Owl theme](https://github.com/cursorless-dev/cursorless/wiki/Color-schemes#greyscale-for-night-owl-theme), which is designed to reduce visual stimulation and be compatible with most forms of color blindness. The colors are as follows, but can be changed easily to fit your preferences: +Say `"cursorless settings"` and find the `cursorless.hatSize` setting. This setting allows you to increase the size of the hats. You may need to change the vertical offset of the hats to keep them from clipping the line below / above. -``` -"default": "#848384", -"bright": "#ffffff", -"dark": "#333333", -``` +You may also want to increase your line height to allow you to make the hats even larger: say `"show settings say line height"` and increase the line height to your preference. -To use this or any colorscheme, do the following: +A reasonable place to start is to set the line height to 1.6 and the hat size to 70. -- Say `cursorless settings` within your IDE -- Find your list of colors in `cursorless.colors.light` or `cursorless.colors.dark` depending on your preferred mode -- Replace the colors with the ones from the colorscheme -- Disable colors you do not want to see in `cursorless.hatEnablement.color` -- Change spoken forms if desired within your Cursorless settings folder located at`cursorless-settings/hat_styles.csv` - - _Note: this is within your Talon configuration, not the IDE settings_ +## Use shapes instead of colors + +If you are a user with color blindness, it may be helpful to disable a subset or all colors and enable shapes instead. You can do so by saying `"cursorless settings"` and finding the `cursorless.hatEnablement.colors` and `cursorless.hatEnablement.shapes` settings. + +## Tweak your color scheme + +You can change the colors of the hats by saying `"cursorless settings"` and finding the `cursorless.colors.light` and `cursorless.colors.dark` settings. + +There are several user-created color schemes available [on the Cursorless wiki](https://github.com/cursorless-dev/cursorless/wiki/Color-schemes). One notable color scheme is the [Greyscale for Night Owl theme](https://github.com/cursorless-dev/cursorless/wiki/Color-schemes#greyscale-for-night-owl-theme), which is designed to reduce visual stimulation and be compatible with most forms of color blindness. Instead of colors like "yellow", "green", etc, it uses "bright" and "dark". Here's how you use it: + +1. Say `"cursorless settings"` and find the `cursorless.colors.light` or `cursorless.colors.dark` settings depending on your preferred mode +1. Change your `default` color to `#848384` +1. Change your `blue` color to `#ffffff` +1. Change your `green` color to `#333333` +1. Disable the other colors using the `cursorless.hatEnablement.colors` setting +1. Change spoken forms within your Cursorless settings folder located at `cursorless-settings/hat_styles.csv` so that you have `bright, blue` and `dark, green`. This is within your Talon configuration, not the IDE settings. This will change the spoken forms to match the new colors so that you can say eg `"take bright air"` to select the word "air" with a bright hat. From 5c801d39fe76e0bbd720db9e5e108a6e077a41df Mon Sep 17 00:00:00 2001 From: Pokey Rule <755842+pokey@users.noreply.github.com> Date: Thu, 14 Mar 2024 17:24:32 +0000 Subject: [PATCH 4/6] More tweaks --- docs/user/visualAccessibility.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user/visualAccessibility.md b/docs/user/visualAccessibility.md index 37b4bdb612..84e00eb61d 100644 --- a/docs/user/visualAccessibility.md +++ b/docs/user/visualAccessibility.md @@ -1,6 +1,6 @@ # Visual Accessibility -Cursorless has multiple settings that can be customized to improve accessibility for users with color blindness or other vision impairments. This guide has a few techniques to help you customize Cursorless to fit your needs. The primary visual elements of Cursorless are the [hats](./README.md#decorated-symbol), so this guide will focus on customizing the hats. +Cursorless has multiple settings that can be customized to improve accessibility for users with color blindness or other vision impairments. The primary visual elements of Cursorless are the [hats](./README.md#decorated-symbol), so this guide will focus on customizing the hats. ## Make the hats bigger @@ -25,4 +25,4 @@ There are several user-created color schemes available [on the Cursorless wiki]( 1. Change your `blue` color to `#ffffff` 1. Change your `green` color to `#333333` 1. Disable the other colors using the `cursorless.hatEnablement.colors` setting -1. Change spoken forms within your Cursorless settings folder located at `cursorless-settings/hat_styles.csv` so that you have `bright, blue` and `dark, green`. This is within your Talon configuration, not the IDE settings. This will change the spoken forms to match the new colors so that you can say eg `"take bright air"` to select the word "air" with a bright hat. +1. Change spoken forms within your Cursorless settings folder located at `cursorless-settings/hat_styles.csv` so that you have `bright, blue` and `dark, green`. This is within your Talon configuration, not the IDE settings. This will change the spoken forms to match the new colors so that you can say eg `"take bright air"` to select the word "air" with a bright hat. See [Customization](./customization.md) for more information on how to change spoken forms. From 010a4c7e259af3b91ff12e8efe509a7198880759 Mon Sep 17 00:00:00 2001 From: Colton Loftus <70598503+C-Loftus@users.noreply.github.com> Date: Mon, 18 Mar 2024 13:31:11 -0400 Subject: [PATCH 5/6] pyright init --- pyproject.toml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index 8b383b8011..5adfd18020 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,4 +14,14 @@ target-version = "py311" extend-exclude = ["vendor", "data/playground/**/*.py"] [tool.pyright] +# Talon classes don't use self so ignore the associated errors reportSelfClsParameterName = false + +# Ignore the type of parameter X must be a supertype of its class +# reportGeneralTypeIssues = false + +# Imgui functions return an object that can't be statically resolved +reportFunctionMemberAccess = false +# Talon can't be installed in CI so ignore source errors +reportMissingModuleSource = false +reportMissingImports = false From dc6b2a4199949fe657e60e5dfdc5057c25fb01a1 Mon Sep 17 00:00:00 2001 From: Colton Loftus <70598503+C-Loftus@users.noreply.github.com> Date: Mon, 18 Mar 2024 14:31:27 -0400 Subject: [PATCH 6/6] add pyright --- .github/workflows/test.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index a540df4ea4..a8e0d793c8 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -74,3 +74,9 @@ jobs: if: failure() - name: Forbid TODOs run: ./scripts/forbid-todo.sh + + - name: Pyright + uses: jakebailey/pyright-action@v2 + with: + version: 1.1.311 # Optional (change me!) + python-version: 3.11