feat: return the loading promise when registering an extension

Author: Loïc Mangeonjean

package-lock.json

@@ -75,6 +75,7 @@
     "jschardet": "^3.0.0",
     "package-json": "^8.1.1",
     "param-case": "^3.0.4",
+    "pascal-case": "^3.1.2",
     "patch-package": "^8.0.0",
     "recast": "^0.23.4",
     "rollup": "^3.29.1",

package.json

@@ -2,6 +2,7 @@ import nodeResolve from '@rollup/plugin-node-resolve'
 import * as rollup from 'rollup'
 import { importMetaAssets } from '@web/rollup-plugin-import-meta-assets'
 import { PackageJson } from 'type-fest'
+import { pascalCase } from 'pascal-case'
 import * as fs from 'fs'
 import * as fsPromise from 'fs/promises'
 import * as path from 'path'
@@ -121,6 +122,7 @@ export default rollup.defineConfig([
             description: `Default VSCode extension designed to be used with ${pkg.name}`,
             main: entrypoint,
             module: entrypoint,
+            types: 'index.d.ts',
             dependencies: {
               vscode: `npm:${pkg.name}@^${pkg.version}`,
               ...Object.fromEntries(Object.entries(pkg.dependencies).filter(([key]) => dependencies.has(key)))
@@ -133,6 +135,13 @@ export default rollup.defineConfig([
             source: JSON.stringify(packageJson, null, 2),
             type: 'asset'
           })
+
+          this.emitFile({
+            fileName: 'index.d.ts',
+            needsCodeReference: false,
+            source: 'declare const whenReady: () => Promise<void>\nexport { whenReady }',
+            type: 'asset'
+          })
         }
       })
     ]
@@ -165,7 +174,10 @@ export default rollup.defineConfig([
       },
       load () {
         return `
-${extensions.map(name => `import '@codingame/monaco-vscode-${name}-default-extension'`).join('\n')}
+${extensions.map(name => `import { whenReady as whenReady${pascalCase(name)} } from '@codingame/monaco-vscode-${name}-default-extension'`).join('\n')}
+const whenReady = Promise.all(
+${extensions.map(name => `  whenReady${pascalCase(name)}()`).join(',\n')}
+)
         `
       }
     },
@@ -179,6 +191,7 @@ ${extensions.map(name => `import '@codingame/monaco-vscode-${name}-default-exten
           description: `Meta package including default VSCode extensions designed to be used with ${pkg.name}`,
           main: entrypoint,
           module: entrypoint,
+          types: 'index.d.ts',
           dependencies: Object.fromEntries(Array.from(dependencies).map(name => [
             name,
             pkg.version
@@ -191,6 +204,13 @@ ${extensions.map(name => `import '@codingame/monaco-vscode-${name}-default-exten
           source: JSON.stringify(packageJson, null, 2),
           type: 'asset'
         })
+
+        this.emitFile({
+          fileName: 'index.d.ts',
+          needsCodeReference: false,
+          source: 'declare const whenReady: () => Promise<void>\nexport { whenReady }',
+          type: 'asset'
+        })
       }
     })]
   }))])

rollup/rollup.default-extensions.ts

@@ -36,6 +36,7 @@ interface RegisterRemoteExtensionParams extends RegisterExtensionParams {
 interface RegisterExtensionResult {
   id: string
   dispose (): Promise<void>
+  whenReady(): Promise<void>
 }
 
 interface RegisterRemoteExtensionResult extends RegisterExtensionResult {
@@ -126,6 +127,9 @@ export function registerExtension (manifest: IExtensionManifest, extHostKind?: E
 
   let api: RegisterExtensionResult = {
     id,
+    async whenReady () {
+      await addExtensionPromise
+    },
     async dispose () {
       const extension = await addExtensionPromise
       await deltaExtensions([], [extension])

src/extensions.ts

@@ -77,7 +77,7 @@ export default function plugin ({
 import manifest from '${manifestPath}'
 import { registerExtension } from 'vscode/extensions'
 
-const { registerFileUrl } = registerExtension(manifest)
+const { registerFileUrl, whenReady } = registerExtension(manifest)
 ${resources.map(resource => {
   const lines: string[] = [
     generateFileRegistrationInstruction(resource.path, path.resolve(id, resource.realPath ?? resource.path), resource.mimeType)
@@ -88,7 +88,9 @@ ${resources.map(resource => {
 
   return lines.join('\n')
 }).join('\n')}
-        `
+
+export { whenReady }
+`
         } catch (err) {
           console.error(err, (err as Error).stack)
           throw err

src/rollup-extension-directory-plugin.ts

@@ -129,10 +129,12 @@ import { registerExtension } from 'vscode/extensions'
 
 const manifest = ${JSON.stringify(transformManifest(packageJson))}
 
-const { registerFileUrl } = registerExtension(manifest)
+const { registerFileUrl, whenReady } = registerExtension(manifest)
 
 ${pathMapping.map(({ pathInExtension, url, mimeType }) => (`
 registerFileUrl('${pathInExtension}', ${url}${mimeType != null ? `, '${mimeType}'` : ''})`)).join('\n')}
+
+export { whenReady }
 `
     }
   }