Skip to content

Include nested package.json files in generated DefinitelyTyped packages #1195

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

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Include nested package.json files in generated DefinitelyTyped packages #1195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
594f023
Initial plan
Copilot Aug 28, 2025
3718105
Initial analysis and plan for including nested package.json files
Copilot Aug 28, 2025
0aceb2c
Include nested package.json files in generated packages
Copilot Aug 28, 2025
b1e1c0f
Update tests and snapshots for nested package.json inclusion
Copilot Aug 28, 2025
37f3a46
Fix function naming and exclude root package.json from getFiles()
Copilot Aug 28, 2025
ab7615f
Remove incorrectly committed package-lock.json (repo uses pnpm)
Copilot Aug 29, 2025
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
6 changes: 3 additions & 3 deletions packages/definitions-parser/src/lib/definition-parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,8 @@ export function getFiles(
const rootDir = dt.subDir("types").subDir(typingsData.subDirectoryPath);

const files: string[] = [];
function addFileIfDeclaration(path: string): void {
if (isDeclarationPath(path)) {
function addFileIfIncluded(path: string): void {
if (isDeclarationPath(path) || path.endsWith('/package.json')) {
files.push(path);
}
}
Expand All @@ -276,7 +276,7 @@ export function getFiles(
const path = rootName ? `${rootName}/${name}` : name;

if (!root.isDirectory(name)) {
addFileIfDeclaration(path);
addFileIfIncluded(path);
return;
}

Expand Down
36 changes: 36 additions & 0 deletions packages/definitions-parser/test/packages.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,42 @@ describe(TypingsData, () => {
expect(data.isNotNeeded()).toBe(false);
});

it("includes nested package.json files in getFiles()", () => {
const dt = createMockDT();
const packageDir = dt.pkgDir("with-nested-package-json");

// Set up main package files
packageDir
.set(
"package.json",
JSON.stringify({
name: "@types/with-nested-package-json",
}),
)
.set("index.d.ts", "declare const x: number;")
.set("tsconfig.json", `{ "files": ["index.d.ts"] }`);

// Add nested package.json files in subdirectories
packageDir.subdir("src").set("package.json", JSON.stringify({ type: "module" }));
packageDir.subdir("src").set("index.d.ts", "export const srcVar: string;");
packageDir.subdir("lib").set("package.json", JSON.stringify({ type: "commonjs" }));
packageDir.subdir("lib").set("index.d.ts", "export const libVar: number;");

const versions = createTypingsVersionRaw("with-nested-package-json", {}, {});
const data = new TypingsData(dt.fs, versions["1.0"], true);

const files = data.getFiles();

// Should include both declaration files and nested package.json files
expect(files).toContain("index.d.ts");
expect(files).toContain("src/index.d.ts");
expect(files).toContain("lib/index.d.ts");
expect(files).toContain("src/package.json");
expect(files).toContain("lib/package.json");
// Should NOT include the root package.json as it's handled specially
expect(files).not.toContain("package.json");
});

describe("desc", () => {
it("returns the name if latest version", () => {
expect(data.desc).toBe("@types/known");
Expand Down
Loading