create-thally-docs 0.8.0 → 0.9.0
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/README.md +11 -4
- package/dist/{chunk-5GIGIHI5.js → chunk-BW7J7DJV.js} +259 -334
- package/dist/chunk-JNDRCCJV.js +232 -0
- package/dist/chunk-PJW4JJIT.js +31 -0
- package/dist/{chunk-PZBQS5ZR.js → chunk-YWNWLSZ2.js} +1 -1
- package/dist/customize.d.ts +93 -0
- package/dist/customize.js +37 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +90 -19
- package/dist/migrate/index.d.ts +35 -0
- package/dist/migrate/index.js +4 -2
- package/dist/release.d.ts +58 -0
- package/dist/release.js +9 -0
- package/dist/scaffold.d.ts +38 -0
- package/dist/scaffold.js +16 -3
- package/package.json +11 -4
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Immutable source and runtime identity for every newly scaffolded Thally site.
|
|
3
|
+
*
|
|
4
|
+
* A release is promoted only after the source snapshot and its compiled runtime
|
|
5
|
+
* have passed the scaffold, build, and identity-safety gates. Consumers must
|
|
6
|
+
* use the whole record: independently resolving "latest template" and "latest
|
|
7
|
+
* runtime" recreates the drift this contract exists to prevent.
|
|
8
|
+
*/
|
|
9
|
+
interface ScaffoldSourceRelease {
|
|
10
|
+
repository: string;
|
|
11
|
+
commitSha: string;
|
|
12
|
+
treeSha: string;
|
|
13
|
+
archiveUrl: string;
|
|
14
|
+
}
|
|
15
|
+
interface ScaffoldRuntimeRelease {
|
|
16
|
+
repository: string;
|
|
17
|
+
commitSha: string;
|
|
18
|
+
treeSha: string;
|
|
19
|
+
contentSource: 'assets';
|
|
20
|
+
identityContractVersion: number;
|
|
21
|
+
}
|
|
22
|
+
interface ScaffoldRelease {
|
|
23
|
+
schemaVersion: 1;
|
|
24
|
+
id: string;
|
|
25
|
+
source: ScaffoldSourceRelease;
|
|
26
|
+
runtime: ScaffoldRuntimeRelease;
|
|
27
|
+
starterVersion: number;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Current stable scaffold release.
|
|
31
|
+
*
|
|
32
|
+
* The source commit is the refreshed public docs template and the runtime
|
|
33
|
+
* commit is the matching engine change. `create-thally-docs`, the CLI, MCP,
|
|
34
|
+
* and Thally Cloud all import this exact record rather than following a moving
|
|
35
|
+
* branch independently.
|
|
36
|
+
*/
|
|
37
|
+
declare const STABLE_SCAFFOLD_RELEASE: {
|
|
38
|
+
readonly schemaVersion: 1;
|
|
39
|
+
readonly id: "2026-08-04.b0094de4.e36d2bcf";
|
|
40
|
+
readonly source: {
|
|
41
|
+
readonly repository: "thallylabs/docs";
|
|
42
|
+
readonly commitSha: "b0094de4fea84567eb12c39c6783fdae6820bb98";
|
|
43
|
+
readonly treeSha: "ffd0a6fda07341ddd1ba164cb40acef796f89e2d";
|
|
44
|
+
readonly archiveUrl: "https://codeload.github.com/thallylabs/docs/tar.gz/b0094de4fea84567eb12c39c6783fdae6820bb98";
|
|
45
|
+
};
|
|
46
|
+
readonly runtime: {
|
|
47
|
+
readonly repository: "thallylabs/thally";
|
|
48
|
+
readonly commitSha: "e36d2bcff38f7638a77369e12773a7cab4d5d9ce";
|
|
49
|
+
readonly treeSha: "1c8b0358d78d8caa14ed039bff6ab47c98b685d8";
|
|
50
|
+
readonly contentSource: "assets";
|
|
51
|
+
readonly identityContractVersion: 1;
|
|
52
|
+
};
|
|
53
|
+
readonly starterVersion: 1;
|
|
54
|
+
};
|
|
55
|
+
/** True only when an unknown record is the currently supported release. */
|
|
56
|
+
declare function isStableScaffoldRelease(value: unknown): value is ScaffoldRelease;
|
|
57
|
+
|
|
58
|
+
export { STABLE_SCAFFOLD_RELEASE, type ScaffoldRelease, type ScaffoldRuntimeRelease, type ScaffoldSourceRelease, isStableScaffoldRelease };
|
package/dist/release.js
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
export { STABLE_SCAFFOLD_RELEASE } from './release.js';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* The live Thally documentation site is also the canonical standalone site
|
|
5
|
+
* source. Keeping one source means a runtime or UI improvement shipped to the
|
|
6
|
+
* docs is available to every subsequent scaffold without maintaining a second
|
|
7
|
+
* template repository.
|
|
8
|
+
*/
|
|
9
|
+
declare const TEMPLATE_REPOSITORY: "thallylabs/docs";
|
|
10
|
+
declare const TEMPLATE_COMMIT_SHA: "b0094de4fea84567eb12c39c6783fdae6820bb98";
|
|
11
|
+
declare const EXCLUDE_PATHS: string[];
|
|
12
|
+
/** True if a tarball entry should land in the scaffold (see EXCLUDE_PATHS). */
|
|
13
|
+
declare function shouldInclude(path: string): boolean;
|
|
14
|
+
|
|
15
|
+
interface ScaffoldOptions {
|
|
16
|
+
projectDir: string;
|
|
17
|
+
projectName: string;
|
|
18
|
+
description: string;
|
|
19
|
+
brandPreset: string;
|
|
20
|
+
repoUrl: string;
|
|
21
|
+
doInstall: boolean;
|
|
22
|
+
enableAiChat?: boolean;
|
|
23
|
+
i18nLocales?: Array<{
|
|
24
|
+
code: string;
|
|
25
|
+
label: string;
|
|
26
|
+
}>;
|
|
27
|
+
/** Repos to pre-register for Thally Track (opt-in). Empty/undefined = Track off. */
|
|
28
|
+
trackRepos?: Array<{
|
|
29
|
+
owner: string;
|
|
30
|
+
repo: string;
|
|
31
|
+
}>;
|
|
32
|
+
}
|
|
33
|
+
interface ScaffoldResult {
|
|
34
|
+
projectDir: string;
|
|
35
|
+
}
|
|
36
|
+
declare function scaffold(options: ScaffoldOptions): Promise<ScaffoldResult>;
|
|
37
|
+
|
|
38
|
+
export { EXCLUDE_PATHS, type ScaffoldOptions, type ScaffoldResult, TEMPLATE_COMMIT_SHA, TEMPLATE_REPOSITORY, scaffold, shouldInclude };
|
package/dist/scaffold.js
CHANGED
|
@@ -1,7 +1,20 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
import {
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
EXCLUDE_PATHS,
|
|
4
|
+
TEMPLATE_COMMIT_SHA,
|
|
5
|
+
TEMPLATE_REPOSITORY,
|
|
6
|
+
scaffold,
|
|
7
|
+
shouldInclude
|
|
8
|
+
} from "./chunk-JNDRCCJV.js";
|
|
9
|
+
import "./chunk-BW7J7DJV.js";
|
|
10
|
+
import {
|
|
11
|
+
STABLE_SCAFFOLD_RELEASE
|
|
12
|
+
} from "./chunk-PJW4JJIT.js";
|
|
5
13
|
export {
|
|
6
|
-
|
|
14
|
+
EXCLUDE_PATHS,
|
|
15
|
+
STABLE_SCAFFOLD_RELEASE,
|
|
16
|
+
TEMPLATE_COMMIT_SHA,
|
|
17
|
+
TEMPLATE_REPOSITORY,
|
|
18
|
+
scaffold,
|
|
19
|
+
shouldInclude
|
|
7
20
|
};
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-thally-docs",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "Scaffold a
|
|
3
|
+
"version": "0.9.0",
|
|
4
|
+
"description": "Scaffold the first documentation surface in a Thally product-knowledge pipeline.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"engines": {
|
|
7
7
|
"node": ">=18"
|
|
@@ -12,6 +12,14 @@
|
|
|
12
12
|
"exports": {
|
|
13
13
|
".": "./dist/index.js",
|
|
14
14
|
"./scaffold": "./dist/scaffold.js",
|
|
15
|
+
"./starter": {
|
|
16
|
+
"types": "./dist/customize.d.ts",
|
|
17
|
+
"import": "./dist/customize.js"
|
|
18
|
+
},
|
|
19
|
+
"./release": {
|
|
20
|
+
"types": "./dist/release.d.ts",
|
|
21
|
+
"import": "./dist/release.js"
|
|
22
|
+
},
|
|
15
23
|
"./migrate": "./dist/migrate/index.js",
|
|
16
24
|
"./package.json": "./package.json"
|
|
17
25
|
},
|
|
@@ -31,12 +39,11 @@
|
|
|
31
39
|
"@thallylabs/migrate": "0.2.0",
|
|
32
40
|
"gray-matter": "^4.0.3",
|
|
33
41
|
"p-limit": "^6.1.0",
|
|
34
|
-
"tar": "^
|
|
42
|
+
"tar": "^7.5.22",
|
|
35
43
|
"yaml": "^2.6.0"
|
|
36
44
|
},
|
|
37
45
|
"devDependencies": {
|
|
38
46
|
"@types/node": "^22.0.0",
|
|
39
|
-
"@types/tar": "^6.1.13",
|
|
40
47
|
"tsup": "^8.0.0",
|
|
41
48
|
"typescript": "^5.0.0"
|
|
42
49
|
},
|