@tinyrack/devsync 1.0.0 → 1.1.0

package/README.md

@@ -6,7 +6,7 @@ A personal CLI tool for git-backed configuration sync.
 
 ## Features
 
-- Flat sync-focused CLI: `init`, `add`, `set`, `forget`, `push`, `pull`, `cd`
+- Flat sync-focused CLI: `init`, `add`, `set`, `forget`, `list`, `status`, `doctor`, `push`, `pull`, `cd`
 - Git-backed sync repository under `~/.config/devsync/sync`
 - Age-encrypted secret file support
 - Rule-based `normal`, `secret`, and `ignore` modes
@@ -53,6 +53,20 @@ If you want the `devsync` command available from this checkout during developmen
 npm link
 ```
 
+## Release
+
+- CI runs on every push and pull request with `npm run check` on Node.js 24.
+- npm publishing runs automatically when a Git tag matching `v*.*.*` is pushed.
+- The release workflow uses npm Trusted Publishing, so npm access is granted through GitHub Actions OIDC instead of an `NPM_TOKEN` secret.
+- The release workflow fails if the pushed tag does not match `package.json` `version`.
+
+Typical release flow:
+
+```bash
+npm version patch
+git push --follow-tags
+```
+
 ## Storage Layout
 
 - Sync repo: `~/.config/devsync/sync`
@@ -115,6 +129,30 @@ cd ~/mytool && devsync forget ./settings.json
 devsync forget .config/mytool
 ```
 
+### `list`
+
+Show tracked entries, modes, and override rules.
+
+```bash
+devsync list
+```
+
+### `status`
+
+Show planned push and pull changes for the current sync config.
+
+```bash
+devsync status
+```
+
+### `doctor`
+
+Check the sync repository, config, age identity, and tracked local paths.
+
+```bash
+devsync doctor
+```
+
 ### `push`
 
 Mirror local config into the sync repository.

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@tinyrack/devsync",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A personal CLI tool for git-backed configuration sync.",
   "type": "module",
   "license": "MIT",
   "author": "winetree94",
   "repository": {
     "type": "git",
-    "url": "https://git.winetree94.com/winetree94/devsync.git"
+    "url": "git+https://github.com/tinyrack-net/devsync.git"
   },
-  "homepage": "https://git.winetree94.com/winetree94/devsync",
+  "homepage": "https://github.com/tinyrack-net/devsync#readme",
   "bugs": {
-    "url": "https://git.winetree94.com/winetree94/devsync/issues"
+    "url": "https://github.com/tinyrack-net/devsync/issues"
   },
   "publishConfig": {
     "access": "public"
@@ -62,7 +62,10 @@
     "coverage": "vitest run --coverage",
     "check": "npm run typecheck && biome check . && npm run test",
     "check:fix": "biome check --write .",
-    "format": "biome format --write ."
+    "format": "biome format --write .",
+    "release:patch": "npm version patch -m \"chore(release): %s\"",
+    "release:minor": "npm version minor -m \"chore(release): %s\"",
+    "release:major": "npm version major -m \"chore(release): %s\""
   },
   "dependencies": {
     "@oclif/core": "^4.9.0",

package/src/cli/commands/doctor.ts

@@ -0,0 +1,20 @@
+import { Command } from "@oclif/core";
+
+import { formatSyncDoctorResult } from "#app/cli/sync-output.ts";
+import { runSyncDoctor } from "#app/services/doctor.ts";
+import { createSyncContext } from "#app/services/runtime.ts";
+
+export default class SyncDoctor extends Command {
+  public static override summary =
+    "Check sync repository, config, age identity, and tracked local paths";
+
+  public override async run(): Promise<void> {
+    const result = await runSyncDoctor(createSyncContext());
+
+    process.stdout.write(formatSyncDoctorResult(result));
+
+    if (result.hasFailures) {
+      this.exit(1);
+    }
+  }
+}

package/src/cli/commands/index.ts

@@ -1,17 +1,23 @@
 import SyncAdd from "#app/cli/commands/add.ts";
 import SyncCd from "#app/cli/commands/cd.ts";
+import SyncDoctor from "#app/cli/commands/doctor.ts";
 import SyncForget from "#app/cli/commands/forget.ts";
 import SyncInit from "#app/cli/commands/init.ts";
+import SyncList from "#app/cli/commands/list.ts";
 import SyncPull from "#app/cli/commands/pull.ts";
 import SyncPush from "#app/cli/commands/push.ts";
 import SyncSet from "#app/cli/commands/set.ts";
+import SyncStatus from "#app/cli/commands/status.ts";
 
 export const COMMANDS = {
   add: SyncAdd,
   cd: SyncCd,
+  doctor: SyncDoctor,
   forget: SyncForget,
   init: SyncInit,
+  list: SyncList,
   pull: SyncPull,
   push: SyncPush,
+  status: SyncStatus,
   set: SyncSet,
 };

package/src/cli/commands/list.ts

@@ -0,0 +1,17 @@
+import { Command } from "@oclif/core";
+
+import { formatSyncListResult } from "#app/cli/sync-output.ts";
+import { listSyncConfig } from "#app/services/list.ts";
+import { createSyncContext } from "#app/services/runtime.ts";
+
+export default class SyncList extends Command {
+  public static override summary = "Show tracked sync entries and overrides";
+
+  public override async run(): Promise<void> {
+    const output = formatSyncListResult(
+      await listSyncConfig(createSyncContext()),
+    );
+
+    process.stdout.write(output);
+  }
+}

package/src/cli/commands/status.ts

@@ -0,0 +1,18 @@
+import { Command } from "@oclif/core";
+
+import { formatSyncStatusResult } from "#app/cli/sync-output.ts";
+import { createSyncContext } from "#app/services/runtime.ts";
+import { getSyncStatus } from "#app/services/status.ts";
+
+export default class SyncStatus extends Command {
+  public static override summary =
+    "Show planned push and pull changes for the current sync config";
+
+  public override async run(): Promise<void> {
+    const output = formatSyncStatusResult(
+      await getSyncStatus(createSyncContext()),
+    );
+
+    process.stdout.write(output);
+  }
+}

package/src/cli/sync-output.test.ts

@@ -0,0 +1,173 @@
+import { describe, expect, it } from "vitest";
+
+import {
+  formatSyncAddResult,
+  formatSyncDoctorResult,
+  formatSyncForgetResult,
+  formatSyncInitResult,
+  formatSyncListResult,
+  formatSyncPullResult,
+  formatSyncPushResult,
+  formatSyncSetResult,
+  formatSyncStatusResult,
+} from "#app/cli/sync-output.ts";
+
+describe("sync output formatting", () => {
+  it("formats init results for cloned repositories", () => {
+    expect(
+      formatSyncInitResult({
+        alreadyInitialized: false,
+        configPath: "/tmp/sync/config.json",
+        entryCount: 2,
+        generatedIdentity: true,
+        gitAction: "cloned",
+        gitSource: "/tmp/remote",
+        identityFile: "/tmp/xdg/devsync/age/keys.txt",
+        recipientCount: 3,
+        ruleCount: 4,
+        syncDirectory: "/tmp/sync",
+      }),
+    ).toBe(
+      [
+        "Initialized sync directory.",
+        "Sync directory: /tmp/sync",
+        "Config file: /tmp/sync/config.json",
+        "Age identity file: /tmp/xdg/devsync/age/keys.txt",
+        "Git repository: cloned from /tmp/remote",
+        "Age bootstrap: generated a new local identity.",
+        "Summary: 3 recipients, 2 entries, 4 rules.",
+        "",
+      ].join("\n"),
+    );
+  });
+
+  it("formats add, forget, and set results", () => {
+    expect(
+      formatSyncAddResult({
+        alreadyTracked: false,
+        configPath: "/tmp/sync/config.json",
+        kind: "file",
+        localPath: "/tmp/home/.zshrc",
+        mode: "secret",
+        repoPath: ".zshrc",
+        syncDirectory: "/tmp/sync",
+      }),
+    ).toContain("Added sync target.\n");
+    expect(
+      formatSyncForgetResult({
+        configPath: "/tmp/sync/config.json",
+        localPath: "/tmp/home/.zshrc",
+        plainArtifactCount: 1,
+        repoPath: ".zshrc",
+        secretArtifactCount: 2,
+        syncDirectory: "/tmp/sync",
+      }),
+    ).toContain("Removed repo artifacts: 1 plain, 2 secret.\n");
+    expect(
+      formatSyncSetResult({
+        action: "updated",
+        configPath: "/tmp/sync/config.json",
+        entryRepoPath: "bundle",
+        localPath: "/tmp/home/bundle/private.json",
+        mode: "ignore",
+        repoPath: "bundle/private.json",
+        scope: "exact",
+        syncDirectory: "/tmp/sync",
+      }),
+    ).toContain("Scope: exact rule\nAction: updated\n");
+  });
+
+  it("formats push and pull dry-run summaries", () => {
+    expect(
+      formatSyncPushResult({
+        configPath: "/tmp/sync/config.json",
+        deletedArtifactCount: 4,
+        directoryCount: 1,
+        dryRun: true,
+        encryptedFileCount: 2,
+        plainFileCount: 3,
+        symlinkCount: 1,
+        syncDirectory: "/tmp/sync",
+      }),
+    ).toContain("No filesystem changes were made.\n");
+    expect(
+      formatSyncPullResult({
+        configPath: "/tmp/sync/config.json",
+        decryptedFileCount: 2,
+        deletedLocalCount: 5,
+        directoryCount: 1,
+        dryRun: true,
+        plainFileCount: 3,
+        symlinkCount: 1,
+        syncDirectory: "/tmp/sync",
+      }),
+    ).toContain(
+      "local paths would be removed.\nNo filesystem changes were made.\n",
+    );
+  });
+
+  it("formats list, status, and doctor results", () => {
+    expect(
+      formatSyncListResult({
+        configPath: "/tmp/sync/config.json",
+        entries: [
+          {
+            kind: "directory",
+            localPath: "/tmp/home/.config/tool",
+            mode: "normal",
+            name: ".config/tool",
+            overrides: [{ mode: "secret", selector: "token.json" }],
+            repoPath: ".config/tool",
+          },
+        ],
+        recipientCount: 1,
+        ruleCount: 1,
+        syncDirectory: "/tmp/sync",
+      }),
+    ).toContain("override token.json: secret\n");
+    expect(
+      formatSyncStatusResult({
+        configPath: "/tmp/sync/config.json",
+        entryCount: 1,
+        pull: {
+          configPath: "/tmp/sync/config.json",
+          decryptedFileCount: 1,
+          deletedLocalCount: 2,
+          directoryCount: 1,
+          dryRun: true,
+          plainFileCount: 0,
+          preview: ["bundle", "bundle/token.txt"],
+          symlinkCount: 0,
+          syncDirectory: "/tmp/sync",
+        },
+        push: {
+          configPath: "/tmp/sync/config.json",
+          deletedArtifactCount: 1,
+          directoryCount: 1,
+          dryRun: true,
+          encryptedFileCount: 1,
+          plainFileCount: 0,
+          preview: ["bundle", "bundle/token.txt"],
+          symlinkCount: 0,
+          syncDirectory: "/tmp/sync",
+        },
+        recipientCount: 1,
+        ruleCount: 0,
+        syncDirectory: "/tmp/sync",
+      }),
+    ).toContain("Push preview: bundle, bundle/token.txt\n");
+    expect(
+      formatSyncDoctorResult({
+        checks: [
+          { detail: "ok", level: "ok", name: "git" },
+          { detail: "warn", level: "warn", name: "entries" },
+          { detail: "fail", level: "fail", name: "age" },
+        ],
+        configPath: "/tmp/sync/config.json",
+        hasFailures: true,
+        hasWarnings: true,
+        syncDirectory: "/tmp/sync",
+      }),
+    ).toContain("Summary: 1 ok, 1 warnings, 1 failures.\n");
+  });
+});

package/src/cli/sync-output.ts

@@ -1,10 +1,13 @@
 import { ensureTrailingNewline } from "#app/lib/string.ts";
 import type { SyncAddResult } from "#app/services/add.ts";
+import type { SyncDoctorResult } from "#app/services/doctor.ts";
 import type { SyncForgetResult } from "#app/services/forget.ts";
 import type { SyncInitResult } from "#app/services/init.ts";
+import type { SyncListResult } from "#app/services/list.ts";
 import type { SyncPullResult } from "#app/services/pull.ts";
 import type { SyncPushResult } from "#app/services/push.ts";
 import type { SyncSetResult } from "#app/services/set.ts";
+import type { SyncStatusResult } from "#app/services/status.ts";
 
 export const formatSyncInitResult = (result: SyncInitResult) => {
   const lines = [
@@ -127,3 +130,71 @@ export const formatSyncPullResult = (result: SyncPullResult) => {
 
   return ensureTrailingNewline(lines.join("\n"));
 };
+
+export const formatSyncListResult = (result: SyncListResult) => {
+  const lines = [
+    "Tracked sync configuration.",
+    `Sync directory: ${result.syncDirectory}`,
+    `Config file: ${result.configPath}`,
+    `Summary: ${result.recipientCount} recipients, ${result.entries.length} entries, ${result.ruleCount} rules.`,
+    ...(result.entries.length === 0
+      ? ["Entries: none"]
+      : result.entries.flatMap((entry) => {
+          return [
+            `- ${entry.repoPath} [${entry.kind}, ${entry.mode}] -> ${entry.localPath}`,
+            ...(entry.overrides.length === 0
+              ? []
+              : entry.overrides.map((override) => {
+                  return `  override ${override.selector}: ${override.mode}`;
+                })),
+          ];
+        })),
+  ];
+
+  return ensureTrailingNewline(lines.join("\n"));
+};
+
+export const formatSyncStatusResult = (result: SyncStatusResult) => {
+  const lines = [
+    "Sync status overview.",
+    `Sync directory: ${result.syncDirectory}`,
+    `Config file: ${result.configPath}`,
+    `Summary: ${result.recipientCount} recipients, ${result.entryCount} entries, ${result.ruleCount} rules.`,
+    `Push plan: ${result.push.plainFileCount} plain files, ${result.push.encryptedFileCount} encrypted files, ${result.push.symlinkCount} symlinks, ${result.push.directoryCount} directory roots, ${result.push.deletedArtifactCount} stale repository artifacts.`,
+    ...(result.push.preview.length === 0
+      ? ["Push preview: no tracked paths"]
+      : [`Push preview: ${result.push.preview.join(", ")}`]),
+    `Pull plan: ${result.pull.plainFileCount} plain files, ${result.pull.decryptedFileCount} decrypted files, ${result.pull.symlinkCount} symlinks, ${result.pull.directoryCount} directory roots, ${result.pull.deletedLocalCount} local paths.`,
+    ...(result.pull.preview.length === 0
+      ? ["Pull preview: no tracked paths"]
+      : [`Pull preview: ${result.pull.preview.join(", ")}`]),
+  ];
+
+  return ensureTrailingNewline(lines.join("\n"));
+};
+
+export const formatSyncDoctorResult = (result: SyncDoctorResult) => {
+  const counts = result.checks.reduce(
+    (accumulator, check) => {
+      accumulator[check.level] += 1;
+
+      return accumulator;
+    },
+    {
+      fail: 0,
+      ok: 0,
+      warn: 0,
+    },
+  );
+  const lines = [
+    result.hasFailures ? "Sync doctor found issues." : "Sync doctor passed.",
+    `Sync directory: ${result.syncDirectory}`,
+    `Config file: ${result.configPath}`,
+    `Summary: ${counts.ok} ok, ${counts.warn} warnings, ${counts.fail} failures.`,
+    ...result.checks.map((check) => {
+      return `[${check.level.toUpperCase()}] ${check.name}: ${check.detail}`;
+    }),
+  ];
+
+  return ensureTrailingNewline(lines.join("\n"));
+};