index.ts

export * from './compat';
export * from './file-import';
export * from './types';

const combineQueries = (variants: string[], methods: string[]): string[] => {
	const combinedQueries: string[] = [];
	variants.forEach((variant) => {
		const variantPrefix = variant.replace('By', '');
		methods.forEach((method) => {
			combinedQueries.push(`${variantPrefix}${method}`);
		});
	});

	return combinedQueries;
};

const getDocsUrl = (ruleName: string): string =>
	`https://github.com/testing-library/eslint-plugin-testing-library/tree/main/docs/rules/${ruleName}.md`;

const LIBRARY_MODULES = [
	'@testing-library/dom',
	'@testing-library/angular',
	'@testing-library/react',
	'@testing-library/preact',
	'@testing-library/vue',
	'@testing-library/svelte',
	'@marko/testing-library',
];

const SYNC_QUERIES_VARIANTS = ['getBy', 'getAllBy', 'queryBy', 'queryAllBy'];
const ASYNC_QUERIES_VARIANTS = ['findBy', 'findAllBy'];
const ALL_QUERIES_VARIANTS = [
	...SYNC_QUERIES_VARIANTS,
	...ASYNC_QUERIES_VARIANTS,
];

const ALL_QUERIES_METHODS = [
	'ByLabelText',
	'ByPlaceholderText',
	'ByText',
	'ByAltText',
	'ByTitle',
	'ByDisplayValue',
	'ByRole',
	'ByTestId',
	'ByA11yState',
];

const SYNC_QUERIES_COMBINATIONS = combineQueries(
	SYNC_QUERIES_VARIANTS,
	ALL_QUERIES_METHODS
);

const ASYNC_QUERIES_COMBINATIONS = combineQueries(
	ASYNC_QUERIES_VARIANTS,
	ALL_QUERIES_METHODS
);

const ALL_QUERIES_COMBINATIONS = [
	...SYNC_QUERIES_COMBINATIONS,
	...ASYNC_QUERIES_COMBINATIONS,
];

const ASYNC_UTILS = ['waitFor', 'waitForElementToBeRemoved'] as const;

const DEBUG_UTILS = [
	'debug',
	'logTestingPlaygroundURL',
	'prettyDOM',
	'logRoles',
	'logDOM',
	'prettyFormat',
] as const;

const EVENTS_SIMULATORS = ['fireEvent', 'userEvent'] as const;

const TESTING_FRAMEWORK_SETUP_HOOKS = ['beforeEach', 'beforeAll'];

const PROPERTIES_RETURNING_NODES = [
	'activeElement',
	'children',
	'childElementCount',
	'firstChild',
	'firstElementChild',
	'fullscreenElement',
	'lastChild',
	'lastElementChild',
	'nextElementSibling',
	'nextSibling',
	'parentElement',
	'parentNode',
	'pointerLockElement',
	'previousElementSibling',
	'previousSibling',
	'rootNode',
	'scripts',
];

const METHODS_RETURNING_NODES = [
	'closest',
	'getElementById',
	'getElementsByClassName',
	'getElementsByName',
	'getElementsByTagName',
	'getElementsByTagNameNS',
	'querySelector',
	'querySelectorAll',
];

const ALL_RETURNING_NODES = [
	...PROPERTIES_RETURNING_NODES,
	...METHODS_RETURNING_NODES,
];

const PRESENCE_MATCHERS = [
	'toBeOnTheScreen',
	'toBeInTheDocument',
	'toBeTruthy',
	'toBeDefined',
];
const ABSENCE_MATCHERS = ['toBeNull', 'toBeFalsy'];

export {
	combineQueries,
	getDocsUrl,
	SYNC_QUERIES_VARIANTS,
	ASYNC_QUERIES_VARIANTS,
	ALL_QUERIES_VARIANTS,
	ALL_QUERIES_METHODS,
	SYNC_QUERIES_COMBINATIONS,
	ASYNC_QUERIES_COMBINATIONS,
	ALL_QUERIES_COMBINATIONS,
	ASYNC_UTILS,
	DEBUG_UTILS,
	EVENTS_SIMULATORS,
	TESTING_FRAMEWORK_SETUP_HOOKS,
	LIBRARY_MODULES,
	PROPERTIES_RETURNING_NODES,
	METHODS_RETURNING_NODES,
	ALL_RETURNING_NODES,
	PRESENCE_MATCHERS,
	ABSENCE_MATCHERS,
};