Merge pull request #56 from zardoy/develop

Author: zardoy

.vscode/settings.json

@@ -14,5 +14,8 @@
                 ],
             }
         }
+    ],
+    "githubPullRequests.ignoredPullRequestBranches": [
+        "develop"
     ]
 }

README.MD

@@ -66,6 +66,10 @@ usersList.map // -> usersList.map((user) => )
 
 ## Minor Useful Features
 
+### `enablePlugin` setting
+
+You can quickly disable this plugin functionality by setting this setting to false. Useful for debugging a problem for example.
+
 ### Web Support
 
 > Note: when you open TS/JS file in the web for the first time you currently need to switch editors to make everything work!

package.json

@@ -75,7 +75,7 @@
         "@vscode/emmet-helper": "^2.8.4",
         "@vscode/test-electron": "^2.1.5",
         "@zardoy/utils": "^0.0.9",
-        "@zardoy/vscode-utils": "^0.0.36",
+        "@zardoy/vscode-utils": "^0.0.41",
         "chai": "^4.3.6",
         "chokidar": "^3.5.3",
         "chokidar-cli": "^3.0.0",

pnpm-lock.yaml

@@ -0,0 +1,21 @@
+import * as vscode from 'vscode'
+import { getExtensionCommandId } from 'vscode-framework'
+import { passthroughExposedApiCommands, TriggerCharacterCommand } from '../typescript/src/ipcTypes'
+import { sendCommand } from './sendCommand'
+
+export default () => {
+    const sharedRequest = (type: TriggerCharacterCommand, { offset, relativeOffset = 0 }: RequestOptions) => {
+        const { activeTextEditor } = vscode.window
+        if (!activeTextEditor) return
+        const { document, selection } = activeTextEditor
+        offset ??= document.offsetAt(selection.active) + relativeOffset
+        return sendCommand(type, { document, position: document.positionAt(offset) })
+    }
+
+    type RequestOptions = Partial<{
+        offset: number
+        relativeOffset: number
+    }>
+    for (const cmd of passthroughExposedApiCommands)
+        vscode.commands.registerCommand(getExtensionCommandId(cmd as never), async (options: RequestOptions = {}) => sharedRequest(cmd, options))
+}

src/apiCommands.ts

@@ -34,6 +34,11 @@ type ReplaceRule = {
 // For easier testing, specify every default
 // TODO support scripting
 export type Configuration = {
+    /**
+     * Controls wether TypeScript Essentials plugin is enabled or not.
+     * @default true
+     */
+    enablePlugin: boolean
     /**
      * Removes `Symbol`, `caller`, `prototype` everywhere
      * @default true
@@ -120,10 +125,10 @@ export type Configuration = {
     'removeCodeFixes.codefixes': ('fixMissingMember' | 'fixMissingProperties' | 'fixMissingAttributes' | 'fixMissingFunctionDeclaration')[]
     /**
      * Use full-blown emmet in jsx/tsx files!
-     * Requires `jsxPseudoEmmet` be off and `emmet.excludeLanguages` to have `javascriptreact` and `typescriptreact`
+     * Requires `jsxPseudoEmmet.enabled` to be disabled and `emmet.excludeLanguages` to have `javascriptreact` and `typescriptreact`
      * @default true
      * */
-    jsxEmmet: boolean
+    'jsxEmmet.enable': boolean
     /**
      * Override snippet inserted on `.` literally
      * @default false
@@ -141,7 +146,7 @@ export type Configuration = {
      * Suggests only common tags such as div
      * @default false
      */
-    jsxPseudoEmmet: boolean
+    'jsxPseudoEmmet.enable': boolean
     /**
      * Note: Sorting matters
      */
@@ -275,4 +280,12 @@ export type Configuration = {
               }
             | false
     }
+    /**
+     * The integration is enabled, only when this array is not empty
+     * Integration supports only string within function call
+     * Examples: `cp.exec(`, `executeShellCommand(`
+     * @uniqueItems
+     * @default []
+     */
+    'figIntegration.enableWhenStartsWith': string[]
 }

src/configurationType.ts

@@ -19,13 +19,13 @@ export const registerEmmet = async () => {
             reactLangs,
             {
                 async provideCompletionItems(document, position, token, context) {
-                    if (!getExtensionSetting('jsxEmmet')) return
+                    if (!getExtensionSetting('jsxEmmet.enable')) return
                     const emmetConfig = vscode.workspace.getConfiguration('emmet')
                     if (isEmmetEnabled && !emmetConfig.excludeLanguages.includes(document.languageId)) return
 
                     const result = await sendCommand<EmmetResult>('emmet-completions', { document, position })
                     if (!result) return
-                    const offset = document.offsetAt(position)
+                    const offset: number = document.offsetAt(position)
                     const sendToEmmet = document.getText().slice(offset + result.emmetTextOffset, offset)
                     const emmetCompletions = emmet.doComplete(
                         {

src/emmet.ts

@@ -2,14 +2,16 @@
 import * as vscode from 'vscode'
 import { defaultJsSupersetLangs } from '@zardoy/vscode-utils/build/langs'
 import { getActiveRegularEditor } from '@zardoy/vscode-utils'
-import { extensionCtx, getExtensionSettingId, getExtensionCommandId, registerActiveDevelopmentCommand } from 'vscode-framework'
+import { extensionCtx, getExtensionSettingId } from 'vscode-framework'
 import { pickObj } from '@zardoy/utils'
-import { TriggerCharacterCommand } from '../typescript/src/ipcTypes'
 import { Configuration } from './configurationType'
 import webImports from './webImports'
 import { sendCommand } from './sendCommand'
 import { registerEmmet } from './emmet'
 import experimentalPostfixes from './experimentalPostfixes'
+import migrateSettings from './migrateSettings'
+import figIntegration from './figIntegration'
+import apiCommands from './apiCommands'
 
 export const activateTsPlugin = (tsApi: { configurePlugin; onCompletionAccepted }) => {
     let webWaitingForConfigSync = false
@@ -77,23 +79,6 @@ export const activateTsPlugin = (tsApi: { configurePlugin; onCompletionAccepted
         }
     })
 
-    const sharedRequest = (type: TriggerCharacterCommand, { offset, relativeOffset = 0 }: RequestOptions) => {
-        const { activeTextEditor } = vscode.window
-        if (!activeTextEditor) return
-        const { document, selection } = activeTextEditor
-        offset ??= document.offsetAt(selection.active) + relativeOffset
-        return sendCommand(type, { document, position: document.positionAt(offset) })
-    }
-
-    type RequestOptions = Partial<{
-        offset: number
-        relativeOffset: number
-    }>
-    vscode.commands.registerCommand(getExtensionCommandId('getNodeAtPosition' as never), async (options: RequestOptions = {}) =>
-        sharedRequest('nodeAtPosition', options),
-    )
-    vscode.commands.registerCommand(getExtensionCommandId('getNodePath' as never), async (options: RequestOptions = {}) => sharedRequest('nodePath', options))
-
     if (process.env.PLATFORM === 'web') {
         const possiblySyncConfig = async () => {
             const { activeTextEditor } = vscode.window
@@ -111,16 +96,14 @@ export const activateTsPlugin = (tsApi: { configurePlugin; onCompletionAccepted
     experimentalPostfixes()
     void registerEmmet()
     webImports()
+    apiCommands()
 
-    // registerActiveDevelopmentCommand(async () => {
-    //     const items: vscode.DocumentSymbol[] = await vscode.commands.executeCommand(
-    //         'vscode.executeDocumentSymbolProvider',
-    //         vscode.Uri.file(...),
-    //     )
-    // })
+    figIntegration()
 }
 
 export const activate = async () => {
+    migrateSettings()
+
     const possiblyActivateTsPlugin = async () => {
         const tsExtension = vscode.extensions.getExtension('vscode.typescript-language-features')
         if (!tsExtension) return

src/extension.ts

@@ -0,0 +1,59 @@
+import * as vscode from 'vscode'
+import { defaultJsSupersetLangs } from '@zardoy/vscode-utils/build/langs'
+import { getExtensionSetting } from 'vscode-framework'
+import { watchExtensionSettings } from '@zardoy/vscode-utils/build/settings'
+
+let integrationActivated = false
+const possiblyActivateFigIntegration = async () => {
+    if (integrationActivated) return
+    // eslint-disable-next-line sonarjs/no-duplicate-string
+    if (getExtensionSetting('figIntegration.enableWhenStartsWith').length === 0) return
+    integrationActivated = true
+
+    // todo I think would be good to support zx package $ but not sure if needed
+    const figExtension = vscode.extensions.getExtension('undefined_publisher.fig-unreleased')
+    if (!figExtension) return
+    const api = await figExtension.activate()
+
+    api.registerLanguageSupport(
+        // why include react langs? becuase of ink package!
+        defaultJsSupersetLangs,
+        {
+            async provideSingleLineRangeFromPosition(doc: vscode.TextDocument, position: vscode.Position) {
+                const enableWhenStartsWith = getExtensionSetting('figIntegration.enableWhenStartsWith')
+                if (enableWhenStartsWith.length === 0) return
+
+                const path: any[] = await vscode.commands.executeCommand('tsEssentialPlugins.getNodePath', {
+                    offset: doc.offsetAt(position.translate(0, -1)),
+                })
+                if (!path) return
+                const lastTwoPaths = path.slice(-2)
+                const kinds = lastTwoPaths.map(({ kindName }) => kindName)
+                if (kinds[0] !== 'CallExpression' || !['StringLiteral', 'FirstTemplateToken'].includes(kinds[1])) return
+                // todo use info from ts server isntead
+                const callExpr = lastTwoPaths[0]
+                const stringNode = lastTwoPaths[1]
+                const callExpressionText = doc.getText(new vscode.Range(doc.positionAt(callExpr.start), doc.positionAt(callExpr.end)))
+                if (enableWhenStartsWith.every(str => !callExpressionText.startsWith(str))) return
+                return new vscode.Range(doc.positionAt((stringNode.start as number) + 1), doc.positionAt(stringNode.end - 1))
+            },
+        },
+        {
+            // don't collide with TS rename provider
+            disableProviders: ['rename'],
+            enableCompletionProvider: {
+                processCompletions(completions) {
+                    // make it above vscode snippets, maybe should make it builtin?
+                    return completions.map(({ sortText = '', ...compl }) => ({ ...compl, sortText: `!${sortText}` }))
+                },
+            },
+        },
+    )
+}
+
+export default () => {
+    void possiblyActivateFigIntegration()
+    watchExtensionSettings(['figIntegration.enableWhenStartsWith'], () => {
+        void possiblyActivateFigIntegration()
+    })
+}

src/figIntegration.ts

@@ -0,0 +1,23 @@
+import { migrateExtensionSettings } from '@zardoy/vscode-utils/build/migrateSettings'
+
+export default () => {
+    void migrateExtensionSettings(
+        [
+            {
+                rename: {
+                    old: 'jsxEmmet',
+                    new: 'jsxEmmet.enable',
+                    mustBePrimitive: true,
+                },
+            },
+            {
+                rename: {
+                    old: 'jsxPseudoEmmet',
+                    new: 'jsxPseudoEmmet.enable',
+                    mustBePrimitive: true,
+                },
+            },
+        ],
+        process.env.IDS_PREFIX!,
+    )
+}