rixty/SillyTavern
1
0
Fork 0
mirror of https://github.com/SillyTavern/SillyTavern.git synced 2025-06-05 21:59:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve macro argument parsing to allow colons in values

Browse Source 
Enhances separator handling by fixing separator type detection and enabling colon characters within argument values
Updates validation to require at least one argument component and adds error cases for empty arguments
Includes expanded test coverage for mixed separator scenarios and edge cases
This commit is contained in:
Wolfsblvt
2025-03-20 02:25:07 +01:00
parent efa367541a
commit f9d4deb583
2 changed files with 66 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
public/scripts/macros/MacroParser.js
View File

@@ -35,25 +35,23 @@ class MacroParser extends CstParser {
// Arguments Parsing
$.arguments = $.RULE('arguments', () => {
// Remember the separator being used, it needs to stay consistent
/** @type {import('../../lib/chevrotain.js').IToken} */
let separator;
$.OR([
{ ALT: () => separator = $.CONSUME(Tokens.Args.DoubleColon, { LABEL: 'separator' }) },
{ ALT: () => separator = $.CONSUME(Tokens.Args.Colon, { LABEL: 'separator' }) },
{ ALT: () => $.CONSUME(Tokens.Args.DoubleColon, { LABEL: 'separator' }) },
{ ALT: () => $.CONSUME(Tokens.Args.Colon, { LABEL: 'separator' }) },
]);
$.AT_LEAST_ONE_SEP({
SEP: separator.tokenType,
SEP: Tokens.Args.DoubleColon,
DEF: () => $.SUBRULE($.argument),
});
});
$.argument = $.RULE('argument', () => {
$.MANY(() => {
$.AT_LEAST_ONE(() => {
$.OR([
{ ALT: () => $.SUBRULE($.macro) }, // Nested Macros
{ ALT: () => $.CONSUME(Tokens.Identifier) },
{ ALT: () => $.CONSUME(Tokens.Unknown) },
{ ALT: () => $.CONSUME(Tokens.Args.Colon) },
]);
});
});

67
tests/frontend/MacroParser.test.js
View File

@@ -41,7 +41,7 @@ describe('MacroParser', () => {
expect(macroCst).toEqual(expectedCst);
});
describe('Error Cases (General Macro', () => {
describe('Error Cases (General Macro)', () => {
// {{}}
it('[Error] should throw an error for empty macro', async () => {
const input = '{{}}';
@@ -51,8 +51,8 @@ describe('MacroParser', () => {
{ name: 'MismatchedTokenException', message: 'Expecting token of type --> Macro.Identifier <-- but found --> \'}}\' <--' },
];
expect(errors).toEqual(expectedErrors);
expect(macroCst).toBeUndefined();
expect(errors).toEqual(expectedErrors);
});
// {{§!#&blah}}
it('[Error] should throw an error for invalid identifier', async () => {
@@ -63,8 +63,8 @@ describe('MacroParser', () => {
{ name: 'MismatchedTokenException', message: 'Expecting token of type --> Macro.Identifier <-- but found --> \'!\' <--' },
];
expect(errors).toEqual(expectedErrors);
expect(macroCst).toBeUndefined();
expect(errors).toEqual(expectedErrors);
});
// {{user
it('[Error] should throw an error for incomplete macro', async () => {
@@ -75,13 +75,14 @@ describe('MacroParser', () => {
{ name: 'MismatchedTokenException', message: 'Expecting token of type --> Macro.End <-- but found --> \'\' <--' },
];
expect(errors).toEqual(expectedErrors);
expect(macroCst).toBeUndefined();
expect(errors).toEqual(expectedErrors);
});
});
});
describe('Arguments Handling', () => {
// {{getvar::myvar}}
it('should parse macros with double-colon argument', async () => {
const input = '{{getvar::myvar}}';
const macroCst = await runParser(input, {
@@ -98,7 +99,8 @@ describe('MacroParser', () => {
});
});
it('should parse macros with single colon arguments', async () => {
// {{roll:3d20}}
it('should parse macros with single colon argument', async () => {
const input = '{{roll:3d20}}';
const macroCst = await runParser(input, {
flattenKeys: ['arguments.argument'],
@@ -114,7 +116,8 @@ describe('MacroParser', () => {
});
});
it('should parse macros with double-colon arguments', async () => {
// {{setvar::myvar::value}}
it('should parse macros with multiple double-colon arguments', async () => {
const input = '{{setvar::myvar::value}}';
const macroCst = await runParser(input, {
flattenKeys: ['arguments.argument'],
@@ -131,6 +134,7 @@ describe('MacroParser', () => {
});
});
// {{something:: spaced }}
it('should strip spaces around arguments', async () => {
const input = '{{something:: spaced }}';
const macroCst = await runParser(input, {
@@ -144,6 +148,57 @@ describe('MacroParser', () => {
'Macro.End': '}}',
});
});
// {{something::with:single:colons}}
it('should treat single colons as part of the argument with double-colon separator', async () => {
const input = '{{something::with:single:colons}}';
const macroCst = await runParser(input, {
flattenKeys: ['arguments.argument'],
ignoreKeys: ['arguments.Args.DoubleColon'],
});
expect(macroCst).toEqual({
'Macro.Start': '{{',
'Macro.Identifier': 'something',
'arguments': {
'separator': '::',
'argument': 'with:single:colons',
},
'Macro.End': '}}',
});
});
// {{legacy:something:else}}
it('should treat single colons as part of the argument even with colon separator', async () => {
const input = '{{legacy:something:else}}';
const macroCst = await runParser(input, {
flattenKeys: ['arguments.argument'],
ignoreKeys: ['arguments.separator', 'arguments.Args.Colon'],
});
expect(macroCst).toEqual({
'Macro.Start': '{{',
'Macro.Identifier': 'legacy',
'arguments': { 'argument': 'something:else' },
'Macro.End': '}}',
});
});
describe('Error Cases (Arguments Handling)', () => {
// {{something::}}
it('[Error] should throw an error for double-colon without a value', async () => {
const input = '{{something::}}';
const { macroCst, errors } = await runParserAndGetErrors(input);
const expectedErrors = [
{
name: 'EarlyExitException', message: expect.stringMatching(/^Expecting: expecting at least one iteration which starts with one of these possible Token sequences:/),
},
];
expect(macroCst).toBeUndefined();
expect(errors).toEqual(expectedErrors);
});
});
});
describe('Nested Macros', () => {