Merge pull request #146 from VSC-NeuroPilot/feat/insert_turtle_here

feat: allow setting user's name for collab scenarios

Author: KTrain5169

CHANGELOG.md

@@ -15,6 +15,10 @@ Changes between each version before then will not be listed.
 
 ## 2.2.2
 
+### New settings
+
+- `neuropilot.connection.userName` - Your name, to be used where Vedal would be used in the extension. This will not be logged, but it will be sent to the connected API server, so do be mindful of what you put there.
+
 ### Added features
 
 - If an exception was thrown while executing an action, it will be caught and you will be notified about it.
@@ -27,6 +31,8 @@ Changes between each version before then will not be listed.
 - Neuro can now get cookies by herself, if `neuropilot.permission.requestCookies` is set to `Autopilot`.
   - Perfect for chill streams, assuming of course that she doesn't abuse it.
   - The default for this permission is still set to "Copilot", so you'll still need to set it yourself.
+- Your name, according to the `neuropilot.connection.userName` setting, will be used in areas where it used to say Vedal.
+  - If you want to use your name in the `neuropilot.connection.initialContext` setting, use the `insert_turtle_here` placeholder.
 - Neuro will now be told about all schema validation errors at once, as opposed to only being able to see one validation error at a time.
 
 ### Fixes

package.json

@@ -196,7 +196,7 @@
 					"neuropilot.currentlyAsNeuroAPI": {
 						"type": "string",
 						"markdownDescription": "Who is currently acting as the Neuro API server?\nThis only changes the name in certain areas (such as Copilot-mode requests or Git commit messages) due to limitations.\n\nYou can add custom characters using `settings.json` if you ignore the lint error from VS Code.\n\n(Most) names mentioned here are not associated with NeuroPilot.",
-						"default": "Neuro",
+						"deprecationMessage": "This setting has been moved to neuropilot.connection.nameOfAPI",
 						"enum": [
 							"Neuro",
 							"Evil",
@@ -782,7 +782,7 @@
 					"neuropilot.connection.initialContext": {
 						"type": "string",
 						"default": "You are using an extension in Visual Studio Code that allows you to code together with Vedal.",
-						"description": "The initial context to sent to Neuro-sama (or whatever is connected to NeuroPilot)",
+						"markdownDescription": "The initial context to sent to Neuro-sama (or whatever is connected to NeuroPilot)\n\nTo replace with your name (according to [this setting](vscode://settings/neuropilot.connection.userName)), use `insert_turtle_here`.",
 						"editPresentation": "multilineText"
 					},
 					"neuropilot.connection.autoConnect": {
@@ -802,6 +802,32 @@
 						"minimum": 0,
 						"markdownDescription": "The amount of retries to connect to the Neuro API if it fails.\n\nThe amount of tries total will be (this setting) + 1.\n\nSet to 0 to disallow retries."
 					},
+					"neuropilot.connection.userName": {
+						"type": "string",
+						"default": "Vedal",
+						"description": "Your name (to communicate who is controlling this VS Code instance alongside the API server). This will be used where the name `Vedal` would work for Neuro."
+					},
+					"neuropilot.connection.nameOfAPI": {
+						"type": "string",
+						"markdownDescription": "Who is currently acting as the Neuro API server?\nThis only changes the name in certain areas (such as Copilot-mode requests or Git commit messages) due to limitations.\n\nYou can add custom characters using `settings.json` if you ignore the lint error from VS Code.\n\n(Most) names mentioned here are not associated with NeuroPilot.",
+						"default": "Neuro",
+						"enum": [
+							"Neuro",
+							"Evil",
+							"Randy",
+							"Jippity",
+							"Tony",
+							"Gary"
+						],
+						"enumDescriptions": [
+							"#1 at osu!",
+							"Evil, but actually nice.",
+							"Random Dot Range (Alex)",
+							"A GPT model (EnterpriseScratchDev)",
+							"The human operator (Pasu4)",
+							"Literally in your computer walls (Govorunb)"
+						]
+					},
 					"neuropilot.actions.disabledActions": {
 						"type": "array",
 						"default": [],

src/chat.ts

@@ -2,7 +2,7 @@ import * as vscode from 'vscode';
 
 import { NEURO } from '@/constants';
 import { filterFileContents, logOutput, simpleFileName } from '@/utils';
-import { CONFIG } from '@/config';
+import { CONFIG, CONNECTION } from '@/config';
 import assert from 'node:assert';
 
 interface Participant {
@@ -80,12 +80,12 @@ export function registerChatParticipant() {
         token: vscode.CancellationToken,
     ): Promise<NeuroChatResult> => {
         let prefix = '';
-        const currentAPI = CONFIG.currentlyAsNeuroAPI;
+        const currentAPI = CONNECTION.nameOfAPI;
 
         if (request.command === 'fix') {
-            prefix = 'Vedal wants you to fix the following error(s):\n';
+            prefix = `${CONNECTION.userName} wants you to fix the following error(s):\n`;
         } else if (request.command === 'explain') {
-            prefix = 'Vedal wants you to explain the following:\n';
+            prefix = `${CONNECTION.userName} wants you to explain the following:\n`;
         }
 
         if (!NEURO.connected) {
@@ -99,7 +99,6 @@ export function registerChatParticipant() {
         }
         if (NEURO.waiting) {
             stream.markdown(`Already waiting for a response from ${currentAPI}.`);
-
             stream.button({
                 command: 'neuropilot.reconnect',
                 title: 'Reconnect',
@@ -130,7 +129,7 @@ export function registerChatParticipant() {
                     const text = filterFileContents(document.getText());
                     references.push({
                         fileName: simpleFileName(ref.value.fsPath),
-                        text: text,
+                        text,
                     });
                 });
             } else if (typeof ref.value === 'string') {
@@ -164,11 +163,11 @@ export function registerChatParticipant() {
             chatter.onDidReceiveFeedback((feedback: vscode.ChatResultFeedback) => {
                 if (feedback.kind === vscode.ChatResultFeedbackKind.Helpful) {
                     logOutput('INFO', 'Answer was deemed helpful');
-                    NEURO.client?.sendContext('Vedal found your answer helpful.');
+                    NEURO.client?.sendContext(`${CONNECTION.userName} found your answer helpful.`);
                 } else {
                     logOutput('INFO', 'Answer was deemed unhelpful');
                     logOutput('DEBUG', JSON.stringify(feedback));
-                    NEURO.client?.sendContext('Vedal found your answer unhelpful.');
+                    NEURO.client?.sendContext(`${CONNECTION.userName} found your answer unhelpful.`);
                 }
             }),
         );
@@ -189,7 +188,7 @@ async function requestChatResponse(
         {
             name: 'chat',
             description:
-                'Provide an answer to Vedal\'s request.' +
+                `Provide an answer to ${CONNECTION.userName}'s request.` +
                 ' Use markdown to format your response.' +
                 ' You may additionally include code blocks by using triple backticks.' +
                 ' Be sure to use the correct language identifier after the first set of backticks.' +

src/config.ts

@@ -79,6 +79,10 @@ const DEPRECATED_SETTINGS: DeprecatedSetting[] = [
         old: 'enableCancelRequests',
         new: 'actions.enableCancelRequests',
     },
+    {
+        old: 'currentlyAsNeuroAPI',
+        new: 'connection.nameOfAPI',
+    },
 ];
 
 function getTargetConfig<T>(config: vscode.WorkspaceConfiguration, key: string, target: vscode.ConfigurationTarget) {
@@ -280,7 +284,7 @@ class Permissions {
     get gitConfigs() { return { id: 'gitConfigs', infinitive: 'edit the Git configuration' }; }
     get terminalAccess() { return { id: 'terminalAccess', infinitive: 'access the terminal' }; }
     get accessLintingAnalysis() { return { id: 'accessLintingAnalysis', infinitive: 'view linting problems' }; }
-    get getUserSelection() { return { id: 'getUserSelection', infinitive: 'get Vedal\'s cursor' }; }
+    get getUserSelection() { return { id: 'getUserSelection', infinitive: `get ${CONNECTION.userName}'s cursor` }; }
 }
 
 export const PERMISSIONS = new Permissions();
@@ -297,7 +301,6 @@ class Config {
     get sendSaveNotifications(): boolean { return getConfig('sendSaveNotifications')!; }
     get requestExpiryTimeout(): number { return getConfig('requestExpiryTimeout')!; }
     get cursorFollowsNeuro(): boolean { return getConfig('cursorFollowsNeuro')!; }
-    get currentlyAsNeuroAPI(): string { return getConfig('currentlyAsNeuroAPI')!; }
     get docsURL(): string { return getConfig('docsURL')!; }
     get defaultOpenDocsWindow(): string { return getConfig('defaultOpenDocsWindow')!; }
     get sendContentsOnFileChange(): boolean { return getConfig('sendContentsOnFileChange')!; }
@@ -326,6 +329,8 @@ class Connection {
     get autoConnect(): boolean { return getConnection<boolean>('autoConnect')!; }
     get retryInterval(): number { return getConnection<number>('retryInterval')!; }
     get retryAmount(): number { return getConnection<number>('retryAmount')!; }
+    get userName(): string { return getConnection<string>('userName')!; }
+    get nameOfAPI(): string { return getConnection<string>('nameOfAPI')!; }
 }
 
 export const CONNECTION = new Connection();

src/context.ts

@@ -2,7 +2,7 @@ import * as vscode from 'vscode';
 
 import { getFence, logOutput, notifyOnCaughtException, simpleFileName } from '@/utils';
 import { NEURO } from '@/constants';
-import { PERMISSIONS, PermissionLevel, getPermissionLevel, isActionEnabled } from '@/config';
+import { CONNECTION, PERMISSIONS, PermissionLevel, getPermissionLevel, isActionEnabled } from '@/config';
 
 export function sendCurrentFile() {
     const editor = vscode.window.activeTextEditor;
@@ -24,7 +24,7 @@ export function sendCurrentFile() {
 
     logOutput('INFO', 'Sending current file to Neuro API');
     const fence = getFence(text);
-    NEURO.client?.sendContext(`Vedal sent you the contents of the file ${fileName}.\n\nContent:\n\n${fence}${language}\n${text}\n${fence}`);
+    NEURO.client?.sendContext(`${CONNECTION.userName} sent you the contents of the file ${fileName}.\n\nContent:\n\n${fence}${language}\n${text}\n${fence}`);
 }
 
 export function registerRequestCookieAction() {
@@ -36,7 +36,7 @@ export function registerRequestCookieAction() {
     NEURO.client?.registerActions([
         {
             name: 'request_cookie',
-            description: "Ask Vedal for a cookie. You can request a specific flavor, but it's up to Vedal to decide.",
+            description: `Ask ${CONNECTION.userName} for a cookie. You can request a specific flavor, but it's up to ${CONNECTION.userName} to decide.`,
             schema: {
                 type: 'object',
                 properties: {
@@ -119,11 +119,11 @@ export function giveCookie(isRequested = false, defaultFlavor = 'Chocolate Chip'
         if (!flavor) {
             logOutput('INFO', 'No flavor given, canceling cookie');
             if (isRequested)
-                NEURO.client?.sendContext("Vedal couldn't decide on a flavor for your cookie.");
+                NEURO.client?.sendContext(`${CONNECTION.userName} couldn't decide on a flavor for your cookie.`);
             return;
         }
         logOutput('INFO', 'Giving cookie to Neuro');
-        NEURO.client?.sendContext(`Vedal gave you a ${flavor} cookie!`);
+        NEURO.client?.sendContext(`${CONNECTION.userName} gave you a ${flavor} cookie!`);
     });
 }
 
@@ -136,5 +136,5 @@ export function denyCookie() {
     }
 
     logOutput('INFO', 'Denying cookie to Neuro');
-    NEURO.client?.sendContext('Vedal denied you the cookie.');
+    NEURO.client?.sendContext(`${CONNECTION.userName} denied you the cookie.`);
 }