Non-relative reference in typesVersions parent

[jablko]

Scenario 1

Currently, if you import * as promises from "fs/promises" in types/fs/ts3.2/index.d.ts (non-relative self-reference in a typesVersions directory),

• baseDirectory is ts3.2
• subDirectory is .
• convertToRelativeReference() returns ./promises (the subDirectory === "." case), which would be types/fs/ts3.2/promises.d.ts ✔️
  

  types-publisher/src/lib/module-info.ts

  Lines 257 to 261 in 54bd71c

  	/** boring/foo -> ./foo when subDirectory === '.'; ../foo when it's === 'x'; ../../foo when it's 'x/y' */
  	function convertToRelativeReference(name: string) {
  	const relative = "." + "/..".repeat(subDirectory === "." ? 0 : subDirectory.split("/").length);
  	return relative + name.slice(packageName.length);
  	}

Scenario 2

However files in typesVersions directories are allowed to reference files in the parent directory, so if you import * as promises from "fs/promises" in types/fs/index.d.ts and /// <reference path="../index.d.ts" /> in types/fs/ts3.2/index.d.ts (non-relative self-reference in a typesVersions parent directory),

• baseDirectory is still ts3.2
• subDirectory is ..
• convertToRelativeReference() returns ../promises (the subDirectory.split("/").length case), which would be types/promises.d.ts or something ❌

That triggers

Error: ../index.d.ts: Definitions must use global references to other packages, not parent ("../xxx") references.(Based on reference './../promises')

types-publisher/src/lib/module-info.ts

Lines 237 to 251 in 54bd71c

	function addReference(ref: Reference): void {
	// `path.normalize` may add windows slashes
	const full = normalizeSlashes(path.normalize(joinPaths(subDirectory, assertNoWindowsSlashes(src.fileName, ref.text))));
	// allow files in typesVersions directories (i.e. 'ts3.1') to reference files in parent directory
	if (full.startsWith("../" + packageName + "/")) {
	ref.text = full.slice(packageName.length + 4);
	refs.push(ref);
	return;
	}
	if (full.startsWith("..")
	&& (baseDirectory === "" || path.normalize(joinPaths(baseDirectory, full)).startsWith(".."))) {
	throw new Error(
	`${src.fileName}: ` +
	'Definitions must use global references to other packages, not parent ("../xxx") references.' +
	`(Based on reference '${ref.text}')`);

Proposed Change

If we're in a typesVersions parent directory (baseDirectory && subDirectory.startsWith("..")) this change adds the baseDirectory to the relative reference, so in scenario 2, convertToRelativeReference() returns ./ts3.2/promises, which would be types/fs/ts3.2/promises.d.ts, the same as in scenario 1 ✔️

[sandersn]

This looks like a good idea, and I think the code is correct, but can you add a test? Additionally, the repo is now at microsoft/DefinitelyTyped-tools/packages/definitions-parser

In the DefinitelyTyped-tools repo, the tests are in DefinitelyTyped-tools/packages/definitions-parser/test/module-info.test.ts. I think the best approach is to test allReferencedFiles same as the other tests, then add a project that uses typesVersions to createMockDT in definitions-parser/src/mocks.ts.