Sanitize command names and descriptions (#17228)

This commit is contained in:
Emily Hedlund
2026-01-22 11:41:51 -05:00
committed by GitHub
parent 048c30513e
commit d956c5b221
6 changed files with 134 additions and 7 deletions

View File

@@ -1337,4 +1337,69 @@ describe('FileCommandLoader', () => {
consoleErrorSpy.mockRestore();
});
});
describe('Sanitization', () => {
it('sanitizes command names from filenames containing control characters', async () => {
const userCommandsDir = Storage.getUserCommandsDir();
mock({
[userCommandsDir]: {
'test\twith\nnewlines.toml': 'prompt = "Test prompt"',
},
});
const loader = new FileCommandLoader(null);
const commands = await loader.loadCommands(signal);
expect(commands).toHaveLength(1);
// Non-alphanumeric characters (except - and .) become underscores
expect(commands[0].name).toBe('test_with_newlines');
});
it('truncates excessively long filenames', async () => {
const userCommandsDir = Storage.getUserCommandsDir();
const longName = 'a'.repeat(60) + '.toml';
mock({
[userCommandsDir]: {
[longName]: 'prompt = "Test prompt"',
},
});
const loader = new FileCommandLoader(null);
const commands = await loader.loadCommands(signal);
expect(commands).toHaveLength(1);
expect(commands[0].name.length).toBe(50);
expect(commands[0].name).toBe('a'.repeat(47) + '...');
});
it('sanitizes descriptions containing newlines and ANSI codes', async () => {
const userCommandsDir = Storage.getUserCommandsDir();
mock({
[userCommandsDir]: {
'test.toml':
'prompt = "Test"\ndescription = "Line 1\\nLine 2\\tTabbed\\r\\n\\u001B[31mRed text\\u001B[0m"',
},
});
const loader = new FileCommandLoader(null);
const commands = await loader.loadCommands(signal);
expect(commands).toHaveLength(1);
// Newlines and tabs become spaces, ANSI is stripped
expect(commands[0].description).toBe('Line 1 Line 2 Tabbed Red text');
});
it('truncates long descriptions', async () => {
const userCommandsDir = Storage.getUserCommandsDir();
const longDesc = 'd'.repeat(150);
mock({
[userCommandsDir]: {
'test.toml': `prompt = "Test"\ndescription = "${longDesc}"`,
},
});
const loader = new FileCommandLoader(null);
const commands = await loader.loadCommands(signal);
expect(commands).toHaveLength(1);
expect(commands[0].description.length).toBe(100);
expect(commands[0].description).toBe('d'.repeat(97) + '...');
});
});
});

View File

@@ -33,6 +33,7 @@ import {
ShellProcessor,
} from './prompt-processors/shellProcessor.js';
import { AtFileProcessor } from './prompt-processors/atFileProcessor.js';
import { sanitizeForListDisplay } from '../ui/utils/textUtils.js';
interface CommandDirectory {
path: string;
@@ -230,15 +231,25 @@ export class FileCommandLoader implements ICommandLoader {
);
const baseCommandName = relativePath
.split(path.sep)
// Sanitize each path segment to prevent ambiguity. Since ':' is our
// namespace separator, we replace any literal colons in filenames
// with underscores to avoid naming conflicts.
.map((segment) => segment.replaceAll(':', '_'))
// Sanitize each path segment to prevent ambiguity, replacing non-allowlisted characters with underscores.
// Since ':' is our namespace separator, this ensures that colons do not cause naming conflicts.
.map((segment) => {
let sanitized = segment.replace(/[^a-zA-Z0-9_\-.]/g, '_');
// Truncate excessively long segments to prevent UI overflow
if (sanitized.length > 50) {
sanitized = sanitized.substring(0, 47) + '...';
}
return sanitized;
})
.join(':');
// Add extension name tag for extension commands
const defaultDescription = `Custom command from ${path.basename(filePath)}`;
let description = validDef.description || defaultDescription;
description = sanitizeForListDisplay(description, 100);
if (extensionName) {
description = `[${extensionName}] ${description}`;
}