@open-agent-toolkit/cli 0.2.26 → 0.2.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/NOTICES.md +156 -0
- package/assets/docs/contributing/explainer-kit-verification.md +125 -0
- package/assets/docs/contributing/index.md +1 -0
- package/assets/docs/reference/troubleshooting.md +47 -0
- package/assets/docs/workflows/projects/artifacts.md +24 -6
- package/assets/docs/workflows/skills/explainer-kit-providers.md +144 -0
- package/assets/docs/workflows/skills/explainer-kit.md +121 -69
- package/assets/docs/workflows/skills/index.md +1 -0
- package/assets/public-package-versions.json +4 -4
- package/assets/skills/explainer-kit/SKILL.md +18 -3
- package/assets/skills/explainer-kit/recipes/project-recap.json +43 -16
- package/assets/skills/explainer-kit/references/contracts.md +167 -20
- package/assets/skills/explainer-kit/references/golden-conformance.md +80 -0
- package/assets/skills/explainer-kit/references/visual-authoring.md +92 -0
- package/assets/skills/explainer-kit/references/visual-review.md +57 -0
- package/assets/skills/explainer-kit/schemas/author-request.v2.schema.json +172 -1
- package/assets/skills/explainer-kit/schemas/build-record.schema.json +7 -1
- package/assets/skills/explainer-kit/schemas/fact-base.schema.json +38 -2
- package/assets/skills/explainer-kit/schemas/manifest.schema.json +25 -1
- package/assets/skills/explainer-kit/schemas/run-request.schema.json +4 -0
- package/assets/skills/explainer-kit/schemas/set-plan.v1.schema.json +149 -0
- package/assets/skills/explainer-kit/schemas/visual-review-request.v1.schema.json +117 -0
- package/assets/skills/explainer-kit/schemas/visual-review-result.v1.schema.json +80 -0
- package/assets/skills/explainer-kit/scripts/lib/browser-runtime.mjs +148 -4
- package/assets/skills/explainer-kit/scripts/lib/catalog.mjs +243 -0
- package/assets/skills/explainer-kit/scripts/lib/contracts.mjs +586 -8
- package/assets/skills/explainer-kit/scripts/lib/diagram.mjs +285 -8
- package/assets/skills/explainer-kit/scripts/lib/durability.mjs +35 -0
- package/assets/skills/explainer-kit/scripts/lib/fact-base.mjs +144 -8
- package/assets/skills/explainer-kit/scripts/lib/package-coverage.mjs +379 -0
- package/assets/skills/explainer-kit/scripts/lib/png.mjs +287 -0
- package/assets/skills/explainer-kit/scripts/lib/qa.mjs +280 -8
- package/assets/skills/explainer-kit/scripts/lib/recipes.mjs +132 -3
- package/assets/skills/explainer-kit/scripts/lib/records.mjs +513 -21
- package/assets/skills/explainer-kit/scripts/lib/render.mjs +67 -3
- package/assets/skills/explainer-kit/scripts/lib/s3-static.mjs +43 -1
- package/assets/skills/explainer-kit/scripts/lib/set-plan.mjs +208 -0
- package/assets/skills/explainer-kit/scripts/lib/source-backlinks.mjs +218 -0
- package/assets/skills/explainer-kit/scripts/lib/visual-review.mjs +380 -0
- package/assets/skills/explainer-kit/scripts/render-qa.mjs +48 -10
- package/assets/skills/explainer-kit/scripts/run.mjs +859 -134
- package/assets/skills/oat-explainer-kit/SKILL.md +40 -12
- package/assets/skills/oat-explainer-kit/references/author-callback.md +12 -10
- package/assets/skills/oat-explainer-kit/references/lifecycle-contract.md +40 -2
- package/assets/skills/oat-explainer-kit/references/visual-review-callback.md +72 -0
- package/assets/skills/oat-explainer-kit/scripts/bind-project-sources.mjs +167 -5
- package/assets/skills/oat-explainer-kit/scripts/finalize-tracked-run.mjs +92 -5
- package/assets/skills/oat-explainer-kit/scripts/run.mjs +324 -2
- package/dist/commands/project/archive/archive-utils.d.ts +1 -0
- package/dist/commands/project/archive/archive-utils.d.ts.map +1 -1
- package/dist/commands/project/archive/archive-utils.js +109 -42
- package/dist/commands/project/archive/explainer-package-coverage.d.ts +14 -0
- package/dist/commands/project/archive/explainer-package-coverage.d.ts.map +1 -0
- package/dist/commands/project/archive/explainer-package-coverage.js +27 -0
- package/dist/commands/project/archive/explainer-source-backlinks.d.ts +18 -0
- package/dist/commands/project/archive/explainer-source-backlinks.d.ts.map +1 -0
- package/dist/commands/project/archive/explainer-source-backlinks.js +27 -0
- package/dist/commands/project/archive/push-runner.d.ts +2 -1
- package/dist/commands/project/archive/push-runner.d.ts.map +1 -1
- package/dist/commands/project/archive/push-runner.js +5 -1
- package/dist/release/public-package-contract.d.ts +6 -0
- package/dist/release/public-package-contract.d.ts.map +1 -1
- package/dist/release/public-package-contract.js +75 -0
- package/package.json +2 -2
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
declare const SOURCE_BACKLINK_CONTRACT_VERSION = "explainer-kit.source-backlinks/v1";
|
|
2
|
+
export interface CanonicalSourceBacklink {
|
|
3
|
+
repository: string;
|
|
4
|
+
revision: string;
|
|
5
|
+
path: string;
|
|
6
|
+
lineRange: {
|
|
7
|
+
start: number;
|
|
8
|
+
end: number;
|
|
9
|
+
};
|
|
10
|
+
url: string;
|
|
11
|
+
}
|
|
12
|
+
export interface ExplainerSourceBacklinks {
|
|
13
|
+
SOURCE_BACKLINK_CONTRACT_VERSION: typeof SOURCE_BACKLINK_CONTRACT_VERSION;
|
|
14
|
+
parseCanonicalGithubBlobUrl: (value: string) => CanonicalSourceBacklink;
|
|
15
|
+
}
|
|
16
|
+
export declare function loadExplainerSourceBacklinks(): Promise<ExplainerSourceBacklinks>;
|
|
17
|
+
export {};
|
|
18
|
+
//# sourceMappingURL=explainer-source-backlinks.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"explainer-source-backlinks.d.ts","sourceRoot":"","sources":["../../../../src/commands/project/archive/explainer-source-backlinks.ts"],"names":[],"mappings":"AAMA,QAAA,MAAM,gCAAgC,sCAAsC,CAAC;AAE7E,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,wBAAwB;IACvC,gCAAgC,EAAE,OAAO,gCAAgC,CAAC;IAC1E,2BAA2B,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,uBAAuB,CAAC;CACzE;AAID,wBAAgB,4BAA4B,IAAI,OAAO,CAAC,wBAAwB,CAAC,CAGhF"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { join } from 'node:path';
|
|
2
|
+
import { pathToFileURL } from 'node:url';
|
|
3
|
+
import { CliError } from '../../../errors/cli-error.js';
|
|
4
|
+
import { resolveAssetsRoot } from '../../../fs/assets.js';
|
|
5
|
+
const SOURCE_BACKLINK_CONTRACT_VERSION = 'explainer-kit.source-backlinks/v1';
|
|
6
|
+
let cachedBacklinks;
|
|
7
|
+
export function loadExplainerSourceBacklinks() {
|
|
8
|
+
cachedBacklinks ??= loadGeneratedBacklinks();
|
|
9
|
+
return cachedBacklinks;
|
|
10
|
+
}
|
|
11
|
+
async function loadGeneratedBacklinks() {
|
|
12
|
+
const assetsRoot = await resolveAssetsRoot();
|
|
13
|
+
const modulePath = join(assetsRoot, 'skills', 'explainer-kit', 'scripts', 'lib', 'source-backlinks.mjs');
|
|
14
|
+
let loaded;
|
|
15
|
+
try {
|
|
16
|
+
loaded = (await import(pathToFileURL(modulePath).href));
|
|
17
|
+
}
|
|
18
|
+
catch (error) {
|
|
19
|
+
throw new CliError(`Bundled explainer source backlink contract could not be loaded: ${error instanceof Error ? error.message : String(error)}`, 2);
|
|
20
|
+
}
|
|
21
|
+
if (loaded.SOURCE_BACKLINK_CONTRACT_VERSION !==
|
|
22
|
+
SOURCE_BACKLINK_CONTRACT_VERSION ||
|
|
23
|
+
typeof loaded.parseCanonicalGithubBlobUrl !== 'function') {
|
|
24
|
+
throw new CliError(`Bundled assets must provide ${SOURCE_BACKLINK_CONTRACT_VERSION}.`, 2);
|
|
25
|
+
}
|
|
26
|
+
return loaded;
|
|
27
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { buildCommandContext, type CommandContext } from '../../../app/command-context.js';
|
|
2
2
|
import { type OatConfig, type OatLocalConfig } from '../../../config/oat-config.js';
|
|
3
|
-
import { resolveArchiveProjectTarget, resolvePrimaryRepoRoot, type ArchiveProjectOnCompletionOptions, type ArchiveProjectOnCompletionResult } from './archive-utils.js';
|
|
3
|
+
import { resolveArchiveProjectTarget, resolvePrimaryRepoRoot, verifySelectedProjectRecapForArchive, type ArchiveProjectOnCompletionOptions, type ArchiveProjectOnCompletionResult } from './archive-utils.js';
|
|
4
4
|
export interface ArchivePushOptions {
|
|
5
5
|
dryRun?: boolean;
|
|
6
6
|
projectRecapRun?: string;
|
|
@@ -13,6 +13,7 @@ export interface ProjectArchivePushCommandDependencies {
|
|
|
13
13
|
resolveProjectsRoot: (repoRoot: string, env: NodeJS.ProcessEnv) => Promise<string>;
|
|
14
14
|
resolvePrimaryRepoRoot: typeof resolvePrimaryRepoRoot;
|
|
15
15
|
resolveArchiveProjectTarget: typeof resolveArchiveProjectTarget;
|
|
16
|
+
verifySelectedProjectRecapForArchive: typeof verifySelectedProjectRecapForArchive;
|
|
16
17
|
archiveProjectOnCompletion: (options: ArchiveProjectOnCompletionOptions) => Promise<ArchiveProjectOnCompletionResult>;
|
|
17
18
|
processEnv: NodeJS.ProcessEnv;
|
|
18
19
|
timestamp: () => string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"push-runner.d.ts","sourceRoot":"","sources":["../../../../src/commands/project/archive/push-runner.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,KAAK,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEhF,OAAO,EAGL,KAAK,SAAS,EACd,KAAK,cAAc,EACpB,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAKL,2BAA2B,EAC3B,sBAAsB,
|
|
1
|
+
{"version":3,"file":"push-runner.d.ts","sourceRoot":"","sources":["../../../../src/commands/project/archive/push-runner.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,KAAK,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEhF,OAAO,EAGL,KAAK,SAAS,EACd,KAAK,cAAc,EACpB,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAKL,2BAA2B,EAC3B,sBAAsB,EACtB,oCAAoC,EAEpC,KAAK,iCAAiC,EACtC,KAAK,gCAAgC,EAEtC,MAAM,iBAAiB,CAAC;AAEzB,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,qCAAqC;IACpD,mBAAmB,EAAE,CACnB,OAAO,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC,CAAC,KAC/C,cAAc,CAAC;IACpB,kBAAkB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD,aAAa,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IACxD,kBAAkB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAClE,mBAAmB,EAAE,CACnB,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,CAAC,UAAU,KACnB,OAAO,CAAC,MAAM,CAAC,CAAC;IACrB,sBAAsB,EAAE,OAAO,sBAAsB,CAAC;IACtD,2BAA2B,EAAE,OAAO,2BAA2B,CAAC;IAChE,oCAAoC,EAAE,OAAO,oCAAoC,CAAC;IAClF,0BAA0B,EAAE,CAC1B,OAAO,EAAE,iCAAiC,KACvC,OAAO,CAAC,gCAAgC,CAAC,CAAC;IAC/C,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;IAC9B,SAAS,EAAE,MAAM,MAAM,CAAC;CACzB;AAmBD,wBAAgB,4CAA4C,IAAI,qCAAqC,CAcpG;AAkJD,wBAAsB,qBAAqB,CACzC,YAAY,EAAE,qCAAqC,EACnD,cAAc,EAAE,MAAM,GAAG,SAAS,EAClC,OAAO,EAAE,kBAAkB,EAC3B,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,IAAI,CAAC,CA0Ef"}
|
|
@@ -4,7 +4,7 @@ import { resolveProjectsRoot } from '../../shared/oat-paths.js';
|
|
|
4
4
|
import { readOatConfig, readOatLocalConfig, } from '../../../config/oat-config.js';
|
|
5
5
|
import { CliError } from '../../../errors/cli-error.js';
|
|
6
6
|
import { resolveProjectRoot } from '../../../fs/paths.js';
|
|
7
|
-
import { archiveProjectOnCompletion, assertDurableArchiveProjectTarget, buildArchiveSnapshotName, buildProjectArchiveS3Uri, resolveArchiveProjectTarget, resolvePrimaryRepoRoot, } from './archive-utils.js';
|
|
7
|
+
import { archiveProjectOnCompletion, assertDurableArchiveProjectTarget, buildArchiveSnapshotName, buildProjectArchiveS3Uri, resolveArchiveProjectTarget, resolvePrimaryRepoRoot, verifySelectedProjectRecapForArchive, } from './archive-utils.js';
|
|
8
8
|
export function defaultProjectArchivePushCommandDependencies() {
|
|
9
9
|
return {
|
|
10
10
|
buildCommandContext,
|
|
@@ -14,6 +14,7 @@ export function defaultProjectArchivePushCommandDependencies() {
|
|
|
14
14
|
resolveProjectsRoot,
|
|
15
15
|
resolvePrimaryRepoRoot,
|
|
16
16
|
resolveArchiveProjectTarget,
|
|
17
|
+
verifySelectedProjectRecapForArchive,
|
|
17
18
|
archiveProjectOnCompletion,
|
|
18
19
|
processEnv: process.env,
|
|
19
20
|
timestamp: () => new Date().toISOString(),
|
|
@@ -121,6 +122,9 @@ export async function runArchivePushCommand(dependencies, projectPathArg, option
|
|
|
121
122
|
timestamp: dependencies.timestamp,
|
|
122
123
|
});
|
|
123
124
|
assertDurableArchiveProjectTarget(archiveTarget);
|
|
125
|
+
if (options.projectRecapRun?.trim()) {
|
|
126
|
+
await dependencies.verifySelectedProjectRecapForArchive(target.projectPath, options.projectRecapRun.trim());
|
|
127
|
+
}
|
|
124
128
|
const dryRun = options.dryRun === true || context.dryRun;
|
|
125
129
|
if (dryRun) {
|
|
126
130
|
const report = await buildDryRunReport(dependencies, repoRoot, config, target, archiveTarget);
|
|
@@ -4,14 +4,20 @@ export interface PublicPackageContract {
|
|
|
4
4
|
role: 'cli' | 'docs-library' | 'support-library';
|
|
5
5
|
requiredMetadataFields: string[];
|
|
6
6
|
requiredPaths: string[];
|
|
7
|
+
requiredPackedTextFiles: PackedTextFileRequirement[];
|
|
7
8
|
forbiddenPathPatterns: string[];
|
|
8
9
|
versionPolicyAdditionalRoots: string[];
|
|
9
10
|
versionPolicyIgnorePatterns: string[];
|
|
10
11
|
}
|
|
12
|
+
export interface PackedTextFileRequirement {
|
|
13
|
+
path: string;
|
|
14
|
+
requiredContents: string[];
|
|
15
|
+
}
|
|
11
16
|
export declare function getPublicPackageContracts(): PublicPackageContract[];
|
|
12
17
|
export declare function findMissingMetadataFields(packageJson: Record<string, unknown>, contract: PublicPackageContract): string[];
|
|
13
18
|
export declare function findMissingPackedPaths(packedPaths: readonly string[], contract: PublicPackageContract): string[];
|
|
14
19
|
export declare function findForbiddenPackedPaths(packedPaths: readonly string[], contract: PublicPackageContract): string[];
|
|
20
|
+
export declare function findMissingPackedTextContents(packedTextFiles: Readonly<Record<string, string>>, contract: PublicPackageContract): string[];
|
|
15
21
|
export declare function findWorkspaceProtocolDependencySpecs(packageJson: Record<string, unknown>): string[];
|
|
16
22
|
export declare function findNonPublicWorkspaceDependencySpecs(packageJson: Record<string, unknown>, publicPackageNames: readonly string[], workspacePackageNames: readonly string[]): string[];
|
|
17
23
|
//# sourceMappingURL=public-package-contract.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"public-package-contract.d.ts","sourceRoot":"","sources":["../../src/release/public-package-contract.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,qBAAqB;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,KAAK,GAAG,cAAc,GAAG,iBAAiB,CAAC;IACjD,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,4BAA4B,EAAE,MAAM,EAAE,CAAC;IACvC,2BAA2B,EAAE,MAAM,EAAE,CAAC;CACvC;
|
|
1
|
+
{"version":3,"file":"public-package-contract.d.ts","sourceRoot":"","sources":["../../src/release/public-package-contract.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,qBAAqB;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,KAAK,GAAG,cAAc,GAAG,iBAAiB,CAAC;IACjD,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,uBAAuB,EAAE,yBAAyB,EAAE,CAAC;IACrD,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,4BAA4B,EAAE,MAAM,EAAE,CAAC;IACvC,2BAA2B,EAAE,MAAM,EAAE,CAAC;CACvC;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC5B;AA2KD,wBAAgB,yBAAyB,IAAI,qBAAqB,EAAE,CAenE;AAED,wBAAgB,yBAAyB,CACvC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,QAAQ,EAAE,qBAAqB,GAC9B,MAAM,EAAE,CAIV;AAED,wBAAgB,sBAAsB,CACpC,WAAW,EAAE,SAAS,MAAM,EAAE,EAC9B,QAAQ,EAAE,qBAAqB,GAC9B,MAAM,EAAE,CAIV;AAED,wBAAgB,wBAAwB,CACtC,WAAW,EAAE,SAAS,MAAM,EAAE,EAC9B,QAAQ,EAAE,qBAAqB,GAC9B,MAAM,EAAE,CAMV;AAED,wBAAgB,6BAA6B,CAC3C,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EACjD,QAAQ,EAAE,qBAAqB,GAC9B,MAAM,EAAE,CAoBV;AAED,wBAAgB,oCAAoC,CAClD,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACnC,MAAM,EAAE,CAmBV;AAED,wBAAgB,qCAAqC,CACnD,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,kBAAkB,EAAE,SAAS,MAAM,EAAE,EACrC,qBAAqB,EAAE,SAAS,MAAM,EAAE,GACvC,MAAM,EAAE,CA0BV"}
|
|
@@ -18,6 +18,23 @@ const PACKED_DEPENDENCY_FIELDS = [
|
|
|
18
18
|
'optionalDependencies',
|
|
19
19
|
'peerDependencies',
|
|
20
20
|
];
|
|
21
|
+
const MIT_LICENSE_BODY = `Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
22
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
23
|
+
in the Software without restriction, including without limitation the rights
|
|
24
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
25
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
26
|
+
furnished to do so, subject to the following conditions:
|
|
27
|
+
|
|
28
|
+
The above copyright notice and this permission notice shall be included in all
|
|
29
|
+
copies or substantial portions of the Software.
|
|
30
|
+
|
|
31
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
32
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
33
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
34
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
35
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
36
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
37
|
+
SOFTWARE.`;
|
|
21
38
|
const PUBLIC_PACKAGE_CONTRACTS = [
|
|
22
39
|
{
|
|
23
40
|
workspaceDir: 'packages/cli',
|
|
@@ -32,8 +49,42 @@ const PUBLIC_PACKAGE_CONTRACTS = [
|
|
|
32
49
|
'assets/templates/repo-agents.md',
|
|
33
50
|
'assets/templates/pjm-agents.md',
|
|
34
51
|
'assets/templates/reference-agents.md',
|
|
52
|
+
'assets/skills/explainer-kit/scripts/lib/package-coverage.mjs',
|
|
53
|
+
'assets/skills/explainer-kit/scripts/lib/source-backlinks.mjs',
|
|
54
|
+
'assets/NOTICES.md',
|
|
35
55
|
'README.md',
|
|
36
56
|
],
|
|
57
|
+
requiredPackedTextFiles: [
|
|
58
|
+
{
|
|
59
|
+
path: 'assets/NOTICES.md',
|
|
60
|
+
requiredContents: [
|
|
61
|
+
'**Source:** https://github.com/obra/superpowers',
|
|
62
|
+
'**Version referenced:** 5.0.7',
|
|
63
|
+
`Copyright (c) 2025 Jesse Vincent\n\n${MIT_LICENSE_BODY}`,
|
|
64
|
+
'**Source:** https://github.com/shadcn/improve/tree/main/skills/improve',
|
|
65
|
+
'**Version referenced:** `main` (retrieved 2026-07-12)',
|
|
66
|
+
`Copyright (c) 2026 shadcn\n\n${MIT_LICENSE_BODY}`,
|
|
67
|
+
'**Source:** https://github.com/nicobailon/visual-explainer',
|
|
68
|
+
'**Version referenced:** 0.8.1',
|
|
69
|
+
`Copyright (c) 2025 Nico Bailon\n\n${MIT_LICENSE_BODY}`,
|
|
70
|
+
],
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
path: 'assets/skills/explainer-kit/scripts/lib/package-coverage.mjs',
|
|
74
|
+
requiredContents: [
|
|
75
|
+
'explainer-kit.package-coverage/v2',
|
|
76
|
+
'export function requiredImmutablePackagePaths',
|
|
77
|
+
'export async function validateImmutablePackageEvidence',
|
|
78
|
+
],
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
path: 'assets/skills/explainer-kit/scripts/lib/source-backlinks.mjs',
|
|
82
|
+
requiredContents: [
|
|
83
|
+
'explainer-kit.source-backlinks/v1',
|
|
84
|
+
'export function parseCanonicalGithubBlobUrl',
|
|
85
|
+
],
|
|
86
|
+
},
|
|
87
|
+
],
|
|
37
88
|
forbiddenPathPatterns: [...COMMON_FORBIDDEN_PATH_PATTERNS],
|
|
38
89
|
versionPolicyAdditionalRoots: [
|
|
39
90
|
'.agents/skills',
|
|
@@ -50,6 +101,7 @@ const PUBLIC_PACKAGE_CONTRACTS = [
|
|
|
50
101
|
role: 'support-library',
|
|
51
102
|
requiredMetadataFields: [...COMMON_METADATA_FIELDS, 'exports', 'types'],
|
|
52
103
|
requiredPaths: ['dist/index.js', 'dist/index.d.ts', 'README.md'],
|
|
104
|
+
requiredPackedTextFiles: [],
|
|
53
105
|
forbiddenPathPatterns: [...COMMON_FORBIDDEN_PATH_PATTERNS],
|
|
54
106
|
versionPolicyAdditionalRoots: [],
|
|
55
107
|
versionPolicyIgnorePatterns: [],
|
|
@@ -60,6 +112,7 @@ const PUBLIC_PACKAGE_CONTRACTS = [
|
|
|
60
112
|
role: 'docs-library',
|
|
61
113
|
requiredMetadataFields: [...COMMON_METADATA_FIELDS, 'exports', 'types'],
|
|
62
114
|
requiredPaths: ['dist/index.js', 'dist/index.d.ts', 'README.md'],
|
|
115
|
+
requiredPackedTextFiles: [],
|
|
63
116
|
forbiddenPathPatterns: [...COMMON_FORBIDDEN_PATH_PATTERNS],
|
|
64
117
|
versionPolicyAdditionalRoots: [],
|
|
65
118
|
versionPolicyIgnorePatterns: [],
|
|
@@ -70,6 +123,7 @@ const PUBLIC_PACKAGE_CONTRACTS = [
|
|
|
70
123
|
role: 'docs-library',
|
|
71
124
|
requiredMetadataFields: [...COMMON_METADATA_FIELDS, 'exports', 'types'],
|
|
72
125
|
requiredPaths: ['dist/index.js', 'dist/index.d.ts', 'README.md'],
|
|
126
|
+
requiredPackedTextFiles: [],
|
|
73
127
|
forbiddenPathPatterns: [...COMMON_FORBIDDEN_PATH_PATTERNS],
|
|
74
128
|
versionPolicyAdditionalRoots: [],
|
|
75
129
|
versionPolicyIgnorePatterns: [],
|
|
@@ -80,6 +134,7 @@ const PUBLIC_PACKAGE_CONTRACTS = [
|
|
|
80
134
|
role: 'docs-library',
|
|
81
135
|
requiredMetadataFields: [...COMMON_METADATA_FIELDS, 'exports', 'types'],
|
|
82
136
|
requiredPaths: ['dist/index.js', 'dist/index.d.ts', 'README.md'],
|
|
137
|
+
requiredPackedTextFiles: [],
|
|
83
138
|
forbiddenPathPatterns: [...COMMON_FORBIDDEN_PATH_PATTERNS],
|
|
84
139
|
versionPolicyAdditionalRoots: [],
|
|
85
140
|
versionPolicyIgnorePatterns: [],
|
|
@@ -101,6 +156,10 @@ export function getPublicPackageContracts() {
|
|
|
101
156
|
...contract,
|
|
102
157
|
requiredMetadataFields: [...contract.requiredMetadataFields],
|
|
103
158
|
requiredPaths: [...contract.requiredPaths],
|
|
159
|
+
requiredPackedTextFiles: contract.requiredPackedTextFiles.map((requirement) => ({
|
|
160
|
+
...requirement,
|
|
161
|
+
requiredContents: [...requirement.requiredContents],
|
|
162
|
+
})),
|
|
104
163
|
forbiddenPathPatterns: [...contract.forbiddenPathPatterns],
|
|
105
164
|
versionPolicyAdditionalRoots: [...contract.versionPolicyAdditionalRoots],
|
|
106
165
|
versionPolicyIgnorePatterns: [...contract.versionPolicyIgnorePatterns],
|
|
@@ -115,6 +174,22 @@ export function findMissingPackedPaths(packedPaths, contract) {
|
|
|
115
174
|
export function findForbiddenPackedPaths(packedPaths, contract) {
|
|
116
175
|
return packedPaths.filter((packedPath) => contract.forbiddenPathPatterns.some((pattern) => matchesGlob(packedPath, pattern)));
|
|
117
176
|
}
|
|
177
|
+
export function findMissingPackedTextContents(packedTextFiles, contract) {
|
|
178
|
+
const missing = [];
|
|
179
|
+
for (const requirement of contract.requiredPackedTextFiles) {
|
|
180
|
+
const contents = packedTextFiles[requirement.path];
|
|
181
|
+
if (contents === undefined) {
|
|
182
|
+
missing.push(`${requirement.path} (missing file)`);
|
|
183
|
+
continue;
|
|
184
|
+
}
|
|
185
|
+
for (const requiredContent of requirement.requiredContents) {
|
|
186
|
+
if (!contents.includes(requiredContent)) {
|
|
187
|
+
missing.push(`${requirement.path} (missing ${requiredContent.split('\n')[0]})`);
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
return missing;
|
|
192
|
+
}
|
|
118
193
|
export function findWorkspaceProtocolDependencySpecs(packageJson) {
|
|
119
194
|
const workspaceSpecs = [];
|
|
120
195
|
for (const dependencyField of PACKED_DEPENDENCY_FIELDS) {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-agent-toolkit/cli",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.27",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Open Agent Toolkit CLI",
|
|
6
6
|
"homepage": "https://github.com/voxmedia/open-agent-toolkit/tree/main/packages/cli",
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"ora": "^9.0.0",
|
|
35
35
|
"yaml": "2.8.2",
|
|
36
36
|
"zod": "^3.25.76",
|
|
37
|
-
"@open-agent-toolkit/control-plane": "0.2.
|
|
37
|
+
"@open-agent-toolkit/control-plane": "0.2.27"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
40
|
"@types/node": "^22.10.0",
|