cleanup: remove examples.ts (examples belong in docs, not deployed code)

This commit is contained in:
ZTatman 2026-04-02 18:30:10 -04:00
parent 0c4fff8eb6
commit 8e0c88bea8
5 changed files with 39 additions and 31 deletions

View file

@ -1,14 +1,16 @@
import path from "node:path";
import fs from "node:fs/promises"; import fs from "node:fs/promises";
import * as p from "@clack/prompts"; import path from "node:path";
import * as c from "yoctocolors"; import * as c from "yoctocolors";
import { generateEnvFile } from "../generators/env.js"; import * as p from "@clack/prompts";
import { generateSecret } from "../utils/crypto.js"; import { generateSecret } from "../utils/crypto.js";
import { generateEnvFile } from "../utils/env.js";
/** /**
* Normalizes a URL to use https:// if no protocol is specified. * Normalizes a URL to use https:// if no protocol is specified.
* @param value - The URL to normalize. * @param value - The URL to normalize.
* @returns The normalized URL. * @returns {string} The normalized URL.
*/ */
function normalizeHttpUrl(value: string): string { function normalizeHttpUrl(value: string): string {
const trimmed = value.trim(); const trimmed = value.trim();
@ -22,6 +24,12 @@ function normalizeHttpUrl(value: string): string {
return hasProtocol ? trimmed : `https://${trimmed}`; return hasProtocol ? trimmed : `https://${trimmed}`;
} }
/**
* Validates a URL or host, returning the normalized URL or undefined if valid.
* @param value - The URL or host to validate.
* @param label - The label to use in error messages.
* @returns {string | undefined} The normalized URL or undefined if valid.
*/
function validateHttpUrlOrHost( function validateHttpUrlOrHost(
value: string | undefined, value: string | undefined,
label: string, label: string,
@ -42,6 +50,11 @@ function validateHttpUrlOrHost(
return undefined; return undefined;
} }
/**
* Validates a Postgres URL, returning undefined if valid.
* @param value - The Postgres URL to validate.
* @returns {string | undefined} The error message or undefined if valid.
*/
function validatePostgresUrl(value: string | undefined): string | undefined { function validatePostgresUrl(value: string | undefined): string | undefined {
if (!value?.trim()) { if (!value?.trim()) {
return "Database URL is required"; return "Database URL is required";
@ -59,6 +72,12 @@ function validatePostgresUrl(value: string | undefined): string | undefined {
return undefined; return undefined;
} }
/**
* Writes a private file to disk, throwing an error if the file already exists.
* @param filePath - The path to the file to write.
* @param content - The content to write to the file.
* @returns {Promise<void>} A promise that resolves when the file is written.
*/
async function writePrivateFile( async function writePrivateFile(
filePath: string, filePath: string,
content: string, content: string,
@ -80,6 +99,11 @@ async function writePrivateFile(
} }
} }
/**
* Preflight check for write targets, throwing an error if any target file already exists.
* @param filePaths - The paths of the files to write.
* @returns {Promise<void>} A promise that resolves when all targets are checked.
*/
async function preflightWriteTargets(filePaths: string[]): Promise<void> { async function preflightWriteTargets(filePaths: string[]): Promise<void> {
for (const filePath of filePaths) { for (const filePath of filePaths) {
try { try {
@ -96,6 +120,11 @@ async function preflightWriteTargets(filePaths: string[]): Promise<void> {
} }
} }
/**
* Initializes a Myst project by creating the necessary configuration files.
* @param _args - The command arguments.
* @returns {Promise<void>} A promise that resolves when the initialization is complete.
*/
export async function initCommand(_args: string[]): Promise<void> { export async function initCommand(_args: string[]): Promise<void> {
p.intro(c.bold("myst init")); p.intro(c.bold("myst init"));
p.note( p.note(

View file

@ -1,22 +0,0 @@
export function generateExampleCaddyfile(domain: string): string {
return `${domain} {
reverse_proxy /_myst/* 127.0.0.1:4000
reverse_proxy 127.0.0.1:3000
}
`;
}
export function generateExampleNginxConf(domain: string): string {
return `server {
server_name ${domain};
location /_myst/ {
proxy_pass http://127.0.0.1:4000/;
}
location / {
proxy_pass http://127.0.0.1:3000/;
}
}
`;
}

View file

@ -1,2 +0,0 @@
export * from "./env.js";
export * from "./examples.js";

View file

@ -2,9 +2,7 @@
import * as c from "yoctocolors"; import * as c from "yoctocolors";
import pkg from "../package.json" with { type: "json" }; import pkg from "../package.json" with { type: "json" };
import { import { initCommand } from "./commands/init.js";
initCommand,
} from "./commands/index.js";
const PADDING = 4; const PADDING = 4;
const INDENT = " "; const INDENT = " ";

View file

@ -15,6 +15,11 @@ function escapeEnvValue(value: string): string {
.replace(/\r?\n/g, "\\n")}"`; // Escape newlines .replace(/\r?\n/g, "\\n")}"`; // Escape newlines
} }
/**
* Generates an .env file for Myst with the given options.
* @param options - The options for generating the .env file.
* @returns {string} The .env file formatted as a string.
*/
export function generateEnvFile(options: EnvOptions): string { export function generateEnvFile(options: EnvOptions): string {
return `# Public URL used for share links. return `# Public URL used for share links.
MYST_PUBLIC_URL=${escapeEnvValue(options.publicUrl)} MYST_PUBLIC_URL=${escapeEnvValue(options.publicUrl)}