Skip to content

refactor(cli): replace the three isPlainObject copies with the shared isRecord guard #431

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

Merged
theCodeDrift merged 1 commit into from
Sep 30, 2026
Merged

refactor(cli): replace the three isPlainObject copies with the shared isRecord guard #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions packages/cli/src/filesystem/manifest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { join } from "node:path";

import { CLIError } from "../util/cli-error";
import { buildInvocation } from "../util/invocation";
import { isRecord } from "../util/is-record";

/**
* The `.taskless/taskless.json` manifest: its shape, and reading and writing it.
Expand Down Expand Up @@ -149,7 +150,7 @@ export async function readRawManifest(
// manifest. Reading `.version` off `null` would throw a bare TypeError, and
// treating it as version 0 has the same consequence as an unparseable file:
// the next write replaces whatever is there.
if (!isPlainObject(parsed)) {
if (!isRecord(parsed)) {
throw unreadableManifest(path, "its top-level value is not a JSON object");
}

Expand Down Expand Up @@ -189,8 +190,8 @@ export async function readManifest(
return {
manifest: {
version,
install: isPlainObject(install) ? install : undefined,
rules: isPlainObject(rules) ? rules : undefined,
install: isRecord(install) ? install : undefined,
rules: isRecord(rules) ? rules : undefined,
},
raw,
};
Expand Down Expand Up @@ -219,7 +220,3 @@ export async function writeManifest(
}
await writeRawManifest(directory, merged);
}

function isPlainObject(value: unknown): value is Record<string, unknown> {
return typeof value === "object" && value !== null && !Array.isArray(value);
}
9 changes: 3 additions & 6 deletions packages/cli/src/filesystem/migrations/0002-install.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,10 @@ import { readFile, writeFile } from "node:fs/promises";
import { join } from "node:path";

import type { Migration } from "../types";
import { isRecord } from "../../util/is-record";

const MANIFEST_FILE = "taskless.json";

function isPlainObject(value: unknown): value is Record<string, unknown> {
return typeof value === "object" && value !== null && !Array.isArray(value);
}

/**
* Migration 2 — seed an empty `install` object in taskless.json.
*
Expand All @@ -21,14 +18,14 @@ const migration: Migration = async (directory) => {
try {
const content = await readFile(manifestPath, "utf8");
const parsed = JSON.parse(content) as unknown;
if (isPlainObject(parsed)) {
if (isRecord(parsed)) {
raw = parsed;
}
} catch {
// Missing or unparseable — fall through and write a minimal manifest
}

if (!isPlainObject(raw.install)) {
if (!isRecord(raw.install)) {
raw.install = {};
await writeFile(manifestPath, JSON.stringify(raw, null, 2) + "\n", "utf8");
}
Expand Down
9 changes: 3 additions & 6 deletions packages/cli/src/filesystem/migrations/0003-drop-installed-at.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,10 @@ import { readFile, writeFile } from "node:fs/promises";
import { join } from "node:path";

import type { Migration } from "../types";
import { isRecord } from "../../util/is-record";

const MANIFEST_FILE = "taskless.json";

function isPlainObject(value: unknown): value is Record<string, unknown> {
return typeof value === "object" && value !== null && !Array.isArray(value);
}

/**
* Migration 3 — drop the unused `install.installedAt` timestamp.
*
Expand All @@ -22,7 +19,7 @@ const migration: Migration = async (directory) => {
try {
const content = await readFile(manifestPath, "utf8");
const parsed = JSON.parse(content) as unknown;
if (isPlainObject(parsed)) {
if (isRecord(parsed)) {
raw = parsed;
}
} catch {
Expand All @@ -31,7 +28,7 @@ const migration: Migration = async (directory) => {
}

const install = raw.install;
if (isPlainObject(install) && "installedAt" in install) {
if (isRecord(install) && "installedAt" in install) {
delete install.installedAt;
await writeFile(manifestPath, JSON.stringify(raw, null, 2) + "\n", "utf8");
}
Expand Down
Loading