@karaoke-cms/create 0.6.1 → 0.6.3

package/src/index.js

@@ -0,0 +1,187 @@
+#!/usr/bin/env node
+/**
+ * @karaoke-cms/create — scaffold a new karaoke-cms project.
+ * Usage: npm create @karaoke-cms@latest [project-dir]
+ *
+ * Zero runtime dependencies — uses Node.js built-ins only.
+ */
+
+import { createInterface } from 'readline';
+import { existsSync, mkdirSync, writeFileSync, readFileSync, cpSync } from 'fs';
+import { join, resolve } from 'path';
+import { fileURLToPath } from 'url';
+import { spawnSync } from 'child_process';
+import {
+  packageJson, astroConfig, karaokeConfig, contentConfig,
+  envDts, tsConfig, gitignore, envDefault, cloudflareRedirects,
+} from './templates.js';
+
+// ── ANSI helpers ─────────────────────────────────────────────────────────────
+const R = '\x1b[0m';
+const BOLD = '\x1b[1m';
+const GREEN = '\x1b[32m';
+const CYAN = '\x1b[36m';
+const GRAY = '\x1b[90m';
+const RED = '\x1b[31m';
+
+// Use create package's own version as the @karaoke-cms/astro dep range
+// (packages ship in lockstep)
+const { version: astroVersion } = JSON.parse(
+  readFileSync(new URL('../package.json', import.meta.url), 'utf8')
+);
+
+// Separate input (readline) from output (process.stdout) so piped stdin works
+// correctly. Buffer all 'line' events into a queue so that lines emitted before
+// the next nextLine() call are never dropped (this happens with piped input
+// because readline reads the entire pipe before the first await completes).
+const rl = createInterface({ input: process.stdin });
+const lineQueue = [];
+let lineWaiter = null;
+let inputClosed = false;
+
+rl.on('line', line => {
+  if (lineWaiter) {
+    const resolve = lineWaiter;
+    lineWaiter = null;
+    resolve(line);
+  } else {
+    lineQueue.push(line);
+  }
+});
+
+rl.on('close', () => {
+  inputClosed = true;
+  if (lineWaiter) { lineWaiter(''); lineWaiter = null; }
+});
+
+function nextLine() {
+  if (lineQueue.length > 0) return Promise.resolve(lineQueue.shift());
+  if (inputClosed) return Promise.resolve('');
+  return new Promise(resolve => { lineWaiter = resolve; });
+}
+
+async function ask(question, defaultValue = '') {
+  const hint = defaultValue ? ` ${GRAY}(${defaultValue})${R}` : '';
+  process.stdout.write(`${CYAN}?${R} ${question}${hint} › `);
+  const ans = await nextLine();
+  return ans.trim() || defaultValue;
+}
+
+async function askYesNo(question, defaultYes = true) {
+  const hint = defaultYes ? 'Y/n' : 'y/N';
+  process.stdout.write(`${CYAN}?${R} ${question} ${GRAY}(${hint})${R} › `);
+  const ans = await nextLine();
+  return ans.trim() ? ans.trim().toLowerCase().startsWith('y') : defaultYes;
+}
+
+async function askChoice(question, choices, defaultIndex = 0) {
+  console.log(`${CYAN}?${R} ${question}`);
+  choices.forEach((c, i) => {
+    const marker = i === defaultIndex ? `${CYAN}›${R}` : ' ';
+    console.log(`  ${marker} ${i + 1}) ${c}`);
+  });
+  process.stdout.write(`  ${GRAY}Enter number (default ${defaultIndex + 1})${R} › `);
+  const ans = await nextLine();
+  const n = parseInt(ans.trim()) - 1;
+  return choices[n >= 0 && n < choices.length ? n : defaultIndex];
+}
+
+// ── Main ─────────────────────────────────────────────────────────────────────
+async function main() {
+  console.log(`\n${BOLD}Create a new karaoke-cms project${R}\n`);
+
+  // Project directory (can be passed as first CLI arg)
+  let dir = process.argv[2]?.replace(/^-+/, '') || '';
+  if (!dir) dir = await ask('Project directory', 'my-cms');
+
+  const targetDir = resolve(process.cwd(), dir);
+
+  if (existsSync(targetDir)) {
+    console.error(`\n${RED}✗${R} Directory already exists: ${BOLD}${targetDir}${R}`);
+    rl.close();
+    process.exit(1);
+  }
+
+  // Derive a readable default title from the directory name
+  const defaultTitle = dir
+    .replace(/[-_]/g, ' ')
+    .replace(/\b\w/g, c => c.toUpperCase());
+
+  const title = await ask('Site title', defaultTitle);
+  const siteUrl = await ask('Site URL', 'https://my-site.pages.dev');
+  const description = await ask('Description', 'Our team knowledge base.');
+  const theme = await askChoice('Theme', ['default', 'minimal'], 0);
+  const search = await askYesNo('Enable search? (Pagefind)', true);
+  const commentsEnabled = await askYesNo('Enable comments? (requires Giscus setup)', false);
+
+  let comments = null;
+  if (commentsEnabled) {
+    console.log(`\n  ${GRAY}Get these values from giscus.app after enabling Discussions on your repo.${R}\n`);
+    const repo = await ask('GitHub repo (owner/repo)');
+    const repoId = await ask('Repo ID');
+    const category = await ask('Discussion category', 'General');
+    const categoryId = await ask('Category ID');
+    comments = { repo, repoId, category, categoryId };
+  }
+
+  rl.close();
+
+  // ── Scaffold ────────────────────────────────────────────────────────────────
+  console.log(`\n  Scaffolding ${BOLD}${dir}${R}...\n`);
+
+  mkdirSync(join(targetDir, 'src'), { recursive: true });
+  mkdirSync(join(targetDir, 'public'), { recursive: true });
+
+  // Config and project files from templates
+  const files = {
+    'package.json':           packageJson({ name: dir, astroVersion }),
+    'astro.config.mjs':       astroConfig({ siteUrl }),
+    'karaoke.config.ts':      karaokeConfig({ title, description, theme, search, comments }),
+    'src/content.config.ts':  contentConfig(),
+    'src/env.d.ts':           envDts(),
+    'tsconfig.json':          tsConfig(),
+    '.gitignore':             gitignore(),
+    '.env.default':           envDefault(),
+    'public/_redirects':      cloudflareRedirects(),
+  };
+
+  for (const [file, content] of Object.entries(files)) {
+    writeFileSync(join(targetDir, file), content);
+    console.log(`  ${GREEN}+${R} ${file}`);
+  }
+
+  // Vault content: copy the real Obsidian vault into vault/ subdirectory
+  const vaultSrc = fileURLToPath(new URL('../karaoke-create-vault', import.meta.url));
+  cpSync(vaultSrc, join(targetDir, 'vault'), { recursive: true });
+  console.log(`  ${GREEN}+${R} vault/ (Obsidian vault)`);
+
+  // ── Git init ────────────────────────────────────────────────────────────────
+  const gitOk = (() => {
+    const run = (args) => spawnSync('git', args, { cwd: targetDir, encoding: 'utf8' }).status === 0;
+    return (
+      run(['init']) &&
+      run(['add', '-A']) &&
+      run(['-c', 'user.name=karaoke-cms', '-c', 'user.email=setup@karaoke-cms.org',
+           'commit', '-m', 'chore: initial karaoke-cms setup'])
+    );
+  })();
+
+  if (gitOk) {
+    console.log(`  ${GREEN}+${R} git repository initialized`);
+  } else {
+    console.log(`  ${GRAY}  (git init skipped — install git and run it manually)${R}`);
+  }
+
+  // ── Done ────────────────────────────────────────────────────────────────────
+  console.log(`\n${GREEN}✓${R} Done! Created ${BOLD}${dir}/${R}\n`);
+  console.log(`  Next steps:\n`);
+  console.log(`  ${CYAN}cd ${dir}${R}`);
+  console.log(`  ${CYAN}npm install${R}`);
+  console.log(`  ${CYAN}npm run dev${R}    ${GRAY}→ http://localhost:4321${R}\n`);
+  console.log(`  ${GRAY}Open ${BOLD}${dir}/vault/${R}${GRAY} in Obsidian to write content.${R}\n`);
+}
+
+main().catch(err => {
+  console.error(`\n${RED}✗${R} ${err.message}`);
+  process.exit(1);
+});

package/src/templates.js

@@ -0,0 +1,133 @@
+/**
+ * Pure template functions for karaoke-cms project scaffolding.
+ * Each returns a file's content as a string.
+ * Exported separately so they're independently testable.
+ */
+
+/**
+ * @param {{ name: string, astroVersion: string }} opts
+ */
+export function packageJson({ name, astroVersion }) {
+  return JSON.stringify({
+    name,
+    private: true,
+    type: 'module',
+    engines: { node: '>=22.12.0' },
+    scripts: {
+      dev: 'astro dev',
+      build: 'astro build',
+      preview: 'astro preview',
+    },
+    dependencies: {
+      '@karaoke-cms/astro': `^${astroVersion}`,
+      astro: '^6.0.0',
+    },
+  }, null, 2) + '\n';
+}
+
+/**
+ * @param {{ siteUrl: string }} opts
+ */
+export function astroConfig({ siteUrl }) {
+  return `// @ts-check
+import { defineConfig } from 'astro/config';
+import karaoke from '@karaoke-cms/astro';
+
+let karaokeConfig = {};
+try {
+  karaokeConfig = (await import('./karaoke.config.ts')).default;
+} catch (err) {
+  if (err.code !== 'ERR_MODULE_NOT_FOUND') throw err;
+}
+
+export default defineConfig({
+  site: ${JSON.stringify(siteUrl)},
+  integrations: [karaoke(karaokeConfig)],
+});
+`;
+}
+
+/**
+ * @param {{
+ *   title: string,
+ *   description: string,
+ *   theme: string,
+ *   search: boolean,
+ *   comments: { repo: string, repoId: string, category: string, categoryId: string } | null,
+ * }} opts
+ */
+export function karaokeConfig({ title, description, theme, search, comments }) {
+  const modules = {};
+  if (search) modules.search = { enabled: true };
+  if (comments) modules.comments = { enabled: true, ...comments };
+
+  const modulesStr = Object.keys(modules).length > 0
+    ? `\n  modules: ${JSON.stringify(modules, null, 2).replace(/\n/g, '\n  ')},`
+    : '';
+
+  return `import type { KaraokeConfig } from '@karaoke-cms/astro';
+import { loadEnv } from '@karaoke-cms/astro/env';
+
+const env = loadEnv(new URL('.', import.meta.url));
+
+const config: KaraokeConfig = {
+  vault: env.KARAOKE_VAULT,
+  title: ${JSON.stringify(title)},
+  description: ${JSON.stringify(description)},
+  theme: ${JSON.stringify(theme)},${modulesStr}
+};
+
+export default config;
+`;
+}
+
+export function contentConfig() {
+  return `import { makeCollections } from '@karaoke-cms/astro/collections';
+import { loadEnv } from '@karaoke-cms/astro/env';
+
+const env = loadEnv(new URL('..', import.meta.url));
+
+export const collections = makeCollections(new URL('..', import.meta.url), env.KARAOKE_VAULT);
+`;
+}
+
+export function envDts() {
+  return `/// <reference types="astro/client" />
+/// <reference types="@karaoke-cms/astro/client" />
+`;
+}
+
+export function tsConfig() {
+  return JSON.stringify(
+    { extends: 'astro/tsconfigs/strict', include: ['.astro/types.d.ts', '**/*'], exclude: ['dist'] },
+    null, 2
+  ) + '\n';
+}
+
+export function gitignore() {
+  return `.DS_Store
+node_modules/
+dist/
+.astro/
+.env
+.env.local
+.env.*.local
+# Obsidian workspace state (personal, not shared)
+.obsidian/workspace.json
+.obsidian/workspace-mobile.json
+`;
+}
+
+export function envDefault() {
+  return `# Obsidian vault location — open this folder in Obsidian to write content.
+# Override in .env (gitignored) to point to a vault elsewhere on your machine.
+# Absolute path: KARAOKE_VAULT=/Users/you/Obsidian/my-vault
+# Relative path: KARAOKE_VAULT=../my-obsidian-vault
+KARAOKE_VAULT=./vault/
+`;
+}
+
+export function cloudflareRedirects() {
+  return `/* /404.html 404\n`;
+}
+