Add ability to omit settings from Connection Profiles

0646a47b810fa595ff7fc928f1b755fec487e42c

Cohee <18619528+Cohee1207@users.noreply.github.com>

4 files changed, +99 -12Showing whitespace changes
public/scripts/extensions/connection-manager/edit.html+16 -0
@@ -0,0 +1,16 @@
1+<div>
2+ <h3>Included settings:</h3>
3+ <div class="justifyLeft flex-container flexFlowColumn flexNoGap">
4+ {{#each settings}}
5+ <label class="checkbox_label">
6+ {{#if this}}
7+ <input type="checkbox" value="{{@key}}" name="exclude" checked>
8+ {{else}}
9+ <input type="checkbox" value="{{@key}}" name="exclude">
10+ {{/if}}
11+ <span>{{@key}}</span>
12+ </label>
13+ {{/each}}
14+ </div>
15+ <h3>Profile name:</h3>
16+</div>
public/scripts/extensions/connection-manager/index.js+72 -8
@@ -135,6 +135,7 @@ const profilesProvider = () => [
135135 * @property {string} [context] Context Template
136136 * @property {string} [instruct-state] Instruct Mode
137137 * @property {string} [tokenizer] Tokenizer
138+ * @property {string[]} [exclude] Commands to exclude
138139 */
139140
140141/**
@@ -171,8 +172,13 @@ function findProfileByName(value) {
171172async function readProfileFromCommands(mode, profile, cleanUp = false) {
172173 const commands = mode === 'cc' ? CC_COMMANDS : TC_COMMANDS;
173174 const opposingCommands = mode === 'cc' ? TC_COMMANDS : CC_COMMANDS;
175+ const excludeList = Array.isArray(profile.exclude) ? profile.exclude : [];
174176 for (const command of commands) {
175177 try {
178+ if (excludeList.includes(command)) {
179+ continue;
180+ }
181+
176182 const args = getNamedArguments();
177183 const result = await SlashCommandParser.commands[command].callback(args, '');
178184 if (result) {
@@ -208,15 +214,36 @@ async function readProfileFromCommands(mode, profile, cleanUp = false) {
208214async function createConnectionProfile(forceName = null) {
209215 const mode = main_api === 'openai' ? 'cc' : 'tc';
210216 const id = uuidv4();
217+ /** @type {ConnectionProfile} */
211218 const profile = {
212219 id,
213220 mode,
221+ exclude: [],
214222 };
215223
216224 await readProfileFromCommands(mode, profile);
217225
218226 const profileForDisplay = makeFancyProfile(profile);
219227 const template = $(await renderExtensionTemplateAsync(MODULE_NAME, 'profile', { profile: profileForDisplay }));
228+ template.find('input[name="exclude"]').on('input', function () {
229+ const fancyName = String($(this).val());
230+ const keyName = Object.entries(FANCY_NAMES).find(x => x[1] === fancyName)?.[0];
231+ if (!keyName) {
232+ console.warn('Key not found for fancy name:', fancyName);
233+ return;
234+ }
235+
236+ if (!Array.isArray(profile.exclude)) {
237+ profile.exclude = [];
238+ }
239+
240+ const excludeState = !$(this).prop('checked');
241+ if (excludeState) {
242+ profile.exclude.push(keyName);
243+ } else {
244+ profile.exclude.splice(profile.exclude.indexOf(keyName), 1);
245+ }
246+ });
220247 const isNameTaken = (n) => extension_settings.connectionManager.profiles.some(p => p.name === n);
221248 const suggestedName = getUniqueName(collapseSpaces(`${profile.api ?? ''} ${profile.model ?? ''} - ${profile.preset ?? ''}`), isNameTaken);
222249 const name = forceName ?? await callGenericPopup(template, POPUP_TYPE.INPUT, suggestedName, { rows: 2 });
@@ -230,7 +257,13 @@ async function createConnectionProfile(forceName = null) {
230257 return null;
231258 }
232259
233- profile.name = name;
260+ if (Array.isArray(profile.exclude)) {
261+ for (const command of profile.exclude) {
262+ delete profile[command];
263+ }
264+ }
265+
266+ profile.name = String(name);
234267 return profile;
235268}
236269
@@ -357,6 +390,9 @@ async function renderDetailsContent(detailsContent) {
357390 const profile = extension_settings.connectionManager.profiles.find(p => p.id === selectedProfile);
358391 if (profile) {
359392 const profileForDisplay = makeFancyProfile(profile);
393+ if (Array.isArray(profile.exclude) && profile.exclude.length > 0) {
394+ profileForDisplay['Omitted Settings'] = profile.exclude.map(e => FANCY_NAMES[e]).join(', ');
395+ }
360396 const template = await renderExtensionTemplateAsync(MODULE_NAME, 'view', { profile: profileForDisplay });
361397 detailsContent.innerHTML = template;
362398 } else {
@@ -472,8 +508,8 @@ async function renderDetailsContent(detailsContent) {
472508 await eventSource.emit(event_types.CONNECTION_PROFILE_LOADED, NONE);
473509 });
474510
475511 const renameButtoneditButton = document.getElementById('rename_connection_profileedit_connection_profile');
476512 renameButtoneditButton.addEventListener('click', async () => {
477513 const selectedProfile = extension_settings.connectionManager.selectedProfile;
478514 const profile = extension_settings.connectionManager.profiles.find(p => p.id === selectedProfile);
479515 if (!profile) {
@@ -481,20 +517,48 @@ async function renderDetailsContent(detailsContent) {
481517 return;
482518 }
483519
484- const newName = await Popup.show.input('Enter a new name', null, profile.name, { rows: 2 });
520+ if (!Array.isArray(profile.exclude)) {
521+ profile.exclude = [];
522+ }
523+
524+ const commands = profile.mode === 'cc' ? CC_COMMANDS : TC_COMMANDS;
525+ const settings = commands.reduce((acc, command) => {
526+ const fancyName = FANCY_NAMES[command];
527+ acc[fancyName] = !profile.exclude.includes(command);
528+ return acc;
529+ }, {});
530+ const template = $(await renderExtensionTemplateAsync(MODULE_NAME, 'edit', { name: profile.name, settings }));
531+ const newName = await callGenericPopup(template, POPUP_TYPE.INPUT, profile.name);
532+
485533 if (!newName) {
486534 return;
487535 }
488536
489537 if (profile.name !== newName && extension_settings.connectionManager.profiles.some(p => p.name === newName)) {
490538 toastr.error('A profile with the same name already exists.');
491539 return;
492540 }
493541
494- profile.name = newName;
542+ const newExcludeList = template.find('input[name="exclude"]:not(:checked)').map(function () {
543+ return Object.entries(FANCY_NAMES).find(x => x[1] === String($(this).val()))?.[0];
544+ }).get();
545+
546+ if (newExcludeList.length !== profile.exclude.length || !newExcludeList.every(e => profile.exclude.includes(e))) {
547+ profile.exclude = newExcludeList;
548+ for (const command of newExcludeList) {
549+ delete profile[command];
550+ }
551+ toastr.info('Press "Update" to record them into the profile.', 'Included settings list updated');
552+ }
553+
554+ if (profile.name !== newName) {
555+ toastr.success('Connection profile renamed.');
556+ profile.name = String(newName);
557+ }
558+
495559 saveSettingsDebounced();
496560 renderConnectionProfiles(profiles);
497- toastr.success('Connection profile renamed', '', { timeOut: 1500 });
561+ await renderDetailsContent(detailsContent);
498562 });
499563
500564 /** @type {HTMLElement} */
public/scripts/extensions/connection-manager/profile.html+10 -3
@@ -2,11 +2,18 @@
22 <h2 data-i18n="Creating a Connection Profile">
33 Creating a Connection Profile
44 </h2>
55 <uldiv class="justifyLeft flex-container flexFlowColumn flexNoGap">
66 {{#each profile}}
7- <li><strong data-i18n="{{@key}}">{{@key}}:</strong>&nbsp;{{this}}</li>
7+ <label class="checkbox_label">
8+ <input type="checkbox" value="{{@key}}" name="exclude" checked>
9+ <span><strong data-i18n="{{@key}}">{{@key}}:</strong>&nbsp;{{this}}</span>
10+ </label>
811 {{/each}}
912 </uldiv>
13+ <small>
14+ <b>Hint:</b>
15+ <i>Click on the setting name to omit it from the profile.</i>
16+ </small>
1017 <h3 data-i18n="Enter a name:">
1118 Enter a name:
1219 </h3>
public/scripts/extensions/connection-manager/settings.html+1 -1
@@ -13,7 +13,7 @@
1313 <i id="view_connection_profile" class="menu_button fa-solid fa-info-circle" title="View connection profile details" data-i18n="[title]View connection profile details"></i>
1414 <i id="create_connection_profile" class="menu_button fa-solid fa-file-circle-plus" title="Create a new connection profile" data-i18n="[title]Create a new connection profile"></i>
1515 <i id="update_connection_profile" class="menu_button fa-solid fa-save" title="Update a connection profile" data-i18n="[title]Update a connection profile"></i>
1616 <i id="rename_connection_profileedit_connection_profile" class="menu_button fa-solid fa-pencil" title="RenameEdit a connection profile" data-i18n="[title]RenameEdit a connection profile"></i>
1717 <i id="reload_connection_profile" class="menu_button fa-solid fa-recycle" title="Reload a connection profile" data-i18n="[title]Reload a connection profile"></i>
1818 <i id="delete_connection_profile" class="menu_button fa-solid fa-trash-can" title="Delete a connection profile" data-i18n="[title]Delete a connection profile"></i>
1919 </div>