@farming-labs/docs 0.1.125 → 0.1.128
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/dist/{agent-CBhuGaVu.mjs → agent-CJNYhzu7.mjs} +4 -4
- package/dist/{agents-BPX4YRPs.mjs → agents-BuL01_U0.mjs} +2 -2
- package/dist/cli/index.mjs +52 -19
- package/dist/cloud-88xTLXn3.mjs +529 -0
- package/dist/{codeblocks-B4QzFqNC.mjs → codeblocks-DbJrclYa.mjs} +1 -1
- package/dist/{config-B8wA38OC.mjs → config-CBoixmrv.mjs} +9 -1
- package/dist/{dev-1VFeAWUi.mjs → dev-DdlhqXNU.mjs} +7 -1
- package/dist/{doctor-lV9lhqGA.mjs → doctor-D_c7vJCb.mjs} +4 -4
- package/dist/{downgrade-BGANzvQb.mjs → downgrade-BayU3nlg.mjs} +1 -1
- package/dist/index.d.mts +3 -3
- package/dist/index.mjs +1 -1
- package/dist/{init-DzQWiVN1.mjs → init-BJqy-LK2.mjs} +1 -1
- package/dist/{mcp-BvERlrP_.mjs → mcp-CUAR3XfW.mjs} +2 -2
- package/dist/mcp.d.mts +1 -1
- package/dist/mcp.mjs +36 -0
- package/dist/{reading-time-HpTq-0VB.mjs → reading-time-DPAazAGu.mjs} +1 -0
- package/dist/{review-ClNDYRnn.mjs → review-CjyI-bVg.mjs} +1 -1
- package/dist/{robots-CNLiZCay.mjs → robots-Dx2uMF3g.mjs} +1 -1
- package/dist/{search-G0otDMfP.d.mts → search-CNoiftmI.d.mts} +1 -1
- package/dist/{search-BjyDm30M.mjs → search-Cekr2OyP.mjs} +2 -2
- package/dist/server.d.mts +13 -3
- package/dist/server.mjs +2 -2
- package/dist/{sitemap-BdSdcAmS.mjs → sitemap-BBfGr3tJ.mjs} +2 -2
- package/dist/{sitemap-server-BZHoJHqC.mjs → sitemap-server-idLUrmmU.mjs} +57 -1
- package/dist/{types-Dg82p0Fm.d.mts → types-C-C-9SMJ.d.mts} +65 -1
- package/dist/{upgrade-C7DvvfTR.mjs → upgrade-DDWolmHe.mjs} +1 -1
- package/package.json +1 -1
- /package/dist/{package-version-OrjpmqoR.mjs → package-version-CQm0KO-H.mjs} +0 -0
- /package/dist/{templates-CGaORZOY.mjs → templates-DomB3eeS.mjs} +0 -0
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import "./reading-time-
|
|
1
|
+
import "./reading-time-DPAazAGu.mjs";
|
|
2
2
|
import "./search-BL7o2rXk.mjs";
|
|
3
3
|
import "./agent-BS39vnhS.mjs";
|
|
4
4
|
import "./robots-B2BfoyVM.mjs";
|
|
5
|
-
import "./sitemap-server-
|
|
6
|
-
import "./config-
|
|
7
|
-
import { a as readPageTokenBudget, i as printAgentCompactHelp, n as inspectAgentCompactionState, o as scanDocsPageTargets, r as parseAgentCompactArgs, t as compactAgentDocs } from "./codeblocks-
|
|
5
|
+
import "./sitemap-server-idLUrmmU.mjs";
|
|
6
|
+
import "./config-CBoixmrv.mjs";
|
|
7
|
+
import { a as readPageTokenBudget, i as printAgentCompactHelp, n as inspectAgentCompactionState, o as scanDocsPageTargets, r as parseAgentCompactArgs, t as compactAgentDocs } from "./codeblocks-DbJrclYa.mjs";
|
|
8
8
|
|
|
9
9
|
export { compactAgentDocs, parseAgentCompactArgs, printAgentCompactHelp };
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import "./search-BL7o2rXk.mjs";
|
|
2
2
|
import { K as resolveDocsAgentFeedbackConfig, V as renderDocsAgentsDocument, a as DEFAULT_AGENT_MD_ROUTE, n as DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, o as DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, t as DEFAULT_AGENTS_MD_ROUTE, y as DEFAULT_OPENAPI_SCHEMA_ROUTE } from "./agent-BS39vnhS.mjs";
|
|
3
|
-
import { S as resolveApiReferenceConfig } from "./sitemap-server-
|
|
3
|
+
import { S as resolveApiReferenceConfig } from "./sitemap-server-idLUrmmU.mjs";
|
|
4
4
|
import { resolveDocsMcpConfig } from "./mcp.mjs";
|
|
5
5
|
import "./server.mjs";
|
|
6
|
-
import { c as readNavTitle,
|
|
6
|
+
import { c as readNavTitle, f as readTopLevelStringProperty, i as loadDocsConfigModule, o as readBooleanProperty, p as resolveDocsConfigPath, t as extractNestedObjectLiteral, u as readStringProperty } from "./config-CBoixmrv.mjs";
|
|
7
7
|
import { t as detectFramework } from "./utils-x5EtYWjC.mjs";
|
|
8
8
|
import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
|
|
9
9
|
import path from "node:path";
|
package/dist/cli/index.mjs
CHANGED
|
@@ -24,7 +24,8 @@ function parseFlags(argv) {
|
|
|
24
24
|
"typesense",
|
|
25
25
|
"algolia",
|
|
26
26
|
"verbose",
|
|
27
|
-
"host"
|
|
27
|
+
"host",
|
|
28
|
+
"json"
|
|
28
29
|
]);
|
|
29
30
|
for (let i = 0; i < argv.length; i++) {
|
|
30
31
|
const arg = argv[i];
|
|
@@ -76,17 +77,38 @@ async function main() {
|
|
|
76
77
|
indexName: typeof flags["index-name"] === "string" ? flags["index-name"] : void 0,
|
|
77
78
|
searchApiKey: typeof flags["search-api-key"] === "string" ? flags["search-api-key"] : void 0
|
|
78
79
|
};
|
|
80
|
+
const cloudOptions = {
|
|
81
|
+
configPath: typeof flags.config === "string" ? flags.config : void 0,
|
|
82
|
+
apiBaseUrl: typeof flags["api-base-url"] === "string" ? flags["api-base-url"] : typeof flags.url === "string" ? flags.url : void 0,
|
|
83
|
+
apiKey: typeof flags["api-key"] === "string" ? flags["api-key"] : void 0,
|
|
84
|
+
json: typeof flags.json === "boolean" ? flags.json : void 0
|
|
85
|
+
};
|
|
79
86
|
if (!parsedCommand.command || parsedCommand.command === "init") {
|
|
80
|
-
const { init } = await import("../init-
|
|
87
|
+
const { init } = await import("../init-BJqy-LK2.mjs");
|
|
81
88
|
await init(initOptions);
|
|
82
89
|
} else if (parsedCommand.command === "dev") {
|
|
83
|
-
const { dev } = await import("../dev-
|
|
90
|
+
const { dev } = await import("../dev-DdlhqXNU.mjs");
|
|
84
91
|
await dev(devOptions);
|
|
92
|
+
} else if (parsedCommand.command === "preview") {
|
|
93
|
+
const { runCloudPreview } = await import("../cloud-88xTLXn3.mjs");
|
|
94
|
+
await runCloudPreview(cloudOptions);
|
|
95
|
+
} else if (parsedCommand.command === "cloud" && subcommand === "preview") {
|
|
96
|
+
const { runCloudPreview } = await import("../cloud-88xTLXn3.mjs");
|
|
97
|
+
await runCloudPreview(cloudOptions);
|
|
98
|
+
} else if (parsedCommand.command === "cloud" && subcommand === "sync") {
|
|
99
|
+
const { syncCloudConfig } = await import("../cloud-88xTLXn3.mjs");
|
|
100
|
+
await syncCloudConfig(cloudOptions);
|
|
101
|
+
} else if (parsedCommand.command === "cloud") {
|
|
102
|
+
console.error(pc.red(`Unknown cloud subcommand: ${subcommand ?? "(missing)"}`));
|
|
103
|
+
console.error();
|
|
104
|
+
const { printCloudHelp } = await import("../cloud-88xTLXn3.mjs");
|
|
105
|
+
printCloudHelp();
|
|
106
|
+
process.exit(1);
|
|
85
107
|
} else if (parsedCommand.command === "mcp") {
|
|
86
|
-
const { runMcp } = await import("../mcp-
|
|
108
|
+
const { runMcp } = await import("../mcp-CUAR3XfW.mjs");
|
|
87
109
|
await runMcp(mcpOptions);
|
|
88
110
|
} else if (parsedCommand.command === "agent" && subcommand === "compact") {
|
|
89
|
-
const { compactAgentDocs, parseAgentCompactArgs, printAgentCompactHelp } = await import("../agent-
|
|
111
|
+
const { compactAgentDocs, parseAgentCompactArgs, printAgentCompactHelp } = await import("../agent-CJNYhzu7.mjs");
|
|
90
112
|
const agentCompactOptions = parseAgentCompactArgs(args.slice(2));
|
|
91
113
|
if (agentCompactOptions.help) {
|
|
92
114
|
printAgentCompactHelp();
|
|
@@ -96,11 +118,11 @@ async function main() {
|
|
|
96
118
|
} else if (parsedCommand.command === "agent") {
|
|
97
119
|
console.error(pc.red(`Unknown agent subcommand: ${subcommand ?? "(missing)"}`));
|
|
98
120
|
console.error();
|
|
99
|
-
const { printAgentCompactHelp } = await import("../agent-
|
|
121
|
+
const { printAgentCompactHelp } = await import("../agent-CJNYhzu7.mjs");
|
|
100
122
|
printAgentCompactHelp();
|
|
101
123
|
process.exit(1);
|
|
102
124
|
} else if (parsedCommand.command === "agents" && subcommand === "generate") {
|
|
103
|
-
const { generateAgents, parseAgentsGenerateArgs, printAgentsGenerateHelp } = await import("../agents-
|
|
125
|
+
const { generateAgents, parseAgentsGenerateArgs, printAgentsGenerateHelp } = await import("../agents-BuL01_U0.mjs");
|
|
104
126
|
const agentsOptions = parseAgentsGenerateArgs(args.slice(2));
|
|
105
127
|
if (agentsOptions.help) {
|
|
106
128
|
printAgentsGenerateHelp();
|
|
@@ -110,11 +132,11 @@ async function main() {
|
|
|
110
132
|
} else if (parsedCommand.command === "agents") {
|
|
111
133
|
console.error(pc.red(`Unknown agents subcommand: ${subcommand ?? "(missing)"}`));
|
|
112
134
|
console.error();
|
|
113
|
-
const { printAgentsGenerateHelp } = await import("../agents-
|
|
135
|
+
const { printAgentsGenerateHelp } = await import("../agents-BuL01_U0.mjs");
|
|
114
136
|
printAgentsGenerateHelp();
|
|
115
137
|
process.exit(1);
|
|
116
138
|
} else if (parsedCommand.command === "doctor") {
|
|
117
|
-
const { parseDoctorArgs, printDoctorHelp, runDoctor } = await import("../doctor-
|
|
139
|
+
const { parseDoctorArgs, printDoctorHelp, runDoctor } = await import("../doctor-D_c7vJCb.mjs");
|
|
118
140
|
const doctorOptions = parseDoctorArgs(args.slice(1));
|
|
119
141
|
if (doctorOptions.help) {
|
|
120
142
|
printDoctorHelp();
|
|
@@ -122,7 +144,7 @@ async function main() {
|
|
|
122
144
|
}
|
|
123
145
|
await runDoctor(doctorOptions);
|
|
124
146
|
} else if (parsedCommand.command === "review") {
|
|
125
|
-
const { parseReviewArgs, printReviewHelp, runReview } = await import("../review-
|
|
147
|
+
const { parseReviewArgs, printReviewHelp, runReview } = await import("../review-CjyI-bVg.mjs");
|
|
126
148
|
const reviewOptions = parseReviewArgs(args.slice(1));
|
|
127
149
|
if (reviewOptions.help) {
|
|
128
150
|
printReviewHelp();
|
|
@@ -130,7 +152,7 @@ async function main() {
|
|
|
130
152
|
}
|
|
131
153
|
await runReview(reviewOptions);
|
|
132
154
|
} else if ((parsedCommand.command === "codeblocks" || parsedCommand.command === "code-blocks") && subcommand === "validate") {
|
|
133
|
-
const { parseCodeBlocksValidateArgs, printCodeBlocksValidateHelp, runCodeBlocksValidate } = await import("../codeblocks-
|
|
155
|
+
const { parseCodeBlocksValidateArgs, printCodeBlocksValidateHelp, runCodeBlocksValidate } = await import("../codeblocks-DbJrclYa.mjs");
|
|
134
156
|
const codeBlocksOptions = parseCodeBlocksValidateArgs(args.slice(2));
|
|
135
157
|
if (codeBlocksOptions.help) {
|
|
136
158
|
printCodeBlocksValidateHelp();
|
|
@@ -140,11 +162,11 @@ async function main() {
|
|
|
140
162
|
} else if (parsedCommand.command === "codeblocks" || parsedCommand.command === "code-blocks") {
|
|
141
163
|
console.error(pc.red(`Unknown codeblocks subcommand: ${subcommand ?? "(missing)"}`));
|
|
142
164
|
console.error();
|
|
143
|
-
const { printCodeBlocksValidateHelp } = await import("../codeblocks-
|
|
165
|
+
const { printCodeBlocksValidateHelp } = await import("../codeblocks-DbJrclYa.mjs");
|
|
144
166
|
printCodeBlocksValidateHelp();
|
|
145
167
|
process.exit(1);
|
|
146
168
|
} else if (parsedCommand.command === "search" && subcommand === "sync") {
|
|
147
|
-
const { syncSearch } = await import("../search-
|
|
169
|
+
const { syncSearch } = await import("../search-Cekr2OyP.mjs");
|
|
148
170
|
await syncSearch(searchSyncOptions);
|
|
149
171
|
} else if (parsedCommand.command === "search") {
|
|
150
172
|
console.error(pc.red(`Unknown search subcommand: ${subcommand ?? "(missing)"}`));
|
|
@@ -152,7 +174,7 @@ async function main() {
|
|
|
152
174
|
printHelp();
|
|
153
175
|
process.exit(1);
|
|
154
176
|
} else if (parsedCommand.command === "sitemap" && subcommand === "generate") {
|
|
155
|
-
const { generateSitemap, parseSitemapGenerateArgs, printSitemapGenerateHelp } = await import("../sitemap-
|
|
177
|
+
const { generateSitemap, parseSitemapGenerateArgs, printSitemapGenerateHelp } = await import("../sitemap-BBfGr3tJ.mjs");
|
|
156
178
|
const sitemapOptions = parseSitemapGenerateArgs(args.slice(2));
|
|
157
179
|
if (sitemapOptions.help) {
|
|
158
180
|
printSitemapGenerateHelp();
|
|
@@ -162,11 +184,11 @@ async function main() {
|
|
|
162
184
|
} else if (parsedCommand.command === "sitemap") {
|
|
163
185
|
console.error(pc.red(`Unknown sitemap subcommand: ${subcommand ?? "(missing)"}`));
|
|
164
186
|
console.error();
|
|
165
|
-
const { printSitemapGenerateHelp } = await import("../sitemap-
|
|
187
|
+
const { printSitemapGenerateHelp } = await import("../sitemap-BBfGr3tJ.mjs");
|
|
166
188
|
printSitemapGenerateHelp();
|
|
167
189
|
process.exit(1);
|
|
168
190
|
} else if (parsedCommand.command === "robots" && subcommand === "generate") {
|
|
169
|
-
const { generateRobots, parseRobotsGenerateArgs, printRobotsGenerateHelp } = await import("../robots-
|
|
191
|
+
const { generateRobots, parseRobotsGenerateArgs, printRobotsGenerateHelp } = await import("../robots-Dx2uMF3g.mjs");
|
|
170
192
|
const robotsOptions = parseRobotsGenerateArgs(args.slice(2));
|
|
171
193
|
if (robotsOptions.help) {
|
|
172
194
|
printRobotsGenerateHelp();
|
|
@@ -176,11 +198,11 @@ async function main() {
|
|
|
176
198
|
} else if (parsedCommand.command === "robots") {
|
|
177
199
|
console.error(pc.red(`Unknown robots subcommand: ${subcommand ?? "(missing)"}`));
|
|
178
200
|
console.error();
|
|
179
|
-
const { printRobotsGenerateHelp } = await import("../robots-
|
|
201
|
+
const { printRobotsGenerateHelp } = await import("../robots-Dx2uMF3g.mjs");
|
|
180
202
|
printRobotsGenerateHelp();
|
|
181
203
|
process.exit(1);
|
|
182
204
|
} else if (parsedCommand.command === "downgrade") {
|
|
183
|
-
const { downgrade } = await import("../downgrade-
|
|
205
|
+
const { downgrade } = await import("../downgrade-BayU3nlg.mjs");
|
|
184
206
|
const framework = (typeof flags.framework === "string" ? flags.framework : void 0) ?? (args[1] && !args[1].startsWith("--") ? args[1] : void 0);
|
|
185
207
|
const hasVersionFlag = args.includes("--version") || args.some((arg) => arg.startsWith("--version="));
|
|
186
208
|
await downgrade({
|
|
@@ -188,7 +210,7 @@ async function main() {
|
|
|
188
210
|
version: typeof flags.version === "string" ? flags.version : hasVersionFlag ? "" : void 0
|
|
189
211
|
});
|
|
190
212
|
} else if (parsedCommand.command === "upgrade") {
|
|
191
|
-
const { upgrade } = await import("../upgrade-
|
|
213
|
+
const { upgrade } = await import("../upgrade-DDWolmHe.mjs");
|
|
192
214
|
const framework = (typeof flags.framework === "string" ? flags.framework : void 0) ?? (args[1] && !args[1].startsWith("--") ? args[1] : void 0);
|
|
193
215
|
const hasVersionFlag = args.includes("--version") || args.some((arg) => arg.startsWith("--version="));
|
|
194
216
|
const version = typeof flags.version === "string" ? flags.version : hasVersionFlag ? "" : void 0;
|
|
@@ -216,6 +238,8 @@ ${pc.dim("Usage:")}
|
|
|
216
238
|
${pc.dim("Commands:")}
|
|
217
239
|
${pc.cyan("init")} Scaffold docs in your project (default)
|
|
218
240
|
${pc.cyan("dev")} Run frameworkless docs locally from ${pc.dim("docs.json")}
|
|
241
|
+
${pc.cyan("preview")} Sync cloud config and request a hosted Docs Cloud preview
|
|
242
|
+
${pc.cyan("cloud")} Docs Cloud utilities (${pc.dim("preview")}, ${pc.dim("sync")})
|
|
219
243
|
${pc.cyan("agent")} Agent utilities (${pc.dim("compact")} to generate sibling agent.md files)
|
|
220
244
|
${pc.cyan("agents")} AGENTS.md utilities (${pc.dim("generate")} for static agent instructions)
|
|
221
245
|
${pc.cyan("doctor")} Inspect and score agent or reader-facing docs quality
|
|
@@ -249,6 +273,15 @@ ${pc.dim("Options for dev:")}
|
|
|
249
273
|
${pc.cyan("--host [host]")} Expose the preview on your network; optionally pass a host value
|
|
250
274
|
${pc.cyan("--verbose")} Show raw runtime logs in addition to branded CLI output
|
|
251
275
|
|
|
276
|
+
${pc.dim("Options for cloud preview:")}
|
|
277
|
+
${pc.cyan("preview")} Sync ${pc.dim("docs.config.ts")} into ${pc.dim("docs.json")} and request a hosted preview
|
|
278
|
+
${pc.cyan("cloud preview")} Same as ${pc.cyan("preview")}
|
|
279
|
+
${pc.cyan("cloud sync")} Only materialize cloud settings into ${pc.dim("docs.json")}
|
|
280
|
+
${pc.cyan("--config <path>")} Use a custom docs config path
|
|
281
|
+
${pc.cyan("--api-base-url <url>")} Override the Docs Cloud API base URL
|
|
282
|
+
${pc.cyan("--api-key <key>")} Use an API key directly; prefer ${pc.dim("cloud.apiKey.env")}
|
|
283
|
+
${pc.cyan("--json")} Print machine-readable output
|
|
284
|
+
|
|
252
285
|
${pc.dim("Options for agent compact:")}
|
|
253
286
|
${pc.cyan("agent compact <page...>")} Compact pages and write sibling ${pc.dim("agent.md")} files
|
|
254
287
|
${pc.cyan("agent compact --all")} Compact every folder-based docs page
|