Skip to content

fix(rule-tester): allow custom filename outside directory #10147

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
merged 1 commit into from
Oct 21, 2024
Merged

fix(rule-tester): allow custom filename outside directory #10147

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
10 changes: 9 additions & 1 deletion packages/rule-tester/src/RuleTester.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -746,7 +746,15 @@ export class RuleTester extends TestFramework {
...configWithoutCustomKeys.linterOptions,
},
});
messages = this.#linter.verify(code, actualConfig, filename);
messages = this.#linter.verify(
code,
// ESLint uses an internal FlatConfigArray that extends @humanwhocodes/config-array.
Object.assign([], {
basePath: filename ? path.parse(filename).root : '',
getConfig: () => actualConfig,
}),
filename,
);
} finally {
SourceCode.prototype.applyInlineConfig = applyInlineConfig;
SourceCode.prototype.applyLanguageOptions = applyLanguageOptions;
Expand Down
48 changes: 48 additions & 0 deletions packages/rule-tester/tests/filename.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/* eslint-disable perfectionist/sort-objects */
import { RuleTester } from '@typescript-eslint/rule-tester';
import { ESLintUtils } from '@typescript-eslint/utils';

const ruleTester = new RuleTester();

const rule = ESLintUtils.RuleCreator.withoutDocs({
meta: {
docs: {
description: 'some description',
},
messages: {
foo: 'It works',
},
schema: [],
type: 'problem',
},
defaultOptions: [],
create: context => ({
Program(node): void {
context.report({ node, messageId: 'foo' });
},
}),
});

describe('rule tester filename', () => {
ruleTester.run('absolute path', rule, {
invalid: [
{
code: '_',
errors: [{ messageId: 'foo' }],
filename: '/an-absolute-path/foo.js',
},
],
valid: [],
});

ruleTester.run('relative path', rule, {
invalid: [
{
code: '_',
errors: [{ messageId: 'foo' }],
filename: '../foo.js',
},
],
valid: [],
});
});
Loading