forged-cli 0.8.0 → 0.8.2

package/README.md

@@ -2,10 +2,10 @@
 
 > Your dev environment, forged.
 
-[![npm version](https://img.shields.io/npm/v/forged-cli?color=00ff41&style=flat-square)](https://www.npmjs.com/package/forged-cli)
-[![downloads](https://img.shields.io/npm/dt/forged-cli?color=00ff41&style=flat-square)](https://www.npmjs.com/package/forged-cli)
-[![tests](https://img.shields.io/github/actions/workflow/status/bkness/forged-cli/test.yml?branch=main&label=tests&color=00ff41&style=flat-square)](https://github.com/bkness/forged-cli/actions/workflows/test.yml)
-[![license](https://img.shields.io/npm/l/forged-cli?color=00ff41&style=flat-square)](https://github.com/bkness/forged-cli)
+[![npm version](https://img.shields.io/npm/v/forged-cli?color=1a7f37&labelColor=161b22&style=flat-square)](https://www.npmjs.com/package/forged-cli)
+[![downloads](https://img.shields.io/npm/dt/forged-cli?color=1a7f37&labelColor=161b22&style=flat-square)](https://www.npmjs.com/package/forged-cli)
+[![tests](https://img.shields.io/github/actions/workflow/status/bkness/forged-cli/test.yml?branch=main&label=tests&color=1a7f37&labelColor=161b22&style=flat-square)](https://github.com/bkness/forged-cli/actions/workflows/test.yml)
+[![license](https://img.shields.io/npm/l/forged-cli?color=1a7f37&labelColor=161b22&style=flat-square)](https://github.com/bkness/forged-cli)
 
 **Forged** is a CLI toolkit for developers: a guided zsh setup, a dependency security scanner, a credential generator, and a README generator.
 
@@ -19,7 +19,7 @@
 npm install -g forged-cli
 ```
 
-Requires Node.js 18 or newer. Published from GitHub Actions with [npm provenance](https://docs.npmjs.com/generating-provenance-statements), so every release is traceable to the commit that built it.
+Requires Node.js 20.12 or newer. Published from GitHub Actions with [npm provenance](https://docs.npmjs.com/generating-provenance-statements), so every release is traceable to the commit that built it.
 
 ---
 
@@ -48,7 +48,7 @@ forged readme
 It's written for people new to the terminal. It shows the whole plan first, explains each step, and asks before doing it:
 
 1. **Homebrew on your PATH.** If Homebrew is installed but `brew` isn't found (the installer's last step is easy to miss), adds its `shellenv` line to `~/.zprofile`
-2. **Command-line tools.** Installs whichever of `git gh fzf eza bat fd zoxide starship` are missing, with Homebrew
+2. **Command-line tools.** Installs whichever of `git gh fzf eza bat fd zoxide starship ripgrep jq` are missing, with Homebrew
 3. **zinit**, the plugin manager, cloned to `~/.local/share/zinit`
 4. **The dotfiles**, cloned to `~/dev/dotfiles`
 5. **One line in `~/.zshrc`** that loads them. The file is backed up first, and nothing already in it is changed
@@ -63,6 +63,16 @@ Steps that are already done are skipped, so it's safe to run again after fixing
 
 Needs macOS or Linux. Without Homebrew (on Linux, say), init lists the missing tools for you to install yourself and does the rest.
 
+### After `forged init`
+
+Three things init can't do for you:
+
+1. **Log in to GitHub** for the Ctrl+G dashboard: `gh auth login`. Project boards also need `gh auth refresh -s project`
+2. **Install a Nerd Font** so file icons show instead of boxes: `brew install --cask font-jetbrains-mono-nerd-font`, then choose "JetBrainsMono Nerd Font" in your terminal's font settings
+3. **Linux only: make zsh your shell** with `chsh -s "$(which zsh)"`, then log out and back in. macOS already uses zsh
+
+Then run `exec zsh` (or open a new tab) to load it.
+
 ---
 
 ## 🔍 Security Scanner

package/bin/forged.js

@@ -59,8 +59,8 @@ if (command === 'version') {
 
 if (command === 'readme') {
   const { readmeCommand } = await import('../src/commands/readme.js');
-  await readmeCommand(args[0] || 'README.md');
-  process.exit(0);
+  const written = await readmeCommand(args[0] || 'README.md');
+  process.exit(written === false ? 130 : 0); // 130 = cancelled with Ctrl+C
 }
 
 if (command === 'init') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "forged-cli",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "A complete dev environment toolkit — shell, workflows, and project scaffolding in one install.",
   "keywords": [
     "cli",
@@ -25,7 +25,7 @@
     "forged": "bin/forged.js"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20.12"
   },
   "scripts": {
     "start": "node bin/forged.js",

package/src/commands/init.js

@@ -22,8 +22,14 @@ export const TOOLS = {
   fd:       'a faster `find`',
   zoxide:   'jump to folders you visit often (Ctrl+J)',
   starship: 'the prompt',
+  rg:       'fast code search behind the code finder',
+  jq:       'reads JSON, for project settings',
 };
 
+// Package names that differ from the command they install
+export const PACKAGES = { rg: 'ripgrep' };
+export const packageFor = (tool) => PACKAGES[tool] ?? tool;
+
 export const DOTFILES_REPO = 'https://github.com/bkness/dotfiles.git';
 export const ZINIT_REPO    = 'https://github.com/zdharma-continuum/zinit.git';
 export const HOOK_MARKER   = '# forged: load the Forged shell';
@@ -150,11 +156,11 @@ function apply(step, home, run) {
     }
     case 'tools': {
       if (!step.brewAvailable) {
-        console.log(`  ${yellow}Homebrew isn't installed, so install these yourself:${reset} ${bold}${step.missing.join(' ')}${reset}`);
+        console.log(`  ${yellow}Homebrew isn't installed, so install these yourself:${reset} ${bold}${step.missing.map(packageFor).join(' ')}${reset}`);
         console.log(`  ${dim}On a Mac, get Homebrew from https://brew.sh and run forged init again. On Linux, use your package manager.${reset}`);
         return 'manual';
       }
-      return run(step.brew, ['install', ...step.missing]);
+      return run(step.brew, ['install', ...step.missing.map(packageFor)]);
     }
     case 'zinit':
       return run('git', ['clone', '--depth', '1', ZINIT_REPO, step.dir]);
@@ -237,6 +243,8 @@ export async function initCommand(args, { home = homedir(), env = realEnv(home),
   console.log(`  ${green}${bold}All set.${reset} Next:`);
   console.log(`    ${bold}exec zsh${reset}          load the new shell in this window`);
   console.log(`    ${bold}gh auth login${reset}     connect GitHub, for the Ctrl+G dashboard`);
+  console.log(`    ${bold}a Nerd Font${reset}       for file icons: ${bold}brew install --cask font-jetbrains-mono-nerd-font${reset},`);
+  console.log(`                      then pick it in your terminal's font settings`);
   console.log(`    ${bold}Ctrl+P${reset}            browse every command\n`);
   return 0;
 }

package/src/commands/readme.js

@@ -1,12 +1,9 @@
-import { createRequire } from 'module';
+import inquirer from 'inquirer';
 import { writeFile } from 'fs/promises';
 import { resolve } from 'path';
 import { detectProjectInfo } from '../utils/detectProject.js';
 import { generateMarkdown } from '../utils/generateMarkdown.js';
 
-const require = createRequire(import.meta.url);
-const { prompt } = require('inquirer');
-
 const green  = '\x1b[32m';
 const purple = '\x1b[35m';
 const reset  = '\x1b[0m';
@@ -18,65 +15,75 @@ export async function readmeCommand(outputPath = 'README.md') {
   if (detected.github) console.log(`   Detected GitHub user: ${detected.github}`);
   console.log('   Press Enter to accept defaults.\n');
 
-  const answers = await prompt([
-    {
-      type: 'input',
-      name: 'title',
-      message: `${green}Project name:${reset}`,
-      default: detected.title,
-    },
-    {
-      type: 'input',
-      name: 'description',
-      message: `${green}Short description:${reset}`,
-    },
-    {
-      type: 'input',
-      name: 'toDo',
-      message: `${green}To-do items (leave blank to skip section):${reset}`,
-    },
-    {
-      type: 'list',
-      name: 'license',
-      message: `${green}License:${reset}`,
-      choices: ['MIT', 'APACHE 2.0', 'GPL 3.0', 'BSD 3', 'None'],
-    },
-    {
-      type: 'input',
-      name: 'installation',
-      message: `${green}Install command:${reset}`,
-      default: detected.installCommand,
-    },
-    {
-      type: 'input',
-      name: 'test',
-      message: `${green}Test command:${reset}`,
-      default: detected.testCommand,
-    },
-    {
-      type: 'input',
-      name: 'usage',
-      message: `${green}Usage instructions:${reset}`,
-    },
-    {
-      type: 'input',
-      name: 'contributing',
-      message: `${green}Contributing guidelines:${reset}`,
-      default: 'Fork the project and open a pull request with your changes',
-    },
-    {
-      type: 'input',
-      name: 'github',
-      message: `${green}GitHub username:${reset}`,
-      default: detected.github,
-    },
-    {
-      type: 'input',
-      name: 'email',
-      message: `${green}Email address:${reset}`,
-      default: detected.email,
-    },
-  ]);
+  let answers;
+  try {
+    answers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'title',
+        message: `${green}Project name:${reset}`,
+        default: detected.title,
+      },
+      {
+        type: 'input',
+        name: 'description',
+        message: `${green}Short description:${reset}`,
+      },
+      {
+        type: 'input',
+        name: 'toDo',
+        message: `${green}To-do items (leave blank to skip section):${reset}`,
+      },
+      {
+        type: 'list',
+        name: 'license',
+        message: `${green}License:${reset}`,
+        choices: ['MIT', 'APACHE 2.0', 'GPL 3.0', 'BSD 3', 'None'],
+      },
+      {
+        type: 'input',
+        name: 'installation',
+        message: `${green}Install command:${reset}`,
+        default: detected.installCommand,
+      },
+      {
+        type: 'input',
+        name: 'test',
+        message: `${green}Test command:${reset}`,
+        default: detected.testCommand,
+      },
+      {
+        type: 'input',
+        name: 'usage',
+        message: `${green}Usage instructions:${reset}`,
+      },
+      {
+        type: 'input',
+        name: 'contributing',
+        message: `${green}Contributing guidelines:${reset}`,
+        default: 'Fork the project and open a pull request with your changes',
+      },
+      {
+        type: 'input',
+        name: 'github',
+        message: `${green}GitHub username:${reset}`,
+        default: detected.github,
+      },
+      {
+        type: 'input',
+        name: 'email',
+        message: `${green}Email address:${reset}`,
+        default: detected.email,
+      },
+    ]);
+  } catch (err) {
+    // Ctrl+C makes Inquirer throw ExitPromptError; without this it crashed
+    if (err?.name === 'ExitPromptError') {
+      console.log(`\n${purple}Cancelled. Nothing was written.${reset}\n`);
+      return false;
+    }
+    throw err;
+  }
 
   const markdown = generateMarkdown(answers);
   await writeFile(resolve(outputPath), markdown, 'utf8');