Skip to content

[Repo Assist] fix: align configSearch file priority with PHP_CodeSniffer's auto-detection order #137

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

Draft
github-actions wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[Repo Assist] fix: align configSearch file priority with PHP_CodeSniffer's auto-detection order #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 1 deletion extension.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,10 @@ class PHPCBF {
const workspaceRoot = folder ? folder.uri.fsPath : null;
const filePath = document.fileName;
if (this.configSearch && workspaceRoot !== null && filePath !== undefined) {
// Priority matches PHP_CodeSniffer's own auto-detection order:
// https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/src/Config.php
const confFileNames = [
'.phpcs.xml', '.phpcs.xml.dist', 'phpcs.xml', 'phpcs.xml.dist',
'.phpcs.xml', 'phpcs.xml', '.phpcs.xml.dist', 'phpcs.xml.dist',
'phpcs.ruleset.xml', 'ruleset.xml',
];

Expand Down
35 changes: 35 additions & 0 deletions test/unit.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,39 @@ describe("findFiles", () => {
const result = findFiles(path.join(tmpRoot, "single"), ".", "phpcs.xml");
assert.equal(result, expected);
});

// Verify that the PHPCS auto-detection priority is respected:
// .phpcs.xml > phpcs.xml > .phpcs.xml.dist > phpcs.xml.dist
test("PHPCS priority: .phpcs.xml beats phpcs.xml when both exist", () => {
const expected = mkFile("priority1", "src", ".phpcs.xml");
mkFile("priority1", "src", "phpcs.xml");
const result = findFiles(
path.join(tmpRoot, "priority1"),
"src",
[".phpcs.xml", "phpcs.xml", ".phpcs.xml.dist", "phpcs.xml.dist"]
);
assert.equal(result, expected);
});

test("PHPCS priority: phpcs.xml beats .phpcs.xml.dist when both exist", () => {
const expected = mkFile("priority2", "src", "phpcs.xml");
mkFile("priority2", "src", ".phpcs.xml.dist");
const result = findFiles(
path.join(tmpRoot, "priority2"),
"src",
[".phpcs.xml", "phpcs.xml", ".phpcs.xml.dist", "phpcs.xml.dist"]
);
assert.equal(result, expected);
});

test("PHPCS priority: .phpcs.xml.dist beats phpcs.xml.dist when both exist", () => {
const expected = mkFile("priority3", "src", ".phpcs.xml.dist");
mkFile("priority3", "src", "phpcs.xml.dist");
const result = findFiles(
path.join(tmpRoot, "priority3"),
"src",
[".phpcs.xml", "phpcs.xml", ".phpcs.xml.dist", "phpcs.xml.dist"]
);
assert.equal(result, expected);
});
});