@apso/cli 0.29.1 → 0.30.0

package/dist/commands/generate.js

@@ -8,13 +8,14 @@ const lib_1 = require("../lib");
 const base_command_1 = tslib_1.__importDefault(require("../lib/base-command"));
 const perf_hooks_1 = require("perf_hooks");
 const file_system_1 = require("../lib/utils/file-system");
+const git_hooks_1 = require("../lib/utils/git-hooks");
 class Generate extends base_command_1.default {
     async run() {
         var _a, _b;
         const { flags } = await this.parse(Generate);
         const skipFormat = flags["skip-format"];
         const totalBuildStart = perf_hooks_1.performance.now();
-        const { rootFolder, entities, relationshipMap, apiType, auth, emitEvents, http, language: configLanguage } = (0, lib_1.parseApsorc)();
+        const { rootFolder, entities, relationshipMap, apiType, auth, emitEvents, http, coAuthor, language: configLanguage } = (0, lib_1.parseApsorc)();
         // Resolve language: flag > .apsorc > prompt
         let language;
         if (flags.language) {
@@ -235,6 +236,24 @@ class Generate extends base_command_1.default {
         }
         const totalBuildTime = perf_hooks_1.performance.now() - totalBuildStart;
         console.log(`[apso] Finished building all entities in ${totalBuildTime.toFixed(2)} ms`);
+        // Best-effort: install the commit co-author hook so commits that include
+        // Apso-generated files credit Apso as a co-author. Never fails the command.
+        try {
+            const result = (0, git_hooks_1.installCoAuthorHook)(process.cwd(), {
+                disabled: coAuthor === false,
+            });
+            if (result.installed) {
+                console.log("[apso] Commit co-author hook installed (.apso/hooks)");
+            }
+            else if (result.reason === "custom-hookspath") {
+                console.log("[apso] A custom git core.hooksPath is already configured (e.g. husky), so the Apso co-author hook was not installed.\n" +
+                    "[apso] To credit Apso on commits that include generated files, add this trailer to your existing prepare-commit-msg hook when the staged diff touches an `autogen/` path:\n" +
+                    '[apso]   git interpret-trailers --in-place --if-exists addIfDifferent --trailer "Co-authored-by: Apso <bot@apso.ai>" "$1"');
+            }
+        }
+        catch {
+            // Never let hook installation fail the generate command.
+        }
     }
 }
 Generate.description = "Generate code from .apsorc schema";

package/dist/commands/init.d.ts

@@ -12,5 +12,11 @@ export default class Init extends BaseCommand {
     private cloneExisting;
     private createNew;
     private runOffline;
+    /**
+     * Best-effort install of the Apso commit co-author hook. Never throws, never
+     * fails the command. No `.apsorc` may exist yet at init time, so we only
+     * respect the `APSO_NO_COAUTHOR=1` env opt-out (handled inside the installer).
+     */
+    private installCoAuthorHook;
     private postSetup;
 }

package/dist/commands/init.js

@@ -13,6 +13,7 @@ const upgrade_1 = require("../lib/upgrade");
 const interactive_1 = require("../lib/utils/interactive");
 const config_2 = require("../lib/config");
 const template_1 = require("../lib/utils/template");
+const git_hooks_1 = require("../lib/utils/git-hooks");
 class Init extends base_command_1.default {
     async run() {
         const { flags } = await this.parse(Init);
@@ -119,6 +120,7 @@ class Init extends base_command_1.default {
             linkedAt: new Date().toISOString(),
         };
         config_1.projectLink.write(link, projectPath);
+        this.installCoAuthorHook(projectPath);
         this.log(`\nProject cloned to ${projectPath}`);
         this.log(`Linked to workspace "${workspace.name}" / service "${service.name}"`);
     }
@@ -286,7 +288,29 @@ class Init extends base_command_1.default {
         this.log(`Language: ${language}`);
         this.log('Run "apso login" to link this project to the Apso platform.');
     }
+    /**
+     * Best-effort install of the Apso commit co-author hook. Never throws, never
+     * fails the command. No `.apsorc` may exist yet at init time, so we only
+     * respect the `APSO_NO_COAUTHOR=1` env opt-out (handled inside the installer).
+     */
+    installCoAuthorHook(projectPath) {
+        try {
+            const result = (0, git_hooks_1.installCoAuthorHook)(projectPath);
+            if (result.installed) {
+                this.log("[apso] Commit co-author hook installed (.apso/hooks)");
+            }
+            else if (result.reason === "custom-hookspath") {
+                this.log("[apso] A custom git core.hooksPath is already configured (e.g. husky), so the Apso co-author hook was not installed.\n" +
+                    "[apso] To credit Apso on commits that include generated files, add this trailer to your existing prepare-commit-msg hook when the staged diff touches an `autogen/` path:\n" +
+                    '[apso]   git interpret-trailers --in-place --if-exists addIfDifferent --trailer "Co-authored-by: Apso <bot@apso.ai>" "$1"');
+            }
+        }
+        catch {
+            // Never let hook installation fail init.
+        }
+    }
     async postSetup(projectPath, language) {
+        this.installCoAuthorHook(projectPath);
         switch (language) {
             case "typescript": {
                 if (shelljs_1.default.which("npm")) {

package/dist/lib/apsorc-parser.d.ts

@@ -25,6 +25,12 @@ export type ApsorcType = {
      * gets a generated controller unless it opts back in with `http: true`.
      */
     http?: boolean;
+    /**
+     * Opt-out for the Apso commit co-author hook. When false, the CLI will not
+     * install the `prepare-commit-msg` hook that appends the Apso co-author
+     * trailer. Defaults to enabled.
+     */
+    coAuthor?: boolean;
 };
 type ParsedApsorcData = {
     entities: Entity[];
@@ -41,6 +47,8 @@ type ParsedApsorc = {
     emitEvents?: boolean;
     /** Top-level default for HTTP controller generation. */
     http?: boolean;
+    /** Opt-out for the Apso commit co-author hook (defaults to enabled). */
+    coAuthor?: boolean;
 };
 export declare const parseApsorcV1: (apsorc: ApsorcType) => ParsedApsorcData;
 export declare const parseApsorcV2: (apsorc: ApsorcType) => ParsedApsorcData;

package/dist/lib/apsorc-parser.js

@@ -38,6 +38,7 @@ const parseRc = () => {
     const language = apsoConfig.language;
     const emitEvents = apsoConfig.emitEvents;
     const http = apsoConfig.http;
+    const coAuthor = apsoConfig.coAuthor;
     return {
         rootFolder,
         apiType,
@@ -48,6 +49,7 @@ const parseRc = () => {
         language,
         emitEvents,
         http,
+        coAuthor,
     };
 };
 const parseApsorc = () => {
@@ -69,6 +71,7 @@ const parseApsorc = () => {
                     language: apsoConfig.language,
                     emitEvents: apsoConfig.emitEvents,
                     http: apsoConfig.http,
+                    coAuthor: apsoConfig.coAuthor,
                     ...(0, exports.parseApsorcV1)(apsoConfig),
                 };
                 if (debug) {
@@ -87,6 +90,7 @@ const parseApsorc = () => {
                     language: apsoConfig.language,
                     emitEvents: apsoConfig.emitEvents,
                     http: apsoConfig.http,
+                    coAuthor: apsoConfig.coAuthor,
                     ...(() => {
                         const relStart = perf_hooks_1.performance.now();
                         const parsed = (0, exports.parseApsorcV2)(apsoConfig);

package/dist/lib/utils/git-hooks.d.ts

@@ -0,0 +1,48 @@
+/**
+ * The Apso co-author git trailer. Appended to commits that include
+ * Apso-generated work so Apso is credited as a co-author.
+ */
+export declare const APSO_COAUTHOR_TRAILER = "Co-authored-by: Apso <bot@apso.ai>";
+/**
+ * Relative path (from the repo top-level) where the managed hook is installed.
+ * Modern git resolves a relative `core.hooksPath` from the repository root.
+ */
+export declare const APSO_HOOKS_DIR = ".apso/hooks";
+/**
+ * Builds the `prepare-commit-msg` bash script that appends the Apso co-author
+ * trailer to commits that touch Apso-generated paths.
+ *
+ * Pure function (no side effects) so it can be unit-tested directly.
+ *
+ * Behaviour of the generated script:
+ * - Skips merge/squash commits (`$2` is `merge` or `squash`).
+ * - Honors the `APSO_NO_COAUTHOR=1` opt-out.
+ * - Only acts when the staged changes include an Apso-generated path
+ *   (a path segment named `autogen/`).
+ * - Adds the trailer idempotently via `git interpret-trailers`, which handles
+ *   trailer-block formatting + dedupe and coexists with other `Co-authored-by`
+ *   trailers (e.g. Claude).
+ */
+export declare function buildCoAuthorHookScript(): string;
+export interface InstallCoAuthorHookOptions {
+    /** When true, skip installation (e.g. `.apsorc` set `coAuthor: false`). */
+    disabled?: boolean;
+}
+export interface InstallCoAuthorHookResult {
+    installed: boolean;
+    reason?: "disabled" | "not-a-git-repo" | "custom-hookspath" | "error";
+}
+/**
+ * Installs the Apso co-author `prepare-commit-msg` hook into a project.
+ *
+ * Best-effort: never throws. Callers can log the result.
+ *
+ * - Respects the `disabled` option and the `APSO_NO_COAUTHOR=1` env opt-out.
+ * - No-ops (returns `not-a-git-repo`) outside a git work tree.
+ * - Writes `<projectRoot>/.apso/hooks/prepare-commit-msg` (mode 0755).
+ * - Sets the repo-local `core.hooksPath` to `.apso/hooks` when unset; leaves it
+ *   alone (and reports success) when it's already `.apso/hooks`; refuses to
+ *   clobber a custom `core.hooksPath` (husky etc.) and reports
+ *   `custom-hookspath` so the caller can guide the user.
+ */
+export declare function installCoAuthorHook(projectRoot: string, opts?: InstallCoAuthorHookOptions): InstallCoAuthorHookResult;

package/dist/lib/utils/git-hooks.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.installCoAuthorHook = exports.buildCoAuthorHookScript = exports.APSO_HOOKS_DIR = exports.APSO_COAUTHOR_TRAILER = void 0;
+const tslib_1 = require("tslib");
+const child_process_1 = require("child_process");
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+/**
+ * The Apso co-author git trailer. Appended to commits that include
+ * Apso-generated work so Apso is credited as a co-author.
+ */
+exports.APSO_COAUTHOR_TRAILER = "Co-authored-by: Apso <bot@apso.ai>";
+/**
+ * Relative path (from the repo top-level) where the managed hook is installed.
+ * Modern git resolves a relative `core.hooksPath` from the repository root.
+ */
+exports.APSO_HOOKS_DIR = ".apso/hooks";
+/**
+ * Builds the `prepare-commit-msg` bash script that appends the Apso co-author
+ * trailer to commits that touch Apso-generated paths.
+ *
+ * Pure function (no side effects) so it can be unit-tested directly.
+ *
+ * Behaviour of the generated script:
+ * - Skips merge/squash commits (`$2` is `merge` or `squash`).
+ * - Honors the `APSO_NO_COAUTHOR=1` opt-out.
+ * - Only acts when the staged changes include an Apso-generated path
+ *   (a path segment named `autogen/`).
+ * - Adds the trailer idempotently via `git interpret-trailers`, which handles
+ *   trailer-block formatting + dedupe and coexists with other `Co-authored-by`
+ *   trailers (e.g. Claude).
+ */
+function buildCoAuthorHookScript() {
+    return `#!/usr/bin/env bash
+set -euo pipefail
+
+# Managed by Apso (@apso/cli). Appends an Apso co-author trailer to commits
+# that include Apso-generated files. To opt out, set APSO_NO_COAUTHOR=1 or
+# remove this hook (and unset core.hooksPath).
+
+COMMIT_MSG_FILE="\${1:-}"
+COMMIT_SOURCE="\${2:-}"
+
+# Don't trailer merge or squash commit messages.
+if [ "$COMMIT_SOURCE" = "merge" ] || [ "$COMMIT_SOURCE" = "squash" ]; then
+  exit 0
+fi
+
+# Opt-out.
+if [ "\${APSO_NO_COAUTHOR:-}" = "1" ]; then
+  exit 0
+fi
+
+# Only act when the staged changes include an Apso-generated path.
+if ! git diff --cached --name-only | grep -qE '(^|/)autogen/'; then
+  exit 0
+fi
+
+# Add the trailer idempotently. git handles formatting + dedupe and coexists
+# with an existing "Co-authored-by: Claude" trailer.
+git interpret-trailers --in-place --if-exists addIfDifferent \\
+  --trailer "${exports.APSO_COAUTHOR_TRAILER}" "$COMMIT_MSG_FILE"
+`;
+}
+exports.buildCoAuthorHookScript = buildCoAuthorHookScript;
+/**
+ * Installs the Apso co-author `prepare-commit-msg` hook into a project.
+ *
+ * Best-effort: never throws. Callers can log the result.
+ *
+ * - Respects the `disabled` option and the `APSO_NO_COAUTHOR=1` env opt-out.
+ * - No-ops (returns `not-a-git-repo`) outside a git work tree.
+ * - Writes `<projectRoot>/.apso/hooks/prepare-commit-msg` (mode 0755).
+ * - Sets the repo-local `core.hooksPath` to `.apso/hooks` when unset; leaves it
+ *   alone (and reports success) when it's already `.apso/hooks`; refuses to
+ *   clobber a custom `core.hooksPath` (husky etc.) and reports
+ *   `custom-hookspath` so the caller can guide the user.
+ */
+function installCoAuthorHook(projectRoot, opts = {}) {
+    try {
+        if (opts.disabled || process.env.APSO_NO_COAUTHOR === "1") {
+            return { installed: false, reason: "disabled" };
+        }
+        // Verify we're inside a git work tree.
+        try {
+            (0, child_process_1.execFileSync)("git", ["-C", projectRoot, "rev-parse", "--is-inside-work-tree"], {
+                stdio: "ignore",
+            });
+        }
+        catch {
+            return { installed: false, reason: "not-a-git-repo" };
+        }
+        // Write the hook script.
+        const hooksDir = path.join(projectRoot, ".apso", "hooks");
+        fs.mkdirSync(hooksDir, { recursive: true });
+        const hookPath = path.join(hooksDir, "prepare-commit-msg");
+        fs.writeFileSync(hookPath, buildCoAuthorHookScript(), { mode: 0o755 });
+        // writeFileSync's mode is subject to umask on create and ignored on
+        // overwrite; chmod explicitly so the hook is always executable.
+        fs.chmodSync(hookPath, 0o755);
+        // Inspect the current core.hooksPath.
+        let currentHooksPath = "";
+        try {
+            currentHooksPath = (0, child_process_1.execFileSync)("git", ["-C", projectRoot, "config", "--get", "core.hooksPath"], { encoding: "utf8" }).trim();
+        }
+        catch {
+            // `git config --get` exits non-zero when the key is unset.
+            currentHooksPath = "";
+        }
+        if (currentHooksPath === "") {
+            (0, child_process_1.execFileSync)("git", ["-C", projectRoot, "config", "core.hooksPath", exports.APSO_HOOKS_DIR], { stdio: "ignore" });
+            return { installed: true };
+        }
+        if (currentHooksPath === exports.APSO_HOOKS_DIR) {
+            return { installed: true };
+        }
+        // Some other hooks path is configured (husky, etc.). Don't clobber it.
+        return { installed: false, reason: "custom-hookspath" };
+    }
+    catch {
+        return { installed: false, reason: "error" };
+    }
+}
+exports.installCoAuthorHook = installCoAuthorHook;

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@apso/cli",
-  "version": "0.29.1",
+  "version": "0.30.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@apso/cli",
-      "version": "0.29.1",
+      "version": "0.30.0",
       "license": "Apache-2.0",
       "dependencies": {
         "@biomejs/biome": "^1.9.4",

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.29.1",
+  "version": "0.30.0",
   "commands": {
     "config": {
       "id": "config",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apso/cli",
-  "version": "0.29.1",
+  "version": "0.30.0",
   "mcpName": "io.github.apsoai/apso",
   "description": "Apso CLI",
   "author": "Apso by Mavric - @mavric",