Skip to content

Fix: Behaviour of print-config option with relative file path #816

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

Merged
sindresorhus merged 1 commit into from
Jun 23, 2025
+19 −1
Merged

Fix: Behaviour of print-config option with relative file path #816

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 cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,9 @@ if (typeof cliOptions.printConfig === 'string') {
process.exit(1);
}

const config = await new Xo(linterOptions, baseXoConfigOptions).calculateConfigForFile(cliOptions.printConfig);
const absoluteFilePath = path.resolve(cliOptions.cwd, cliOptions.printConfig);

const config = await new Xo(linterOptions, baseXoConfigOptions).calculateConfigForFile(absoluteFilePath);
console.log(JSON.stringify(config, undefined, '\t'));
} else {
const xo = new Xo(linterOptions, baseXoConfigOptions);
Expand Down
16 changes: 16 additions & 0 deletions test/cli.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,22 @@ test('xo --print-config ts', async t => {
t.true('rules' in config);
});

test('xo --print-config relative path', async t => {
const fileName = 'test.ts';
const filePath = path.join(t.context.cwd, fileName);
await fs.writeFile(filePath, dedent`console.log('hello');\n`, 'utf8');
const {stdout} = await $`node ./dist/cli --cwd ${t.context.cwd} --print-config=${fileName}`;
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const config = JSON.parse(stdout);
t.true(typeof config === 'object');
t.true('rules' in config);
});

test('xo --print-config no path', async t => {
const {stderr}: ExecaError = await t.throwsAsync($`node ./dist/cli --cwd ${t.context.cwd} --print-config`);
t.is('The `--print-config` flag must be used with exactly one filename', stderr?.toString() ?? '');
});

test('xo --ignore', async t => {
const testFile = path.join(t.context.cwd, 'test.js');
const ignoredFile = path.join(t.context.cwd, 'ignored.js');
Expand Down