Skip to content

fix: search in open editors for files with square brackets in names #270625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+26 −2
Open

fix: search in open editors for files with square brackets in names #270625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e518fe
fix: search in open editors for files with square brackets in names
bryanchen-d Oct 9, 2025
4b893e2
remove unnecessary blanks
bryanchen-d Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/vs/workbench/services/search/common/queryBuilder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,11 +313,11 @@ export class QueryBuilder {
}

const relPath = path.relative(searchRoot.fsPath, file.fsPath);
assertReturnsDefined(folderQuery.includePattern)[relPath.replace(/\\/g, '/')] = true;
assertReturnsDefined(folderQuery.includePattern)[escapeGlobPattern(relPath.replace(/\\/g, '/'))] = true;
} else {
if (file.fsPath) {
hasIncludedFile = true;
includePattern[file.fsPath] = true;
includePattern[escapeGlobPattern(file.fsPath)] = true;
}
}
});
Expand Down
24 changes: 24 additions & 0 deletions src/vs/workbench/services/search/test/common/queryBuilder.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import assert from 'assert';
import * as glob from '../../../../../base/common/glob.js';
import { isWindows } from '../../../../../base/common/platform.js';
import { URI } from '../../../../../base/common/uri.js';
import { ensureNoDisposablesAreLeakedInTestSuite } from '../../../../../base/test/common/utils.js';
Expand All @@ -29,4 +30,27 @@ suite('QueryBuilderCommon', () => {
const actual = resolveResourcesForSearchIncludes([URI.file(isWindows ? "C:\\testWorkspace\\pages\\blog\\[postId]" : "/testWorkspace/pages/blog/[postId]")], context);
assert.deepStrictEqual(actual, ["./pages/blog/[[]postId[]]"]);
});

test('escapeGlobPattern properly escapes square brackets for literal matching', () => {
// This test verifies the fix for issue #233049 where files with square brackets in names
// were not found when using "Search Only in Open Editors"

// Test file name with square brackets
const fileName = 'file[test].txt';

// Function matching the one used in queryBuilder.ts
function escapeGlobPattern(path: string): string {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But then this isn't testing the real function right?

return path.replace(/([?*[\]])/g, '[$1]');
}

// Without escaping, the pattern treats [test] as a character class
const unescapedResult = glob.match(fileName, fileName);
assert.strictEqual(unescapedResult, false, 'Unescaped pattern should not match due to character class interpretation');

// With escaping, the pattern matches literally
const escapedPattern = escapeGlobPattern(fileName);
const escapedResult = glob.match(escapedPattern, fileName);
assert.strictEqual(escapedResult, true, 'Escaped pattern should match literally');
assert.strictEqual(escapedPattern, 'file[[]test[]].txt', 'Pattern should have escaped brackets');
});
});
Loading