docs.ts•1.84 kB
import { Command } from "@commander-js/extra-typings";
import chalk from "chalk";
import open from "open";
import { Context, oneoffContext } from "../bundler/context.js";
import { logMessage } from "../bundler/log.js";
import { bigBrainFetch, deprecationCheckWarning } from "./lib/utils/utils.js";
import {
getDeploymentSelection,
deploymentNameFromSelection,
} from "./lib/deploymentSelection.js";
export const docs = new Command("docs")
.description("Open the docs in the browser")
.allowExcessArguments(false)
.option("--no-open", "Print docs URL instead of opening it in your browser")
.action(async (options) => {
const ctx = await oneoffContext({
url: undefined,
adminKey: undefined,
envFile: undefined,
});
const deploymentSelection = await getDeploymentSelection(ctx, {
url: undefined,
adminKey: undefined,
envFile: undefined,
});
const configuredDeployment =
deploymentNameFromSelection(deploymentSelection);
if (configuredDeployment === null) {
await openDocs(ctx, options.open);
return;
}
const getCookieUrl = `get_cookie/${configuredDeployment}`;
const fetch = await bigBrainFetch(ctx);
try {
const res = await fetch(getCookieUrl);
deprecationCheckWarning(ctx, res);
const { cookie } = await res.json();
await openDocs(ctx, options.open, cookie);
} catch {
await openDocs(ctx, options.open);
}
});
async function openDocs(ctx: Context, toOpen: boolean, cookie?: string) {
let docsUrl = "https://docs.convex.dev";
if (cookie !== undefined) {
docsUrl += "/?t=" + cookie;
}
if (toOpen) {
await open(docsUrl);
logMessage(chalk.green("Docs have launched! Check your browser."));
} else {
logMessage(chalk.green(`Find Convex docs here: ${docsUrl}`));
}
}