saturndocs 0.1.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/LICENSE +21 -0
- package/dist/auth-FRCFGNYT.js +14 -0
- package/dist/brokenLinks-TTOBP4P7.js +48 -0
- package/dist/build-F5PWGP57.js +39 -0
- package/dist/chunk-3P2OFTXR.js +71 -0
- package/dist/chunk-3V753MRI.js +100 -0
- package/dist/chunk-5KX4ZK5E.js +104 -0
- package/dist/chunk-CMNX5DLQ.js +119 -0
- package/dist/chunk-GYRVGWDM.js +3499 -0
- package/dist/chunk-I6U4V7B4.js +1552 -0
- package/dist/chunk-J6P3VGGE.js +21 -0
- package/dist/chunk-KGJESHJC.js +37 -0
- package/dist/chunk-M2BZEDAS.js +57 -0
- package/dist/chunk-N7QPZMLP.js +82 -0
- package/dist/chunk-OEAEX5YW.js +51 -0
- package/dist/chunk-OZWTXMO3.js +584 -0
- package/dist/chunk-QLFODLVN.js +46 -0
- package/dist/chunk-R3X2DPFF.js +568 -0
- package/dist/chunk-S45UWCML.js +588 -0
- package/dist/chunk-SABK3R2P.js +2452 -0
- package/dist/chunk-STCCGFKC.js +246 -0
- package/dist/chunk-TKISMN3P.js +39 -0
- package/dist/chunk-U7PKMSB3.js +465 -0
- package/dist/chunk-VNYDYHXM.js +22 -0
- package/dist/chunk-VXEUNRVA.js +26 -0
- package/dist/chunk-XO4CUC7V.js +99 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.js +95 -0
- package/dist/deploy-QU7DCKWU.js +11 -0
- package/dist/dev-VDSDCBO2.js +43 -0
- package/dist/index.d.ts +382 -0
- package/dist/index.js +191 -0
- package/dist/init-7T5TEPBH.js +14 -0
- package/dist/manage-MKH27U3B.js +12 -0
- package/dist/openapiCheck-KGBQJTIQ.js +66 -0
- package/dist/pages-HIPXRLSY.js +15 -0
- package/dist/read-DMSJUEDA.js +160 -0
- package/dist/read-ZEVUZNNB.js +146 -0
- package/dist/requests-H5MIGBIS.js +13 -0
- package/dist/schema-XJUEZSIW.js +13 -0
- package/dist/sites-I4WI2MPG.js +14 -0
- package/dist/status-7R3NOI5H.js +14 -0
- package/dist/suggestions-4WFQ3APX.js +739 -0
- package/dist/validate-VXL4PL42.js +30 -0
- package/package.json +68 -0
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import {
|
|
2
|
+
validateDocs
|
|
3
|
+
} from "./chunk-OZWTXMO3.js";
|
|
4
|
+
import "./chunk-S45UWCML.js";
|
|
5
|
+
import "./chunk-R3X2DPFF.js";
|
|
6
|
+
import {
|
|
7
|
+
resolveDocsDir
|
|
8
|
+
} from "./chunk-VNYDYHXM.js";
|
|
9
|
+
|
|
10
|
+
// src/commands/validate.ts
|
|
11
|
+
import pc from "picocolors";
|
|
12
|
+
function registerValidate(program) {
|
|
13
|
+
program.command("validate").description("Validate docs.json, models.toml, page files, and OpenAPI specs").argument("[dir]", "docs directory (contains docs.json)").action(async (dir) => {
|
|
14
|
+
const docsDir = resolveDocsDir(dir);
|
|
15
|
+
const errors = await validateDocs(docsDir);
|
|
16
|
+
if (errors.length > 0) {
|
|
17
|
+
console.error(
|
|
18
|
+
pc.red(`\u2716 ${errors.length} validation error(s) in ${docsDir}:`)
|
|
19
|
+
);
|
|
20
|
+
for (const error of errors) {
|
|
21
|
+
console.error(pc.red(` - ${error}`));
|
|
22
|
+
}
|
|
23
|
+
process.exit(1);
|
|
24
|
+
}
|
|
25
|
+
console.log(pc.green(`\u2713 ${docsDir} is valid.`));
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
export {
|
|
29
|
+
registerValidate
|
|
30
|
+
};
|
package/package.json
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "saturndocs",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Command-line client for SaturnDocs sites: inspect, request, clarify, review suggestions, and verify releases, plus local init, validate, dev, build, and deploy",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"saturndocs",
|
|
7
|
+
"documentation",
|
|
8
|
+
"docs",
|
|
9
|
+
"cli",
|
|
10
|
+
"agent"
|
|
11
|
+
],
|
|
12
|
+
"homepage": "https://saturndocs.com",
|
|
13
|
+
"repository": {
|
|
14
|
+
"type": "git",
|
|
15
|
+
"url": "git+https://github.com/SaturnDocs/saturndocs-platform.git",
|
|
16
|
+
"directory": "packages/cli"
|
|
17
|
+
},
|
|
18
|
+
"license": "MIT",
|
|
19
|
+
"type": "module",
|
|
20
|
+
"engines": {
|
|
21
|
+
"node": ">=22 <23"
|
|
22
|
+
},
|
|
23
|
+
"bin": {
|
|
24
|
+
"saturndocs": "./dist/cli.js"
|
|
25
|
+
},
|
|
26
|
+
"exports": {
|
|
27
|
+
".": {
|
|
28
|
+
"types": "./dist/index.d.ts",
|
|
29
|
+
"import": "./dist/index.js"
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
"files": [
|
|
33
|
+
"dist"
|
|
34
|
+
],
|
|
35
|
+
"dependencies": {
|
|
36
|
+
"commander": "^15.0.0",
|
|
37
|
+
"execa": "^9.6.1",
|
|
38
|
+
"fast-glob": "^3.3.3",
|
|
39
|
+
"github-slugger": "^2.0.0",
|
|
40
|
+
"mdast-util-to-string": "^4.0.0",
|
|
41
|
+
"picocolors": "^1.1.1",
|
|
42
|
+
"remark-frontmatter": "^5.0.0",
|
|
43
|
+
"remark-gfm": "^4.0.1",
|
|
44
|
+
"remark-mdx": "^3.1.1",
|
|
45
|
+
"remark-parse": "^11.0.0",
|
|
46
|
+
"smol-toml": "^1.7.0",
|
|
47
|
+
"unified": "^11.0.5",
|
|
48
|
+
"unist-util-visit": "^5.1.0",
|
|
49
|
+
"yaml": "^2.9.0",
|
|
50
|
+
"zod": "^4.4.3"
|
|
51
|
+
},
|
|
52
|
+
"devDependencies": {
|
|
53
|
+
"tsup": "^8.5.1",
|
|
54
|
+
"typescript": "^6.0.3",
|
|
55
|
+
"vitest": "^4.1.9",
|
|
56
|
+
"@saturndocs/brand": "^0.1.0",
|
|
57
|
+
"@saturndocs/config": "^0.1.0",
|
|
58
|
+
"@saturndocs/management-client": "^0.1.0",
|
|
59
|
+
"@saturndocs/mdx-preprocess": "^0.1.0",
|
|
60
|
+
"@saturndocs/openapi": "^0.1.0",
|
|
61
|
+
"@saturndocs/source-abi": "^0.2.0"
|
|
62
|
+
},
|
|
63
|
+
"scripts": {
|
|
64
|
+
"build": "tsup",
|
|
65
|
+
"test": "vitest run",
|
|
66
|
+
"test:npm": "bash ../../scripts/cli/test-npm.sh"
|
|
67
|
+
}
|
|
68
|
+
}
|