Add tests for module jsdoc parsing

[ST-DDT]

Clear and concise description of the problem

Currently we only have tests covering the signatures.

Suggested solution

Add a test setup for modules as well.

• Deprecated and non-deprecated
• Containing references to fakerjs.dev and next.fakerjs.dev

Alternative

None

Additional context

Split from #1929

[ST-DDT]

Blocked by #2024

[ST-DDT]

This is no longer blocked. In fact we already have a base setup from #2101, we should probably extend it with more cases like @deprecated.

[xDivisionByZerox]

Deprecated and non-deprecated

We do not log any messages when a module is deprecated. All of them are instantiated when a Faker instance is created which would lead to misleading logs.
How would you test this? What is the expected behavior to test?

[ST-DDT]

This is not about the module behavior being tested, but our jsdocs tooling.

[xDivisionByZerox]

So this is about the test\scripts\apidoc\module.spec.ts file, not test\scripts\apidoc\verify-jsdoc-tags.spec.ts?

I was looking at the following test. But guess I looked at the wrong place:

faker/test/scripts/apidoc/verify-jsdoc-tags.spec.ts

Lines 154 to 174 in ee12c32

	it('verify @deprecated tag', async () => {
	// Grab path to example file
	const path = resolvePathToMethodFile(moduleName, methodName);
	const consoleWarnSpy = vi.spyOn(console, 'warn');
	// Run the examples
	await import(`${path}?scope=deprecated`);
	// Verify that deprecated methods log a warning
	const deprecatedFlag = extractDeprecated(signature) !== undefined;
	if (deprecatedFlag) {
	expect(consoleWarnSpy).toHaveBeenCalled();
	expect(
	extractTagContent('@deprecated', signature).join(''),
	'@deprecated tag without message'
	).not.toBe('');
	} else {
	expect(consoleWarnSpy).not.toHaveBeenCalled();
	}
	});

[ST-DDT]

Will be added in #2412

• test: add more module jsdoc tests #2412