docs: add docs and schema for "OS" provider (#1536)

continuedev · Jun 21, 2024 · 2ed4ff6 · 2ed4ff6
1 parent b402b91
commit 2ed4ff6
Show file tree

Hide file tree

Showing 4 changed files with 139 additions and 396 deletions.
diff --git a/core/context/providers/OSContextProvider.ts b/core/context/providers/OSContextProvider.ts
@@ -1,6 +1,3 @@
-//os.platform()
-//os.arch()
-
 import os from "os";
 import {
   ContextItem,
@@ -11,9 +8,9 @@ import { BaseContextProvider } from "../index.js";
 
 class OSContextProvider extends BaseContextProvider {
   static description: ContextProviderDescription = {
-    title: "OS",
-    displayTitle: "OS",
-    description: "OS and CPU Information.",
+    title: "os",
+    displayTitle: "Operating System",
+    description: "Operating system and CPU Information.",
     type: "normal",
   };
 
@@ -25,9 +22,9 @@ class OSContextProvider extends BaseContextProvider {
     const platform = os.platform();
     return [
       {
-        description: "Your OS and CPU",
+        description: "Your operating system and CPU",
         content: `I am running ${platform} on ${cpu}.`,
-        name: "OS",
+        name: "os",
       },
     ];
   }

diff --git a/docs/docs/customization/context-providers.md b/docs/docs/customization/context-providers.md
@@ -288,6 +288,14 @@ Type `@locals` to reference the contents of the local variables with top n level
 }
 ```
 
+### Operating System
+
+Type `@os` to reference the architecture and platform of your current operating system.
+
+```json
+{ "name": "os" }
+```
+
 ### Requesting Context Providers
 
 Not seeing what you want? Create an issue [here](https://github.com/continuedev/continue/issues/new?assignees=TyDunn&labels=enhancement&projects=&template=feature-request-%F0%9F%92%AA.md&title=) to request a new ContextProvider.

diff --git a/extensions/vscode/config_schema.json b/extensions/vscode/config_schema.json
@@ -1318,7 +1318,8 @@
                 "code",
                 "currentFile",
                 "url",
-                "database"
+                "database",
+                "os"
               ],
               "markdownEnumDescriptions": [
                 "Reference the contents of the current changes as given by `git diff`",
@@ -1340,7 +1341,8 @@
                 "Reference specific functions and classes from throughout your codebase",
                 "Reference the contents of the currently active file",
                 "Reference the contents of a page at a URL",
-                "Reference table schemas"
+                "Reference table schemas",
+                "Operating system and CPU Information"
               ],
               "type": "string"
             },