@promptci/core 0.2.1 → 0.3.0

package/dist/discovery.d.ts

@@ -0,0 +1,138 @@
+/**
+ * Discovery lists and a pure path-based discovery API (pcic-zg3).
+ *
+ * `scanner.ts` (instruction files), `ai-config.ts` (skills, settings, MCP) and
+ * `repo-context.ts` (workflows / composite actions) each discover a different
+ * class of file from the real filesystem with `fast-glob`. The constants and
+ * predicates that decide WHAT belongs to each class live here, once, so those
+ * three modules import them instead of keeping their own copies — two
+ * modules can no longer drift apart on what counts as, say, a skill location.
+ *
+ * `selectScanPaths` is the filesystem-free counterpart: given a plain list of
+ * repo-relative paths (as a server with only a GitHub tree listing has, not a
+ * checkout), it applies the exact same patterns, `include`/`exclude` policy,
+ * and caps to answer what a real scan would read, without ever touching disk.
+ * It applies scanner.ts's MAX_FILE_SIZE guard to instruction files and
+ * composite actions when a caller supplies `size` (there is nothing to check
+ * without it); it never applies the binary-content guard, since there are no
+ * bytes here to sniff.
+ */
+/** Files larger than this are skipped before they are ever read (scanner.ts). */
+export declare const MAX_FILE_SIZE: number;
+/** Bytes sniffed for a NUL byte when deciding whether a file is binary (scanner.ts). */
+export declare const BINARY_CHECK_BYTES = 512;
+/** Default glob patterns scanner.ts reads when no `include` override is given. */
+export declare const DEFAULT_INSTRUCTION_PATTERNS: readonly string[];
+/** `DEFAULT_INSTRUCTION_PATTERNS`, minus the `.clinerules/` directory globs when it is a file. */
+export declare function defaultInstructionPatterns(clineIsDir: boolean): readonly string[];
+/** Directory names scanner.ts's default scan ignores at any depth. */
+export declare const SCAN_IGNORE_DIRS: readonly string[];
+/**
+ * Every location an Agent Skill is installed from. The root-level globs are
+ * anchored on purpose: a `**\/skills/**` glob would also sweep up vendored
+ * copies and test fixtures.
+ */
+export declare const SKILL_GLOBS: readonly string[];
+/** Non-markdown config surfaces ai-config.ts discovers and whose content a detector reports on. */
+export declare const AI_CONFIG_EXACT_FILES: readonly string[];
+/**
+ * Subagent, Cursor-rule and Copilot per-file instruction surfaces. These ARE
+ * markdown, and scanner.ts's own `DEFAULT_INSTRUCTION_PATTERNS` glob-matches
+ * the same locations — but the detectors that structurally audit them
+ * (subagents-detector.ts, cursor-rules-detector.ts, copilot-instructions-
+ * detector.ts) read them independently through `context.aiConfig`, which
+ * ai-config.ts discovers under `DISCOVERY_IGNORE_DIRS` (no `bin`/`obj`/
+ * `Library`/`Temp`), not scanner.ts's longer `SCAN_IGNORE_DIRS`. A file under
+ * one of those four extra ignored names is matched here but not by
+ * `instructionFiles`'s glob — put in `aiConfigFiles` rather than invented as
+ * a sixth result field, since that is genuinely how core reads it: never as
+ * always-loaded instruction prose there, always through the ai_config path.
+ * A copy outside those four directories legitimately appears in BOTH
+ * buckets, the same way a SKILL.md appears in both `instructionFiles` and
+ * `skillFiles` — two real pipelines reading the same file for two purposes.
+ */
+export declare const AI_CONFIG_MARKDOWN_GLOBS: readonly string[];
+/** Directory names discovery for skills/agents/settings/mcp/cursor-rules ignores. */
+export declare const DISCOVERY_IGNORE_DIRS: readonly string[];
+/**
+ * Exact repo-relative directories that hold skills rather than being one — a
+ * SKILL.md sitting directly in one of them owns no bundle of its own.
+ */
+export declare const SKILL_CONTAINER_DIRS: ReadonlySet<string>;
+export declare function isSkillContainerDir(dir: string): boolean;
+/** Directories inside a skill that are not walked for bundled files. */
+export declare const BUNDLE_SKIP_DIRS: ReadonlySet<string>;
+/** Upper bound on bundled files read per skill. */
+export declare const MAX_BUNDLED_FILES_PER_SKILL = 200;
+/** Directory entries visited per skill before the (real, filesystem) walk stops. */
+export declare const MAX_BUNDLE_LISTING = 20000;
+/** Dependency package manifests read per skill (per `node_modules/` found, and in total). */
+export declare const MAX_DEPENDENCY_MANIFESTS = 100;
+export declare function isPriorityBundleFile(rel: string): boolean;
+/**
+ * Candidate `<node_modules>/<pkg>/package.json` manifests, in the order and
+ * bounded the way ai-config.ts's `listPackageManifests` reads them: top-level
+ * entries sorted by name (dot-prefixed ones skipped), a `@scope` entry's own
+ * children sorted by name within it, capped at `cap` total. Shared between
+ * that filesystem-backed reader and this module's path-only equivalent so
+ * the two cannot drift on ORDER — each supplies its own `exists`/listing.
+ */
+export declare function dependencyManifestCandidates(topLevelNames: readonly string[], scopedNamesOf: (scope: string) => readonly string[], exists: (relPath: string) => boolean, nodeModulesDir: string, cap?: number): string[];
+/** Composite actions: a root `action.yml` and any under `.github/actions/`. */
+export declare const COMPOSITE_ACTION_GLOBS: readonly string[];
+/** A repo-relative POSIX path, optionally carrying its blob size in bytes and whether it is a symlink. */
+export type ScanPathEntry = string | {
+    path: string;
+    size?: number;
+    symlink?: boolean;
+};
+export type SelectScanPathsOptions = {
+    /**
+     * Overrides `DEFAULT_INSTRUCTION_PATTERNS` entirely for instruction-file
+     * matching — the same effect `ScanInput.include` has on a real scan. Also
+     * NARROWS (intersects with) every `aiConfigFiles`/`skillFiles` surface
+     * (skills, settings, MCP, subagents, Cursor rules, Copilot instructions),
+     * exactly as `discoverAiConfigFiles` does — it does not replace their own
+     * globs. Never affects workflow or composite-action discovery (neither
+     * does a real scan's `include`).
+     */
+    include?: readonly string[];
+    /**
+     * The same effect `ScanInput.exclude` has on a real scan: removed from
+     * every class except the root-level context reads (package.json,
+     * pyproject.toml, lockfile-adjacent manifests, etc.) that core itself
+     * never checks `exclude` against.
+     */
+    exclude?: readonly string[];
+};
+export type SelectScanPathsResult = {
+    /** Files a scan reads and reports on as always-loaded instruction prose. */
+    instructionFiles: string[];
+    /** `SKILL.md` files plus the files bundled alongside them. */
+    skillFiles: string[];
+    /**
+     * AI config a detector reads and reports on through `context.aiConfig`,
+     * never through the always-loaded instruction-prose pipeline: Claude
+     * settings, `.mcp.json`, subagents, Cursor rules, Copilot per-file
+     * instructions. The last three are markdown and may ALSO appear in
+     * `instructionFiles` (two real pipelines read the same file) — but under
+     * `bin/`, `obj/`, `Library/` or `Temp/` they appear only here, since
+     * ai-config.ts's own discovery ignores a shorter list of directories than
+     * scanner.ts's does.
+     */
+    aiConfigFiles: string[];
+    /** GitHub Actions workflow files and composite `action.yml`/`action.yaml` files. */
+    workflowFiles: string[];
+    /** Files read for resolution (manifests, ignore files) but never reported on. */
+    contextFiles: string[];
+};
+/**
+ * Pure counterpart to a real scan's file discovery: given a repo's full path
+ * list (as a server building from GitHub's tree listing has, not a checkout),
+ * returns what a scan would read, classified the way the scanner, ai_config
+ * and repo-context modules classify it. Applies the same ignore dirs,
+ * `include`/`exclude` policy, skill-bundle rules and caps those modules use —
+ * see the module doc above.
+ */
+export declare function selectScanPaths(paths: readonly ScanPathEntry[], options?: SelectScanPathsOptions): SelectScanPathsResult;
+//# sourceMappingURL=discovery.d.ts.map

package/dist/discovery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.d.ts","sourceRoot":"","sources":["../src/discovery.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAMH,iFAAiF;AACjF,eAAO,MAAM,aAAa,QAAa,CAAC;AACxC,wFAAwF;AACxF,eAAO,MAAM,kBAAkB,MAAM,CAAC;AAItC,kFAAkF;AAClF,eAAO,MAAM,4BAA4B,EAAE,SAAS,MAAM,EAsCzD,CAAC;AAQF,kGAAkG;AAClG,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,OAAO,GAAG,SAAS,MAAM,EAAE,CAIjF;AAED,sEAAsE;AACtE,eAAO,MAAM,gBAAgB,EAAE,SAAS,MAAM,EAE7C,CAAC;AAIF;;;;GAIG;AACH,eAAO,MAAM,WAAW,EAAE,SAAS,MAAM,EAKxC,CAAC;AAEF,mGAAmG;AACnG,eAAO,MAAM,qBAAqB,EAAE,SAAS,MAAM,EAIlD,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,wBAAwB,EAAE,SAAS,MAAM,EAIrD,CAAC;AAEF,qFAAqF;AACrF,eAAO,MAAM,qBAAqB,EAAE,SAAS,MAAM,EAElD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC,MAAM,CAEnD,CAAC;AAEH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAExD;AAED,wEAAwE;AACxE,eAAO,MAAM,gBAAgB,EAAE,WAAW,CAAC,MAAM,CAAgE,CAAC;AAElH,mDAAmD;AACnD,eAAO,MAAM,2BAA2B,MAAM,CAAC;AAC/C,oFAAoF;AACpF,eAAO,MAAM,kBAAkB,QAAS,CAAC;AACzC,6FAA6F;AAC7F,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAc5C,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEzD;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,aAAa,EAAE,SAAS,MAAM,EAAE,EAChC,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,SAAS,MAAM,EAAE,EACnD,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,EACpC,cAAc,EAAE,MAAM,EACtB,GAAG,GAAE,MAAiC,GACrC,MAAM,EAAE,CAgBV;AAID,+EAA+E;AAC/E,eAAO,MAAM,sBAAsB,EAAE,SAAS,MAAM,EAKnD,CAAC;AAIF,0GAA0G;AAC1G,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAExF,MAAM,MAAM,sBAAsB,GAAG;IACnC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,4EAA4E;IAC5E,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,8DAA8D;IAC9D,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;;;;;;;;OASG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,oFAAoF;IACpF,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,iFAAiF;IACjF,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAuYF;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,SAAS,aAAa,EAAE,EAC/B,OAAO,CAAC,EAAE,sBAAsB,GAC/B,qBAAqB,CAuBvB"}