Merge pull request #3292 from SillyTavern/macrosparser

40d29bd4536565a041cc6514392ef416f0457b9b

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

Signed

public/scripts/macros.js+30 -1 Viewed

  * @typedef {(nonce: string) => string} MacroFunction
  */
 +/**
 + * @typedef {Object} CustomMacro
 + * @property {string} key - Macro name (key)
 + * @property {string} description - Optional description of the macro
 + */
++
 export class MacrosParser {
     /**
      * A map of registered macros.

     static #macros = new Map();
     /**
 +     * A map of macro descriptions.
 +     * @type {Map<string, string>}
 +     */
 +    static #descriptions = new Map();
++
 +    /**
 +     * Returns an iterator over all registered macros.
 +     * @returns {IterableIterator<CustomMacro>}
 +     */
 +    static [Symbol.iterator] = function* () {
 +        for (const macro of MacrosParser.#macros.keys()) {
 +            yield { key: macro, description: MacrosParser.#descriptions.get(macro) };
 +        }
 +    };
++
 +    /**
      * Registers a global macro that can be used anywhere where substitution is allowed.
      * @param {string} key Macro name (key)
      * @param {string|MacroFunction} value A string or a function that returns a string
 +     * @param {string} [description] Optional description of the macro
      */
     static registerMacro(key, value, description = '') {
         if (typeof key !== 'string') {
             throw new Error('Macro key must be a string');
+        }

@@ -64,6 +87,10 @@ export class MacrosParser {
64	87	}
65	88
66	89	this.#macros.set(key, value);
	90	+
	91	+ if (typeof description === 'string' && description) {
	92	+ this.#descriptions.set(key, description);
	93	+ }
67	94	}
68	95
69	96	/**

@@ -88,6 +115,8 @@ export class MacrosParser {
88	115	if (!deleted) {
89	116	console.warn(`Macro ${key} was not registered`);
90	117	}
	118	+
	119	+ this.#descriptions.delete(key);
91	120	}
92	121
93	122	/**

public/scripts/slash-commands/SlashCommandParser.js+6 -0 Viewed

 import { SlashCommandDebugController } from './SlashCommandDebugController.js';
 import { commonEnumProviders } from './SlashCommandCommonEnumsProvider.js';
 import { SlashCommandBreak } from './SlashCommandBreak.js';
 +import { MacrosParser } from '../macros.js';
 +import { t } from '../i18n.js';
 /** @typedef {import('./SlashCommand.js').NamedArgumentsCapture} NamedArgumentsCapture */
 /** @typedef {import('./SlashCommand.js').NamedArguments} NamedArguments */

                     li.querySelector('tt').textContent,
                     (li.querySelector('tt').remove(),li.innerHTML),
                 ));
 +                for (const macro of MacrosParser) {
 +                    if (options.find(it => it.name === macro.key)) continue;
 +                    options.push(new MacroAutoCompleteOption(macro.key, `{{${macro.key}}}`, macro.description || t`No description provided`));
 +                }
                 const result = new AutoCompleteNameResult(
                     macro.name,
                     macro.start + 2,