create-monolayer-app 0.6.1 → 0.6.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-monolayer-app",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "CLI to scaffold a new monolayer application",
   "keywords": [
     "create-app",

package/template/README.md

@@ -44,6 +44,16 @@ npm run build
 
 ## Deployment
 
+### Application Source Archive
+
+Create the source archive with this command:
+
+```bash
+npm run package-app
+```
+
+The packager writes a `.tar.gz` archive into `build/`. It excludes macOS metadata: `._*` files, `.DS_Store` files, and `__MACOSX` directories. These exclusions also apply with custom exclusion settings. The packager disables macOS metadata generation in `tar`.
+
 ### Docker Deployment
 
 To build and run using Docker:

package/template/vendor/package-app/package-app.mjs

@@ -64,7 +64,13 @@ export function packageApp(options = {}) {
   const gitignoreFile = options.gitignorePath ?? DEFAULT_GITIGNORE;
   const excludes = options.excludes ?? DEFAULT_EXCLUDES;
 
-  const tarArgs = ["-czf", relativePath];
+  const tarArgs = [
+    "-czf",
+    relativePath,
+    "--exclude=._*",
+    "--exclude=__MACOSX",
+    "--exclude=.DS_Store",
+  ];
 
   const fullGitignorePath = path.resolve(cwd, gitignoreFile);
   if (existsSync(fullGitignorePath)) {
@@ -79,6 +85,7 @@ export function packageApp(options = {}) {
 
   const result = spawnSync("tar", tarArgs, {
     cwd,
+    env: { ...process.env, COPYFILE_DISABLE: "1" },
     stdio: "inherit",
   });
 

package/template/vendor/package-app/package-app.test.mjs

@@ -0,0 +1,167 @@
+import { execFileSync, spawnSync } from "node:child_process";
+import {
+  existsSync,
+  mkdirSync,
+  mkdtempSync,
+  readdirSync,
+  rmSync,
+  writeFileSync,
+} from "node:fs";
+import { tmpdir } from "node:os";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { afterEach, beforeEach, describe, expect, it } from "vitest";
+
+import { packageApp } from "./package-app.mjs";
+
+const migrationPath = "lib/db/migrations/1792314123321_add-tasks.ts";
+const migration =
+  "export async function up(db) { await db.schema.createTable('tasks').execute(); }";
+const metadata = Buffer.from([0, 5, 22, 7, 0, 2, 0, 0]);
+const packager = fileURLToPath(new URL("package-app.mjs", import.meta.url));
+
+const writeFiles = (root, files) => {
+  for (const [name, content] of Object.entries(files)) {
+    const destination = path.join(root, name);
+    mkdirSync(path.dirname(destination), { recursive: true });
+    writeFileSync(destination, content);
+  }
+};
+
+const archivePaths = (archive) => {
+  const args = ["-tzf", archive];
+  if (process.platform === "darwin") {
+    // macOS tar otherwise hides AppleDouble entries during archive inspection.
+    args.unshift("--options=!mac-ext");
+  }
+  return execFileSync("tar", args, { encoding: "utf-8" }).trim().split("\n");
+};
+
+const metadataPaths = (paths) =>
+  paths.filter((name) =>
+    name
+      .split("/")
+      .some(
+        (part) =>
+          part.startsWith("._") || part === "__MACOSX" || part === ".DS_Store"
+      )
+  );
+
+describe("application source packaging", () => {
+  let fixture;
+  let application;
+
+  beforeEach(() => {
+    fixture = mkdtempSync(path.join(tmpdir(), "application-packager-"));
+    application = path.join(fixture, "app");
+    writeFiles(application, {
+      "package.json": '{"name":"packaging-fixture"}',
+      ".gitignore": "ignored.txt\n",
+      "ignored.txt": "ignored by Git",
+      "private.txt": "excluded by the caller",
+      ".config/kysely.config.ts": "export default {};",
+      [migrationPath]: migration,
+      "lib/db/migrations/._1792314123321_add-tasks.ts": metadata,
+      "._package.json": metadata,
+      ".DS_Store": metadata,
+      "lib/.DS_Store": metadata,
+      "__MACOSX/._package.json": metadata,
+      "lib/__MACOSX/metadata": metadata,
+    });
+  });
+
+  afterEach(() => {
+    rmSync(fixture, { force: true, recursive: true });
+  });
+
+  it.each([
+    ["default exclusions", {}],
+    ["custom exclusions", { excludes: ["build", "private.txt"] }],
+  ])(
+    "excludes metadata with %s and preserves migration source",
+    (_name, options) => {
+      const archive = packageApp({ ...options, cwd: application });
+      const paths = archivePaths(archive.absolutePath);
+
+      expect(metadataPaths(paths)).toStrictEqual([]);
+      expect(paths).toContain(`./${migrationPath}`);
+      expect(paths).toContain("./.config/kysely.config.ts");
+      expect(paths).not.toContain("./ignored.txt");
+      expect(
+        execFileSync(
+          "tar",
+          ["-xOf", archive.absolutePath, `./${migrationPath}`],
+          {
+            encoding: "utf-8",
+          }
+        )
+      ).toBe(migration);
+    }
+  );
+
+  it("preserves caller exclusions without deleting source metadata", () => {
+    const archive = packageApp({
+      cwd: application,
+      excludes: ["build", "private.txt"],
+    });
+
+    expect(archivePaths(archive.absolutePath)).not.toContain("./private.txt");
+    expect(
+      existsSync(
+        path.join(application, "lib/db/migrations/._1792314123321_add-tasks.ts")
+      )
+    ).toBe(true);
+  });
+
+  it.runIf(process.platform === "darwin")(
+    "does not generate metadata from macOS extended attributes",
+    () => {
+      const source = path.join(fixture, "attributes");
+      writeFiles(source, { [migrationPath]: migration });
+      execFileSync("xattr", [
+        "-w",
+        "com.monolayer.packaging-test",
+        "fixture",
+        path.join(source, migrationPath),
+      ]);
+      const control = path.join(fixture, "control.tar.gz");
+      execFileSync("env", [
+        "-u",
+        "COPYFILE_DISABLE",
+        "tar",
+        "-czf",
+        control,
+        "-C",
+        source,
+        ".",
+      ]);
+
+      const archive = packageApp({ cwd: source });
+
+      expect(metadataPaths(archivePaths(control))).toContain(
+        "./lib/db/migrations/._1792314123321_add-tasks.ts"
+      );
+      expect(metadataPaths(archivePaths(archive.absolutePath))).toStrictEqual(
+        []
+      );
+      expect(archivePaths(archive.absolutePath)).toContain(
+        `./${migrationPath}`
+      );
+    }
+  );
+
+  it("creates a clean archive through the package-app command", () => {
+    const result = spawnSync(process.execPath, [packager], {
+      cwd: application,
+      encoding: "utf-8",
+    });
+    const [name] = readdirSync(path.join(application, "build"));
+
+    expect(result.status).toBe(0);
+    expect(result.stdout).toContain("Successfully packaged application");
+    expect(
+      metadataPaths(archivePaths(path.join(application, "build", name)))
+    ).toStrictEqual([]);
+  });
+});

package/template/vitest.config.ts

@@ -12,7 +12,12 @@ export default defineConfig({
   },
   test: {
     environment: "node",
-    include: ["src/**/*.test.ts", "lib/**/*.test.ts", "app/**/*.test.ts"],
+    include: [
+      "src/**/*.test.ts",
+      "lib/**/*.test.ts",
+      "app/**/*.test.ts",
+      "vendor/package-app/**/*.test.mjs",
+    ],
     coverage: {
       provider: "v8",
       reporter: ["text", "json", "html"],