@writedocs/generator 0.7.1 → 0.7.2

package/bin/writedocs.js

@@ -9,6 +9,7 @@ import { runBuild } from '../src/cli/build.js';
 import { runInit } from '../src/cli/init.js';
 import { requireBuildKey } from '../src/cli/build-auth.js';
 import { log, step, plural, color, CliExit, errorText, stopActiveStep } from '../src/cli/output.js';
+import { startUpdateCheck, showUpdateNotice } from '../src/cli/update-check.js';
 // O MESMO modulo que o build usa (via loadDocsConfig, que reexporta daqui) e
 // que a plataforma importa por `@writedocs/generator/config-schema` - e o que
 // faz os tres reportarem os mesmos problemas com as mesmas palavras, em vez de
@@ -37,13 +38,18 @@ const packageRoot = path.resolve(__dirname, '..');
 // package.json). `writedocs --version` should always reflect what actually
 // got published, not whatever this string happened to say at the time this
 // line was last hand-edited.
-const { version } = JSON.parse(fs.readFileSync(path.join(packageRoot, 'package.json'), 'utf-8'));
+const { name: packageName, version } = JSON.parse(fs.readFileSync(path.join(packageRoot, 'package.json'), 'utf-8'));
 
 const program = new Command();
 program
   .name('writedocs')
   .description('Static site generator for writedocs.json + MDX')
-  .version(version);
+  .version(version)
+  // Every command checks for a newer writedocs (from a cache - see
+  // src/cli/update-check.js); the notice prints after the command's output.
+  .hook('preAction', (_program, command) => {
+    startUpdateCheck({ command: command.name(), name: packageName, version, packageRoot });
+  });
 
 program
   .command('dev')
@@ -265,6 +271,14 @@ program
     });
   });
 
+program
+  .command('update')
+  .description('Update writedocs to the latest version')
+  .action(async () => {
+    const { runUpdate } = await import('../src/cli/update.js');
+    await runUpdate({ name: packageName, version, packageRoot });
+  });
+
 program
   .command('init')
   .description('Scaffold a writedocs.json and starter docs/ folder')
@@ -273,10 +287,13 @@ program
     await runInit({ targetDir: path.resolve(process.cwd(), dir) });
   });
 
-program.parseAsync(process.argv).catch((err) => {
-  // A command that already printed its own error throws CliExit.
-  stopActiveStep();
-  if (err instanceof CliExit) process.exit(err.code);
-  log.error(errorText(err));
-  process.exit(1);
-});
+program
+  .parseAsync(process.argv)
+  .then(showUpdateNotice)
+  .catch((err) => {
+    stopActiveStep();
+    // A command that already printed its own error throws CliExit.
+    if (!(err instanceof CliExit)) log.error(errorText(err));
+    showUpdateNotice();
+    process.exit(err instanceof CliExit ? err.code : 1);
+  });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@writedocs/generator",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "Static site generator for docs — a writedocs.json + MDX folder in, a static site out.",
   "type": "module",
   "bin": {

package/src/cli/dev.js

@@ -5,6 +5,7 @@ import { log, step, duration, formatProblems, color, CliExit } from './output.js
 import { describeError, requestLog, authorWarning, verboseLine, stripAnsi } from './astro-output.js';
 import { reportApiPages } from './api-pages-output.js';
 import { runningPreview, writeLock, removeLock } from './dev-lock.js';
+import { showUpdateNotice } from './update-check.js';
 
 // The same problem tends to arrive more than once in a row - Vite and
 // Astro each log a failed page, and a page compiles for more than one
@@ -96,6 +97,9 @@ export async function runDev({ contentDir, packageRoot, port, verbose = false })
           log.line();
           log.line(color.dim('  Edit any page and the preview updates. Press Ctrl+C to stop.'));
           log.line();
+          // `dev` runs until Ctrl+C - the notice goes under the ready screen,
+          // not after the command like everywhere else.
+          showUpdateNotice();
           return;
         }
         case 'fatal':

package/src/cli/update-check-refresh.js

@@ -0,0 +1,18 @@
+// Detached background process started by update-check.js: asks the npm
+// registry for the latest version of package `process.argv[2]` and caches
+// the answer for the next writedocs run. Prints nothing. A failure (offline,
+// registry down) keeps the last known version but still records the
+// attempt, so it's retried the next day, not on every command.
+import { fetchLatestVersion, readCache, writeCache } from './update-check.js';
+
+const name = process.argv[2];
+let latest = null;
+try {
+  latest = await fetchLatestVersion(name);
+} catch {
+  const previous = readCache();
+  latest = previous?.name === name ? previous.latest : null;
+}
+try {
+  writeCache({ name, latest, checkedAt: Date.now() });
+} catch {}

package/src/cli/update-check.js

@@ -0,0 +1,104 @@
+// "A newer writedocs is available" - shown after any command's output.
+//
+// Never slows a command down: the notice comes from a cached answer, and
+// when that's more than a day old, a detached background process
+// (update-check-refresh.js) asks the npm registry again and rewrites the
+// cache for the next run - the same approach as npm's own update notifier.
+//
+// Not shown for `build` (the WriteDocs platform runs it, not a person) or
+// `update` itself, in CI, when output isn't a terminal, when writedocs runs
+// from a source checkout (updated with git, not npm), or with
+// WRITEDOCS_NO_UPDATE_CHECK set.
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { spawn } from 'node:child_process';
+import { fileURLToPath } from 'node:url';
+import { log, color } from './output.js';
+
+const DAY = 24 * 60 * 60 * 1000;
+const SILENT_COMMANDS = new Set(['build', 'update']);
+
+export function cacheFile() {
+  const base =
+    process.env.XDG_CACHE_HOME ||
+    (process.platform === 'win32' ? process.env.LOCALAPPDATA || path.join(os.homedir(), 'AppData', 'Local') : path.join(os.homedir(), '.cache'));
+  return path.join(base, 'writedocs', 'update-check.json');
+}
+
+export function readCache() {
+  try {
+    return JSON.parse(fs.readFileSync(cacheFile(), 'utf8'));
+  } catch {
+    return null;
+  }
+}
+
+export function writeCache(data) {
+  const file = cacheFile();
+  fs.mkdirSync(path.dirname(file), { recursive: true });
+  fs.writeFileSync(file, JSON.stringify(data));
+}
+
+/** The registry the user's npm uses, or npm's own. */
+export function registryUrl() {
+  const configured = process.env.npm_config_registry || process.env.NPM_CONFIG_REGISTRY;
+  return (configured || 'https://registry.npmjs.org').replace(/\/+$/, '');
+}
+
+/** The version npm's `latest` tag points at. Throws on a network error. */
+export async function fetchLatestVersion(name, { timeoutMs = 5000 } = {}) {
+  const res = await fetch(`${registryUrl()}/-/package/${name.replace('/', '%2f')}/dist-tags`, { signal: AbortSignal.timeout(timeoutMs) });
+  if (!res.ok) throw new Error(`the registry answered ${res.status}`);
+  const tags = await res.json();
+  if (typeof tags?.latest !== 'string') throw new Error('the registry has no "latest" version');
+  return tags.latest;
+}
+
+/** Whether `latest` is a newer release than `current` - x.y.z only; a
+ *  prerelease never counts as newer. */
+export function isNewer(latest, current) {
+  const parse = (v) => /^(\d+)\.(\d+)\.(\d+)$/.exec(String(v).trim())?.slice(1).map(Number);
+  const a = parse(latest);
+  const b = parse(current);
+  if (!a || !b) return false;
+  for (let i = 0; i < 3; i += 1) if (a[i] !== b[i]) return a[i] > b[i];
+  return false;
+}
+
+export function isSourceCheckout(packageRoot) {
+  return fs.existsSync(path.join(packageRoot, '.git'));
+}
+
+function enabled(command, packageRoot) {
+  if (SILENT_COMMANDS.has(command)) return false;
+  if (process.env.WRITEDOCS_NO_UPDATE_CHECK || process.env.CI) return false;
+  if (!process.stdout.isTTY) return false;
+  return !isSourceCheckout(packageRoot);
+}
+
+let state = null;
+
+/** Called once at startup: loads the cached answer, and refreshes it in the
+ *  background when it's old. */
+export function startUpdateCheck({ command, name, version, packageRoot }) {
+  if (!enabled(command, packageRoot)) return;
+  const cache = readCache();
+  state = { name, version, latest: cache?.name === name ? cache.latest : null, shown: false };
+  if (cache?.name === name && Date.now() - (cache.checkedAt ?? 0) < DAY) return;
+  try {
+    const worker = path.join(path.dirname(fileURLToPath(import.meta.url)), 'update-check-refresh.js');
+    const child = spawn(process.execPath, [worker, name], { detached: true, stdio: 'ignore', windowsHide: true });
+    child.unref();
+  } catch {
+    // No notice this time - not worth failing a command over.
+  }
+}
+
+/** Prints the notice, if there's a newer version - once per run. */
+export function showUpdateNotice() {
+  if (!state || state.shown || !state.latest || !isNewer(state.latest, state.version)) return;
+  state.shown = true;
+  log.line();
+  log.info(`writedocs ${color.bold(state.latest)} is available ${color.dim(`(you have ${state.version})`)}. Run ${color.cyan('writedocs update')} to update.`);
+}

package/src/cli/update.js

@@ -0,0 +1,107 @@
+// `writedocs update` - installs the latest writedocs, the same way the running
+// one was installed: globally with npm (the documented way), as a project
+// dependency (npm, pnpm or yarn, by the project's lockfile), or globally
+// with pnpm or yarn. npx and a source checkout get an explanation instead.
+import fs from 'node:fs';
+import path from 'node:path';
+import { spawn } from 'node:child_process';
+import { log, step, color, CliExit } from './output.js';
+import { fetchLatestVersion, isNewer, isSourceCheckout, writeCache } from './update-check.js';
+
+/** Runs a command, capturing its output. Resolves { code, output }. */
+function run(command, args, cwd) {
+  return new Promise((resolve) => {
+    // npm/pnpm/yarn are .cmd scripts on Windows, which spawn() only runs
+    // through a shell - given as one string there (Node deprecates an
+    // argument list with `shell`). The arguments are fixed: flags and the
+    // package name, never user input.
+    const options = { cwd, stdio: ['ignore', 'pipe', 'pipe'], windowsHide: true };
+    const child = process.platform === 'win32' ? spawn([command, ...args].join(' '), { ...options, shell: true }) : spawn(command, args, options);
+    let output = '';
+    child.stdout.on('data', (d) => (output += d));
+    child.stderr.on('data', (d) => (output += d));
+    child.on('error', (err) => resolve({ code: 1, output: err.message }));
+    child.on('close', (code) => resolve({ code: code ?? 1, output }));
+  });
+}
+
+/** How the running writedocs was installed:
+ *  { kind: 'checkout' | 'npx' | 'unknown' } or
+ *  { kind: 'global' | 'local', command, args, cwd }. */
+export async function installation(packageRoot, name) {
+  if (isSourceCheckout(packageRoot)) return { kind: 'checkout' };
+  const posix = packageRoot.split(path.sep).join('/');
+  if (/\/_npx\//.test(posix)) return { kind: 'npx' };
+  if (/\/pnpm\/global\//.test(posix)) return { kind: 'global', command: 'pnpm', args: ['add', '-g', `${name}@latest`] };
+  if (/\/yarn\/global\//.test(posix)) return { kind: 'global', command: 'yarn', args: ['global', 'add', `${name}@latest`] };
+  const at = posix.lastIndexOf(`/node_modules/${name}`);
+  if (at === -1) return { kind: 'unknown' };
+  const container = posix.slice(0, at);
+  const npmRoot = await run('npm', ['root', '-g']);
+  const globalRoot = npmRoot.code === 0 ? npmRoot.output.trim().split(/\r?\n/).pop() : null;
+  if (globalRoot && path.resolve(globalRoot) === path.resolve(`${container}/node_modules`)) {
+    return { kind: 'global', command: 'npm', args: ['install', '-g', `${name}@latest`] };
+  }
+  const cwd = path.resolve(container);
+  if (fs.existsSync(path.join(cwd, 'pnpm-lock.yaml'))) return { kind: 'local', command: 'pnpm', args: ['add', `${name}@latest`], cwd };
+  if (fs.existsSync(path.join(cwd, 'yarn.lock'))) return { kind: 'local', command: 'yarn', args: ['add', `${name}@latest`], cwd };
+  return { kind: 'local', command: 'npm', args: ['install', `${name}@latest`], cwd };
+}
+
+export async function runUpdate({ name, version, packageRoot }) {
+  const checking = step('Checking for a new version');
+  let latest;
+  try {
+    latest = await fetchLatestVersion(name, { timeoutMs: 15000 });
+  } catch (err) {
+    checking.fail("Couldn't check for a new version");
+    log.detail(color.dim(`${err.message}. Check your connection, and try again.`));
+    throw new CliExit(1);
+  }
+  checking.stop();
+  try {
+    writeCache({ name, latest, checkedAt: Date.now() });
+  } catch {}
+  if (!isNewer(latest, version)) {
+    log.success(`writedocs is up to date ${color.dim(`(${version})`)}`);
+    return;
+  }
+
+  const install = await installation(packageRoot, name);
+  if (install.kind === 'checkout') {
+    log.info(`writedocs ${latest} is available, but this one runs from a source checkout (${packageRoot}).`);
+    log.detail(color.dim('Update it with git - `writedocs update` only updates installed copies.'));
+    return;
+  }
+  if (install.kind === 'npx') {
+    log.info(`writedocs ${latest} is available. You're running writedocs through npx - to use the latest, run:`);
+    log.detail(color.cyan(`npx ${name}@latest <command>`));
+    log.detail(color.dim(`Or install it once, and use \`writedocs\` directly: npm install -g ${name}`));
+    return;
+  }
+  if (install.kind === 'unknown') {
+    log.info(`writedocs ${latest} is available. Update it the way you installed it - for example:`);
+    log.detail(color.cyan(`npm install -g ${name}@latest`));
+    return;
+  }
+
+  const shown = `${install.command} ${install.args.join(' ')}`;
+  const updating = step(`Updating writedocs ${version} → ${latest} ${color.dim(`(${shown}${install.cwd ? ` in ${install.cwd}` : ''})`)}`);
+  const result = await run(install.command, install.args, install.cwd);
+  if (result.code !== 0) {
+    updating.fail(`Couldn't update writedocs - \`${shown}\` failed`);
+    const tail = result.output.trim().split(/\r?\n/).slice(-12).join('\n');
+    if (tail) {
+      log.line();
+      log.line(color.dim(tail));
+    }
+    if (/EACCES|permission denied/i.test(result.output)) {
+      log.line();
+      log.detail(
+        `npm needs permission to write to its global folder. Run ${color.cyan(`sudo ${shown}`)}, or set npm up to install without sudo: https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally`
+      );
+    }
+    throw new CliExit(1);
+  }
+  updating.succeed(`Updated writedocs ${version} → ${color.bold(latest)}`);
+}