feat: add a command to disable all optional features after install (finally!)

Author: zardoy

README.MD

@@ -16,7 +16,9 @@ TOC:
 - [Contributed Code Actions](#contributed-code-actions)
 - [Even Even More](#even-even-more)
 
-> *Note* Visit website for list of recommended settings: <https://ts-plugin.zardoy.com/>
+> *Note*: You can disable all optional features with `> Disable All Optional Features` setting right after install.
+>
+> *Note*: Visit website for list of recommended settings: <https://ts-plugin.zardoy.com/>
 
 ## Top Features
 

package.json

@@ -58,6 +58,10 @@
             {
                 "command": "pasteCodeWithImports",
                 "title": "Paste Code with Imports"
+            },
+            {
+                "command": "disableAllOptionalFeatures",
+                "title": "Disable All Optional Features"
             }
         ],
         "keybindings": [
@@ -90,7 +94,7 @@
     "keywords": [
         "ts",
         "javascript",
-        "plugin",
+        "pro",
         "webstorm",
         "typescript hero"
     ],

src/configurationType.ts

@@ -118,6 +118,7 @@ export type Configuration = {
     /**
      * Will be `format-short` by default in future as super useful!
      * Requires TypeScript 5.0+
+     * @recommended
      * @default disable
      */
     'suggestions.displayImportedInfo': 'disable' | 'short-format' | 'long-format'
@@ -160,14 +161,15 @@ export type Configuration = {
      * */
     'correctSorting.enable': boolean
     /**
-     * Try to restore suggestion sorting after `.`
+     * Try to restore properties (not variables!) sorting as in source
      * Experimental and most probably will be changed in future
+     * @recommended
      * @default false
      */
     fixSuggestionsSorting: boolean
-    // TODO
+    // TODO-low
     /**
-     * Mark QuickFixes & refactorings with 🔵
+     * Mark refactorings with 🔵
      * @default true
      */
     'markTsCodeActions.enable': boolean
@@ -205,6 +207,11 @@ export type Configuration = {
      * @default true
      * */
     'removeCodeFixes.enable': boolean
+    /**
+     * @default ["fixMissingFunctionDeclaration"]
+     * @uniqueItems true
+     *  */
+    'removeCodeFixes.codefixes': FixId[]
     /**
      * Also rename name of default or namespace import on refactor caused by file move / rename
      * Probably will be enabled by default in future
@@ -228,13 +235,8 @@ export type Configuration = {
      */
     workspaceSymbolSearchExcludePatterns: string[]
     /**
-     * @default ["fixMissingFunctionDeclaration"]
-     * @uniqueItems true
-     *  */
-    'removeCodeFixes.codefixes': FixId[]
-    /**
-     * Use full-blown emmet in jsx/tsx files!
-     * Requires `jsxPseudoEmmet.enabled` to be disabled and `emmet.excludeLanguages` to have `javascriptreact` and `typescriptreact`
+     * Use strict & precise emmet in jsx/tsx files! Doesn't annoy you everywhere!
+     * Requires `jsxPseudoEmmet.enabled` to be disabled and `emmet.excludeLanguages` to have `javascriptreact` / `typescriptreact`
      * @default true
      * */
     'jsxEmmet.enable': boolean
@@ -443,11 +445,11 @@ export type Configuration = {
      */
     // completionHelpers: boolean
     /**
-     * Extend TypeScript outline!
-     * Extend outline with:
+     * Extend TypeScript outline with:
      * - JSX Elements
      * - Type Alias Declarations
      * Should be stable!
+     * @recommended
      * @default false
      */
     patchOutline: boolean
@@ -458,6 +460,7 @@ export type Configuration = {
     'outline.arraysTuplesNumberedItems': boolean
     /**
      * Exclude covered strings/enum cases in switch in completions
+     * @deprecated Will be removed in next release
      * @default true
      */
     switchExcludeCoveredCases: boolean
@@ -520,12 +523,12 @@ export type Configuration = {
      */
     'figIntegration.enableWhenStartsWith': string[]
     /**
-     * Propose additional completions in object. Just like `typescript.suggest.objectLiteralMethodSnippets.enabled`, but also for string, arrays and objects
+     * Propose additional completions in object. Just like `typescript.suggest.objectLiteralMethodSnippets.enabled`, but also for strings, arrays and objects
      * @default true
      */
     'objectLiteralCompletions.moreVariants': boolean
     /**
-     * When `moreVariants` enabled, always add as fallback variant if other variant can't be derived
+     * When `moreVariants` is enabled, always add fallback variant (`: `) if other variant can't be derived
      * @default false
      */
     'objectLiteralCompletions.fallbackVariant': boolean

src/extension.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-require-imports */
 import * as vscode from 'vscode'
 import { defaultJsSupersetLangs } from '@zardoy/vscode-utils/build/langs'
-import { extensionCtx, getExtensionSetting, getExtensionSettingId } from 'vscode-framework'
+import { Settings, extensionCtx, getExtensionSetting, getExtensionSettingId, registerExtensionCommand } from 'vscode-framework'
 import { pickObj } from '@zardoy/utils'
 import { watchExtensionSettings } from '@zardoy/vscode-utils/build/settings'
 import webImports from './webImports'
@@ -16,6 +16,7 @@ import vueVolarSupport from './vueVolarSupport'
 import moreCompletions from './moreCompletions'
 import { mergeSettingsFromScopes } from './mergeSettings'
 import codeActionProvider from './codeActionProvider'
+import { ConditionalPick } from 'type-fest'
 
 let isActivated = false
 // let erroredStatusBarItem: vscode.StatusBarItem | undefined
@@ -90,6 +91,7 @@ export const activateTsPlugin = (tsApi: { configurePlugin; onCompletionAccepted
 }
 
 export const activate = async () => {
+    registerDisableOptionalFeaturesCommand()
     migrateSettings()
 
     const possiblyActivateTsPlugin = async () => {
@@ -138,3 +140,52 @@ export const activate = async () => {
         })
     }
 }
+
+const registerDisableOptionalFeaturesCommand = () => {
+    registerExtensionCommand('disableAllOptionalFeatures', async () => {
+        const config = vscode.workspace.getConfiguration(process.env.IDS_PREFIX, null)
+        const toDisable: [keyof Settings, any][] = []
+        for (const optionalExperience of optionalExperiences) {
+            const desiredKey = Array.isArray(optionalExperience) ? optionalExperience[0] : optionalExperience
+            const desiredValue = Array.isArray(optionalExperience) ? optionalExperience[1] : false
+            if (config.get(desiredKey) !== desiredValue) toDisable.push([desiredKey, desiredValue])
+        }
+        const action = await vscode.window.showInformationMessage(
+            `${toDisable.length} features are going to be disabled`,
+            { detail: '', modal: true },
+            'Write to settings NOW',
+            'Copy settings',
+        )
+        if (!action) return
+        switch (action) {
+            case 'Write to settings NOW': {
+                for (const [key, value] of toDisable) {
+                    config.update(key, value, vscode.ConfigurationTarget.Global)
+                }
+                break
+            }
+            case 'Copy settings': {
+                vscode.env.clipboard.writeText(JSON.stringify(Object.fromEntries(toDisable), undefined, 4))
+                break
+            }
+        }
+    })
+}
+
+/** Experiences that are enabled out of the box */
+const optionalExperiences: (keyof ConditionalPick<Settings, boolean> | [keyof Settings, any])[] = [
+    'enableMethodSnippets',
+    'removeUselessFunctionProps.enable',
+    'patchToString.enable',
+    ['suggestions.keywordsInsertText', 'none'],
+    'highlightNonFunctionMethods.enable',
+    'markTsCodeActions.enable',
+    ['markTsCodeFixes.character', ''],
+    'removeCodeFixes.enable',
+    'removeDefinitionFromReferences',
+    'removeImportsFromReferences',
+    'miscDefinitionImprovement',
+    'improveJsxCompletions',
+    'objectLiteralCompletions.moreVariants',
+    'codeActions.extractTypeInferName',
+]