Skip to content

test(pack): including/excluding changelogs via "files" #19113

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

test(pack): including/excluding changelogs via "files" #19113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a4fad21
test(pack): including/excluding changelogs via `"files"`
DonIsaac Apr 18, 2025
7c71762
fixes
DonIsaac Apr 18, 2025
4c44733
Merge branch 'main' into don/pm/test/excluding-changelogs
DonIsaac Apr 20, 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
18 changes: 17 additions & 1 deletion src/js/internal-for-testing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,23 @@ export const npmTag: (
) => undefined | "npm" | "dist_tag" | "tarball" | "folder" | "symlink" | "workspace" | "git" | "github" =
$newZigFunction("dependency.zig", "Version.Tag.inferFromJS", 1);

export const readTarball: (tarball: string) => any = $newZigFunction("pack_command.zig", "bindings.jsReadTarball", 1);
export const readTarball: (tarball: string) => Tarball = $newZigFunction(
"pack_command.zig",
"bindings.jsReadTarball",
1,
);
interface Tarball {
entries: TarballEntry[];
size: number;
shasum: string;
integrity: string;
}
interface TarballEntry {
pathname: string;
kind: string;
perm: number;
contents: string;
}

export const isArchitectureMatch: (architecture: string[]) => boolean = $newZigFunction(
"npm.zig",
Expand Down
215 changes: 137 additions & 78 deletions test/cli/install/bun-pack.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { file, spawn, write } from "bun";
import { readTarball } from "bun:internal-for-testing";
import { beforeEach, describe, expect, test } from "bun:test";
import { beforeEach, beforeAll, describe, expect, test, it } from "bun:test";
import { exists, mkdir, rm } from "fs/promises";
import { bunEnv, bunExe, runBunInstall, tmpdirSync, pack, tempDirWithFiles } from "harness";
import { join } from "path";
Expand Down Expand Up @@ -909,50 +909,77 @@ describe("bundledDependnecies", () => {
});

describe("files", () => {
test("CHANGELOG is not included by default", async () => {
await Promise.all([
write(
join(packageDir, "package.json"),
JSON.stringify({
name: "pack-files-changelog",
version: "1.1.1",
files: ["lib"],
}),
),
write(join(packageDir, "CHANGELOG.md"), "hello"),
write(join(packageDir, "lib", "index.js"), "console.log('hello ./lib/index.js')"),
]);
describe("CHANGELOG", () => {
test("is not included by default", async () => {
await Promise.all([
write(
join(packageDir, "package.json"),
JSON.stringify({
name: "pack-files-changelog",
version: "1.1.1",
files: ["lib"],
}),
),
write(join(packageDir, "CHANGELOG.md"), "hello"),
write(join(packageDir, "lib", "index.js"), "console.log('hello ./lib/index.js')"),
]);

await pack(packageDir, bunEnv);
const tarball = readTarball(join(packageDir, "pack-files-changelog-1.1.1.tgz"));
expect(tarball.entries).toMatchObject([
{ "pathname": "package/package.json" },
{ "pathname": "package/lib/index.js" },
]);
});
await pack(packageDir, bunEnv);
const tarball = readTarball(join(packageDir, "pack-files-changelog-1.1.1.tgz"));
expect(tarball.entries).toMatchObject([
{ "pathname": "package/package.json" },
{ "pathname": "package/lib/index.js" },
]);
});

test(".npmignore cannot exclude CHANGELOG", async () => {
await Promise.all([
write(
join(packageDir, "package.json"),
JSON.stringify({
name: "pack-files-changelog",
version: "1.1.2",
}),
),
write(join(packageDir, ".npmignore"), "CHANGELOG\nCHANGELOG.*"),
write(join(packageDir, "CHANGELOG"), "hello"),
write(join(packageDir, "CHANGELOG.md"), "hello"),
write(join(packageDir, "CHANGELOG.txt"), "hello"),
]);
await pack(packageDir, bunEnv);
const tarball = readTarball(join(packageDir, "pack-files-changelog-1.1.2.tgz"));
expect(tarball.entries).toMatchObject([
{ "pathname": "package/package.json" },
{ "pathname": "package/CHANGELOG" },
{ "pathname": "package/CHANGELOG.md" },
{ "pathname": "package/CHANGELOG.txt" },
]);
test("cannot be excluded via .npmignore", async () => {
await Promise.all([
write(
join(packageDir, "package.json"),
JSON.stringify({
name: "pack-files-changelog",
version: "1.1.2",
}),
),
write(join(packageDir, ".npmignore"), "CHANGELOG\nCHANGELOG.*"),
write(join(packageDir, "CHANGELOG"), "hello"),
write(join(packageDir, "CHANGELOG.md"), "hello"),
write(join(packageDir, "CHANGELOG.txt"), "hello"),
]);
await pack(packageDir, bunEnv);
const tarball = readTarball(join(packageDir, "pack-files-changelog-1.1.2.tgz"));
expect(tarball.entries).toMatchObject([
{ "pathname": "package/package.json" },
{ "pathname": "package/CHANGELOG" },
{ "pathname": "package/CHANGELOG.md" },
{ "pathname": "package/CHANGELOG.txt" },
]);
});

// https://docs.npmjs.com/cli/v9/configuring-npm/package-json#files
test("can be excluded via package.json files", async () => {
const dir = tempDirWithFiles("bun-pack-files-changelog", {
"package.json": /* json */ `
{
"name": "pack-files-changelog-exclude",
"version": "1.1.1",
"files": ["lib", "!CHANGELOG"]
}
`,
CHANGELOG: "hello",
lib: {
"index.js": "console.log('hello ./lib/index.js')",
},
});

const { out } = await pack(dir, bunEnv);
const tarball = readTarball(join(dir, "pack-files-changelog-exclude-1.1.1.tgz"));
expect(out).toContain("Total files: 2");
expect(tarball.entries).toMatchObject([
{ "pathname": "package/package.json" },
{ "pathname": "package/lib/index.js" },
]);
});
});

test("'files' field cannot exclude LICENSE", async () => {
Expand Down Expand Up @@ -1123,47 +1150,79 @@ describe("files", () => {
});
});

describe("always-ignored files", () => {
let dir: string;
let tarball: any;
beforeAll(async () => {
dir = tempDirWithFiles("bun-pack-exclude-always-ignored", {
"package.json": JSON.stringify({
"name": "always-ignored",
"version": "1.0.0",
}),
"CHANGELOG": `some stuff changed`,
"README.md": `# README`,
src: {
"index.js": /* js */ `console.log('hello ./src/index.js')`,
".DS_Store": "",
".foo.swp": "",
".git": "",
".svn": "",
"CVS": "",
},
});

await pack(dir, bunEnv);
tarball = readTarball(join(dir, "always-ignored-1.0.0.tgz"));
});

it.each([".DS_Store", ".foo.swp", ".git", ".svn"])("%s is always ignored", file => {
expect(tarball.entries).not.toContainEqual(expect.objectContaining({ pathname: `package/src/${file}` }));
});

it.each(["CHANGELOG", "README.md"])("%s is not ignored by default", file => {
expect(tarball.entries).toContainEqual(expect.objectContaining({ pathname: `package/${file}` }));
});
});

describe(".gitignore/.npmignore", () => {
for (const ignoreFile of [".gitignore", ".npmignore"]) {
test(`can ignore and un-ignore a file (${ignoreFile})`, async () => {
await Promise.all([
write(
join(packageDir, "package.json"),
JSON.stringify({
name: "pack-ignore-1",
version: "0.0.0",
}),
),
write(join(packageDir, "index.js"), "console.log('hello ./index.js')"),
write(join(packageDir, ignoreFile), "index.js"),
]);
test.each([".gitignore .npmignore"])("can ignore and un-ignore a file (%s)", async ignoreFile => {
await Promise.all([
write(
join(packageDir, "package.json"),
JSON.stringify({
name: "pack-ignore-1",
version: "0.0.0",
}),
),
write(join(packageDir, "index.js"), "console.log('hello ./index.js')"),
write(join(packageDir, ignoreFile), "index.js"),
]);

await pack(packageDir, bunEnv);
const tarball = readTarball(join(packageDir, "pack-ignore-1-0.0.0.tgz"));
expect(tarball.entries).toMatchObject([{ "pathname": "package/package.json" }]);
await pack(packageDir, bunEnv);
const tarball = readTarball(join(packageDir, "pack-ignore-1-0.0.0.tgz"));
expect(tarball.entries).toMatchObject([{ "pathname": "package/package.json" }]);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test is failing, but it might be a bug in toMatchObject?


await Promise.all([
rm(join(packageDir, "pack-ignore-1-0.0.0.tgz")),
write(join(packageDir, ignoreFile), "index.js\n!index.js"),
]);
await Promise.all([
rm(join(packageDir, "pack-ignore-1-0.0.0.tgz")),
write(join(packageDir, ignoreFile), "index.js\n!index.js"),
]);

await pack(packageDir, bunEnv);
const tarball2 = readTarball(join(packageDir, "pack-ignore-1-0.0.0.tgz"));
expect(tarball2.entries).toMatchObject([
{ "pathname": "package/package.json" },
{ "pathname": "package/index.js" },
]);
await pack(packageDir, bunEnv);
const tarball2 = readTarball(join(packageDir, "pack-ignore-1-0.0.0.tgz"));
expect(tarball2.entries).toMatchObject([
{ "pathname": "package/package.json" },
{ "pathname": "package/index.js" },
]);

await Promise.all([
rm(join(packageDir, "pack-ignore-1-0.0.0.tgz")),
write(join(packageDir, ignoreFile), "!index.js\nindex.js"),
]);
await Promise.all([
rm(join(packageDir, "pack-ignore-1-0.0.0.tgz")),
write(join(packageDir, ignoreFile), "!index.js\nindex.js"),
]);

await pack(packageDir, bunEnv);
const tarball3 = readTarball(join(packageDir, "pack-ignore-1-0.0.0.tgz"));
expect(tarball3.entries).toMatchObject([{ "pathname": "package/package.json" }]);
});
}
await pack(packageDir, bunEnv);
const tarball3 = readTarball(join(packageDir, "pack-ignore-1-0.0.0.tgz"));
expect(tarball3.entries).toMatchObject([{ "pathname": "package/package.json" }]);
});

test("excludes files recursively", async () => {
await Promise.all([
Expand Down