Auto include hello world mentions (#200)

Update the hello world example to auto-include mentions and consume active editor uri in example
sourcegraph · Sep 3, 2024 · b2f1b82 · b2f1b82
1 parent 50490a4
commit b2f1b82
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 5 deletions.
diff --git a/lib/protocol/src/openctx-protocol.schema.json b/lib/protocol/src/openctx-protocol.schema.json
@@ -172,7 +172,7 @@
               "type": "string"
             },
             "autoInclude": {
-              "description": "Whether to automatically include the returned mention items as initial context for new messages.",
+              "description": "EXPERIMENTAL: Whether to automatically include the returned mention items as initial context for new messages.",
               "type": "boolean"
             }
           }

diff --git a/lib/protocol/src/openctx-protocol.schema.ts b/lib/protocol/src/openctx-protocol.schema.ts
@@ -66,7 +66,7 @@ export interface MetaResult {
          */
         label?: string
         /**
-         * Whether to automatically include the returned mention items as initial context for new messages.
+         * EXPERIMENTAL: Whether to automatically include the returned mention items as initial context for new messages.
          */
         autoInclude?: boolean
     }

diff --git a/provider/hello-world/index.test.ts b/provider/hello-world/index.test.ts
@@ -8,6 +8,7 @@ describe('helloWorld', () => {
             name: '✨ Hello World!',
             annotations: {},
             items: { messageSelectors: [{ pattern: '.*' }] },
+            mentions: { autoInclude: true },
         }))
 
     test('annotations', () =>

diff --git a/provider/hello-world/index.ts b/provider/hello-world/index.ts
@@ -21,6 +21,9 @@ const helloWorld: Provider = {
         return {
             name: '✨ Hello World!',
             annotations: {},
+            mentions: {
+                autoInclude: true,
+            },
             items: {
                 messageSelectors: [{ pattern: '.*' }],
             },
@@ -30,7 +33,7 @@ const helloWorld: Provider = {
     mentions(params: MentionsParams, settings: ProviderSettings): MentionsResult {
         return [
             {
-                title: '✨ Hello, world!',
+                title: `hello_world.${params.uri?.split('/').pop() || 'openctx'}`,
                 uri: 'https://openctx.org',
                 description: 'From OpenCtx',
             },

diff --git a/provider/hello-world/package.json b/provider/hello-world/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openctx/provider-hello-world",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "Hello World (OpenCtx provider)",
   "license": "Apache-2.0",
   "homepage": "https://openctx.org/docs/providers/hello-world",

diff --git a/web/content/docs/protocol.mdx b/web/content/docs/protocol.mdx
@@ -68,7 +68,7 @@ interface MetaResult {
          */
         label?: string
         /**
-         * Whether to automatically include the returned mention items as initial context for new messages.
+         * EXPERIMENTAL: Whether to automatically include the returned mention items as initial context for new messages.
          */
         autoInclude?: string
     }