co-maintainer 0.4.0 → 0.4.2

package/README.md

@@ -1,5 +1,7 @@
 # co-maintainer
 
+[![NPM Version](https://img.shields.io/npm/v/co-maintainer)](https://www.npmjs.com/package/co-maintainer)
+
 `co-maintainer` analyzes a GitHub repository and writes repository-specific
 `SKILL.md` guidance that helps developers contribute changes more reliably.
 

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "co-maintainer",
-    "version": "0.4.0",
+    "version": "0.4.2",
     "description": "Analyzes a GitHub repository and writes repository-specific contribution guidance.",
     "license": "MIT",
     "repository": {

package/dist/src/cli/args.js

@@ -46,6 +46,7 @@ export async function parseArgs(args) {
         console.log("       co-maintainer review owner/repo PR_NUMBER [options]");
         console.log("       co-maintainer set --token=... --ai=... --low-model=... --high-model=... --auth=...");
         console.log("       co-maintainer serve --port=N");
+        console.log("       co-maintainer -v | --version");
         console.log("         --webhook-url=https://host/github/webhook [or CM_WEBHOOK_URL]");
         console.log("         --env=PATH --debug --log-time --gh-concurrent=N --ai-concurrent=N");
         console.log("Options: --include-codebase --include-pull-requests --include-pull-request-changes");

package/dist/src/cli/commands/serve.d.ts

@@ -11,8 +11,8 @@ export declare function resolveAuthMethods(args: string[], config: Pick<UserConf
 export declare function resolveWebhookUrl(args: string[], port: number, configured?: string): string;
 /** `co-maintainer serve --port=N [--password=...] [--disable-auth=password]
  * [--enable-auth=github] [--inject-500]`. HMAC-verified `POST /github/webhook`
- * plus a dashboard gated by password and/or GitHub sign-in. Requires the
- * GitHub App via `co-maintainer set` (webhook secret is optional, only the
- * App ID and private key gate startup); GitHub sign-in additionally needs
+ * plus a dashboard gated by password and/or GitHub sign-in. The GitHub App
+ * is optional at startup and can be added later from the dashboard settings
+ * or `co-maintainer set`. GitHub sign-in needs
  * `--github-oauth-client-id`/`-client-secret`/`-allowed-user` set. */
 export declare function runServe(args: string[]): Promise<void>;

package/dist/src/cli/commands/serve.js

@@ -83,9 +83,9 @@ export function resolveWebhookUrl(args, port, configured) {
 }
 /** `co-maintainer serve --port=N [--password=...] [--disable-auth=password]
  * [--enable-auth=github] [--inject-500]`. HMAC-verified `POST /github/webhook`
- * plus a dashboard gated by password and/or GitHub sign-in. Requires the
- * GitHub App via `co-maintainer set` (webhook secret is optional, only the
- * App ID and private key gate startup); GitHub sign-in additionally needs
+ * plus a dashboard gated by password and/or GitHub sign-in. The GitHub App
+ * is optional at startup and can be added later from the dashboard settings
+ * or `co-maintainer set`. GitHub sign-in needs
  * `--github-oauth-client-id`/`-client-secret`/`-allowed-user` set. */
 export async function runServe(args) {
     const portArg = args
@@ -99,14 +99,8 @@ export async function runServe(args) {
     }
     const config = readConfig();
     const webhookUrl = resolveWebhookUrl(args, port, config.webhookUrl);
-    const missing = [
-        !config.githubAppId && "--github-app-id=...",
-        !config.githubAppPrivateKey &&
-            "--github-app-private-key=... (or --github-app-private-key-file=path)",
-    ].filter(Boolean);
-    if (missing.length > 0) {
-        die(`serve requires the GitHub App to be configured first; run:\n` +
-            `  co-maintainer set ${missing.join(" ")}`);
+    if (!config.githubAppId || !config.githubAppPrivateKey) {
+        console.log("[serve] GitHub App is not configured yet. Add it in the dashboard settings or with co-maintainer set.");
     }
     const auth = resolveAuthMethods(args, config);
     let githubOAuth;
@@ -157,13 +151,6 @@ export async function runServe(args) {
     }
     const app = createApp({
         password,
-        githubApp: config.githubAppId && config.githubAppPrivateKey
-            ? {
-                appId: config.githubAppId,
-                privateKeyPem: config.githubAppPrivateKey,
-            }
-            : undefined,
-        webhookSecret: config.githubWebhookSecret,
         webhookUrl,
         inject500,
         auth,

package/dist/src/cli/main.js

@@ -6,7 +6,12 @@ import { runSet } from "./commands/set.js";
 import { runProbe } from "./commands/probe.js";
 import { runReviewFromCli } from "./commands/review.js";
 import { runInitOrRemake } from "../services/setup.js";
+import { VERSION } from "../version.js";
 export async function run(args) {
+    if (args[0] === "-v" || args[0] === "--version") {
+        console.log(VERSION);
+        return;
+    }
     if (args[0] === "set") {
         await runSet(args.slice(1));
         return;

package/dist/src/knowledge/facts.js

@@ -314,9 +314,12 @@ export function extractFacts(source, options) {
                 .join("; ")}.`, "commit history", 2));
         }
     }
-    if (options.includePullRequestChanges &&
-        source.pullRequests.some((pr) => pr.changedFiles.length)) {
-        const files = counts(source.pullRequests.flatMap((pr) => pr.changedFiles)).slice(0, 10);
+    const currentPaths = new Set(source.tree);
+    const changedFiles = source.pullRequests
+        .flatMap((pr) => pr.changedFiles)
+        .filter((path) => currentPaths.has(path));
+    if (options.includePullRequestChanges && changedFiles.length) {
+        const files = counts(changedFiles).slice(0, 10);
         add(facts, fact("review-bar", `Frequently changed files include ${files
             .map(([path]) => `\`${path}\``)
             .join(", ")}; check nearby tests and workflows before editing.`, "pull request files", 2));

package/dist/src/knowledge/validate.d.ts

@@ -2,5 +2,6 @@ import type { Source } from "./types.ts";
 export type ValidationResult = {
     valid: boolean;
     errors: string[];
+    warnings: string[];
 };
-export declare function validateSkill(markdown: string, outputDirectory: string, source?: Source): Promise<ValidationResult>;
+export declare function validateSkill(markdown: string, outputDirectory: string, source?: Source, referenceIssues?: "error" | "warning"): Promise<ValidationResult>;

package/dist/src/knowledge/validate.js

@@ -1,6 +1,8 @@
 import { stat } from "../util/runtime.js";
-export async function validateSkill(markdown, outputDirectory, source) {
+export async function validateSkill(markdown, outputDirectory, source, referenceIssues = "error") {
     const errors = [];
+    const warnings = [];
+    const referenceProblems = referenceIssues === "error" ? errors : warnings;
     if (!markdown.startsWith("---\n"))
         errors.push("missing YAML frontmatter");
     if (!/^name:\s+\S+/m.test(markdown))
@@ -104,14 +106,14 @@ export async function validateSkill(markdown, outputDirectory, source) {
                     ![...paths].some((path) => wildcardPattern
                         ? wildcardPattern.test(path)
                         : path.startsWith(`${normalized}/`))) {
-                    errors.push(`referenced path is absent from source: ${reference}`);
+                    referenceProblems.push(`referenced path is absent from source: ${reference}`);
                 }
             }
             if (/^(?:npm|pnpm|yarn|bun|deno|cargo|make|go|python|node|git)\s/.test(reference) &&
                 ![...commands].some((command) => reference === command ||
                     reference.startsWith(`${command} `) ||
                     command.startsWith(`${reference} `))) {
-                errors.push(`referenced command is absent from source: ${reference}`);
+                referenceProblems.push(`referenced command is absent from source: ${reference}`);
             }
         }
     }
@@ -130,5 +132,5 @@ export async function validateSkill(markdown, outputDirectory, source) {
             errors.push(`linked file does not exist: ${link}`);
         }
     }
-    return { valid: errors.length === 0, errors };
+    return { valid: errors.length === 0, errors, warnings };
 }

package/dist/src/server/app.d.ts

@@ -1,14 +1,8 @@
 import type { AuthMethods } from "./auth.ts";
 /** `password` is the dashboard password `serve` generates or takes via
- * `--password`. `githubApp` is unset until `co-maintainer set` has both
- * the App ID and private key. */
+ * `--password`. */
 export type AppDeps = {
     password: string;
-    githubApp?: {
-        appId: string;
-        privateKeyPem: string;
-    };
-    webhookSecret?: string;
     webhookUrl?: string;
     secureCookie?: boolean;
     inject500?: boolean;

package/dist/src/server/app.js

@@ -78,18 +78,33 @@ function health() {
         db,
     });
 }
+/** Read per request so credentials saved from the dashboard take effect
+ * without restarting `serve`. */
+function liveGithubConfig() {
+    const config = readConfig();
+    return {
+        githubApp: config.githubAppId && config.githubAppPrivateKey
+            ? {
+                appId: config.githubAppId,
+                privateKeyPem: config.githubAppPrivateKey,
+            }
+            : undefined,
+        webhookSecret: config.githubWebhookSecret,
+    };
+}
 export function createApp(deps) {
     return {
         async fetch(request, remoteAddr = "unknown") {
             const url = new URL(request.url);
+            const { githubApp, webhookSecret } = liveGithubConfig();
             const mutating = ["POST", "PATCH", "PUT", "DELETE"].includes(request.method);
             if (url.pathname === "/api/health" && request.method === "GET") {
                 return health();
             }
             if (url.pathname === "/github/webhook" && request.method === "POST") {
-                return await handleWebhookRequest(request, deps.webhookSecret);
+                return await handleWebhookRequest(request, webhookSecret);
             }
-            const page = await handlePageRequest(request, deps, remoteAddr);
+            const page = await handlePageRequest(request, { ...deps, githubApp }, remoteAddr);
             if (page)
                 return page;
             if (url.pathname.startsWith("/api/remote/")) {
@@ -122,10 +137,10 @@ export function createApp(deps) {
                     return handleJobsRoute(request, url);
                 }
                 if (url.pathname.startsWith("/api/repos")) {
-                    return await handleReposRoute(request, url, deps.githubApp);
+                    return await handleReposRoute(request, url, githubApp);
                 }
                 if (url.pathname === "/api/installations") {
-                    return await handleInstallationsRoute(request, deps.githubApp);
+                    return await handleInstallationsRoute(request, githubApp);
                 }
                 if (url.pathname.startsWith("/api/settings")) {
                     return await handleSettingsRoute(request, url, deps.webhookUrl ?? "");

package/dist/src/services/setup.js

@@ -211,7 +211,10 @@ export async function runInitOrRemake(options) {
         result = await timed("reassemble valid skill", options.logTime, () => assembleSkill(options.repo, facts, previousMarkdown, previous?.sectionHashes ?? {}, overrides));
         result.markdown = addReviewLink(result.markdown, reviewDocuments);
     }
-    const finalValidation = await timed("final skill validation", options.logTime, () => validateSkill(result.markdown, `${reposDir()}/${options.repo}`, source));
+    const finalValidation = await timed("final skill validation", options.logTime, () => validateSkill(result.markdown, `${reposDir()}/${options.repo}`, source, "warning"));
+    if (finalValidation.warnings.length) {
+        log("validate", `stale references kept: ${finalValidation.warnings.join(", ")}`);
+    }
     if (!finalValidation.valid) {
         throw new Error(`generated skill is invalid: ${finalValidation.errors.join("; ")}`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "co-maintainer",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Analyzes a GitHub repository and writes repository-specific contribution guidance.",
   "license": "MIT",
   "repository": {