Add documentation for disabled extensions functionality

baincd · Jun 20, 2021 · bc15b3f · bc15b3f
1 parent c2a946e
commit bc15b3f
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2021-06-20
+### Added
+- Ability to configure extensions that should be disabled for a profile
+
 ## [1.0.0] - 2021-06-19
 ### Added
 - Configuration settings to define profiles, activated profiles, and startup check enablement

diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ Extension Profiles provides a workaround (within the limitations of the vscode A
 ```jsonc
     "extension-profiles.profiles": {
       "Spring Boot": { // Extension Profile name
-        "extensions": [
+        "extensions": [ // List of extensions that should be enabled
           "vscjava.vscode-java-pack",
           "pivotal.vscode-spring-boot",
           "gabrielbb.vscode-lombok",
@@ -46,12 +46,35 @@ Extension Profiles provides a workaround (within the limitations of the vscode A
 
 ## Additional Features
 
-- From the "Extension Profiles: Active Profiles Setup" command, you can also
-    - View the extensions for a profile in the extensions sidebar (without activating/deactivating the profile for the workspace)
-    - Deactivate a profile (extensions will be displayed in extension sidebar so you can manually disable them)
-- Create keyboard shortcut to activate a profile.
+### Command
+
+From the "Extension Profiles: Active Profiles Setup" command, you can:
+
+  - Activate a profile (as described above)
+  - View the extensions for a profile in the extensions sidebar (without activating/deactivating the profile for the workspace)
+  - Deactivate a profile (extensions will be displayed in extension sidebar so you can manually disable them)
+
+### Configure Disabled Extensions on Profiles
+
+Profiles can also be configured with extensions that should be disabled.  If there are extensions that should be disabled in the workspace, a popup will notify you along with a button so you can easily disable the extensions on the extension sidebar.
+
+To configure disabled extensions:
+```jsonc
+    "extension-profiles.profiles": {
+      "Java": {
+        "extensions": [
+          "vscjava.vscode-java-pack"
+        ],
+        "disabledExtensions": [ // List of extensions that should be disabled
+          "noone.bad-extensions-for-java"
+        ]
+      },
+    },
+```
+
+### Create keyboard shortcut to directly activate a profile
 
-`keybindings.json`:
+To configure a keyboard shortcut to active a profile, add to `keybindings.json`:
 ```json
 {
     "key": "ctrl+k ctrl+z",
@@ -64,4 +87,4 @@ Extension Profiles provides a workaround (within the limitations of the vscode A
 ## Known Limitations
 
 - Extension cannot automatically enabled/disable extensions (vscode API limitation).  As a workaround, the extension sidebar search is used to display the list of extensions so you can quickly enable/disable extensions in a workspace
-    - The extension sidebar search has a limitation of 200 characters (additional characters after the 200th are not considered for the search).  A warning message will be displayed if this occurs
+- The extension sidebar search has a limitation of 200 characters (additional characters after the 200th are not considered for the search).  A warning message will be displayed if this occurs