@readme/cli 0.1.0 → 0.3.0

package/src/utils/eyes.js

@@ -19,7 +19,15 @@ export const palettes = {
   red: { name: 'Red', body: '#EF4444', page: '#FFF5F5', pupil: '#7F1D1D', lid: '#FCA5A5' },
   teal: { name: 'Teal', body: '#14B8A6', page: '#F0FFFE', pupil: '#134E4A', lid: '#5EEAD4' },
   yellow: { name: 'Yellow', body: '#EAB308', page: '#FEFCE8', pupil: '#713F12', lid: '#FDE047' },
-  owl: { name: 'Owl', body: '#8B5A2B', page: '#FFF8EE', pupil: '#2A1000', lid: '#C4923A', nose: '#FFD700', hidden: true },
+  owl: {
+    name: 'Owl',
+    body: '#8B5A2B',
+    page: '#FFF8EE',
+    pupil: '#2A1000',
+    lid: '#C4923A',
+    nose: '#FFD700',
+    hidden: true,
+  },
 };
 
 let currentPalette = palettes.blue;
@@ -124,7 +132,21 @@ function rebuildExpressions() {
 
 export const animations = {
   blink: {
-    frames: ['right', 'right', 'right', 'right', 'right', 'right', 'half-blink', 'squint', 'closed', 'closed', 'squint', 'half-blink', 'right'],
+    frames: [
+      'right',
+      'right',
+      'right',
+      'right',
+      'right',
+      'right',
+      'half-blink',
+      'squint',
+      'closed',
+      'closed',
+      'squint',
+      'half-blink',
+      'right',
+    ],
     durations: [1500, 100, 100, 100, 100, 100, 50, 50, 50, 80, 50, 50, 100],
   },
 
@@ -134,85 +156,154 @@ export const animations = {
   },
 
   lookaround: {
-    frames: ['right', 'right', 'left', 'left', 'left', 'right', 'right', 'up-right', 'up-right', 'right', 'right', 'up-left', 'up-left', 'left', 'left', 'right'],
+    frames: [
+      'right',
+      'right',
+      'left',
+      'left',
+      'left',
+      'right',
+      'right',
+      'up-right',
+      'up-right',
+      'right',
+      'right',
+      'up-left',
+      'up-left',
+      'left',
+      'left',
+      'right',
+    ],
     durations: [600, 200, 120, 400, 200, 120, 400, 120, 400, 120, 200, 120, 400, 120, 200, 400],
   },
 
   'lookaround-blink': {
     frames: [
-      'right', 'right', 'right',
-      'left', 'left', 'left',
-      'half-blink', 'squint', 'closed', 'closed', 'squint', 'half-blink',
-      'left', 'right', 'right',
-      'up-right', 'up-right', 'right',
-      'right', 'right',
-      'up-left', 'up-left', 'left', 'left',
-      'half-blink', 'squint', 'closed', 'closed', 'squint', 'half-blink',
-      'right', 'right',
+      'right',
+      'right',
+      'right',
+      'left',
+      'left',
+      'left',
+      'half-blink',
+      'squint',
+      'closed',
+      'closed',
+      'squint',
+      'half-blink',
+      'left',
+      'right',
+      'right',
+      'up-right',
+      'up-right',
+      'right',
+      'right',
+      'right',
+      'up-left',
+      'up-left',
+      'left',
+      'left',
+      'half-blink',
+      'squint',
+      'closed',
+      'closed',
+      'squint',
+      'half-blink',
+      'right',
+      'right',
     ],
     durations: [
-      800, 200, 200,
-      120, 400, 200,
-      50, 50, 50, 80, 50, 50,
-      200, 120, 400,
-      120, 500, 120,
-      200, 200,
-      120, 500, 120, 200,
-      50, 50, 50, 80, 50, 50,
-      120, 600,
+      800, 200, 200, 120, 400, 200, 50, 50, 50, 80, 50, 50, 200, 120, 400, 120, 500, 120, 200, 200, 120, 500, 120, 200,
+      50, 50, 50, 80, 50, 50, 120, 600,
     ],
   },
 
   all: {
     frames: [
       // idle, look around
-      'right', 'right', 'right',
-      'left', 'left', 'left',
-      'right', 'right',
+      'right',
+      'right',
+      'right',
+      'left',
+      'left',
+      'left',
+      'right',
+      'right',
       // blink
-      'half-blink', 'squint', 'closed', 'closed', 'squint', 'half-blink',
+      'half-blink',
+      'squint',
+      'closed',
+      'closed',
+      'squint',
+      'half-blink',
       // look up + bounce
-      'right', 'right',
-      'up-right', 'up-right', 'right',
-      'right:up', 'right:up', 'right', 'right:up', 'right:up', 'right',
+      'right',
+      'right',
+      'up-right',
+      'up-right',
+      'right',
+      'right:up',
+      'right:up',
+      'right',
+      'right:up',
+      'right:up',
+      'right',
       // look the other way
-      'right', 'left', 'left',
-      'up-left', 'up-left', 'left',
+      'right',
+      'left',
+      'left',
+      'up-left',
+      'up-left',
+      'left',
       // blink
-      'half-blink', 'squint', 'closed', 'closed', 'squint', 'half-blink',
+      'half-blink',
+      'squint',
+      'closed',
+      'closed',
+      'squint',
+      'half-blink',
       // bounce
-      'left', 'left:up', 'left:up', 'left', 'left:up', 'left:up', 'left',
+      'left',
+      'left:up',
+      'left:up',
+      'left',
+      'left:up',
+      'left:up',
+      'left',
       // settle back + bounce
-      'right', 'right', 'right',
-      'right:up', 'right:up', 'right',
+      'right',
+      'right',
+      'right',
+      'right:up',
+      'right:up',
+      'right',
       // blink
-      'half-blink', 'squint', 'closed', 'closed', 'squint', 'half-blink',
-      'right', 'right',
+      'half-blink',
+      'squint',
+      'closed',
+      'closed',
+      'squint',
+      'half-blink',
+      'right',
+      'right',
     ],
     durations: [
       // idle, look around
-      800, 200, 200,
-      120, 400, 200,
-      120, 400,
+      800, 200, 200, 120, 400, 200, 120, 400,
       // blink
       50, 50, 50, 80, 50, 50,
       // look up + bounce
-      200, 200,
-      120, 500, 120,
-      150, 150, 150, 150, 150, 200,
+      200, 200, 120, 500, 120, 150, 150, 150, 150, 150, 200,
       // look the other way
-      300, 120, 400,
-      120, 500, 120,
+      300, 120, 400, 120, 500, 120,
       // blink
       50, 50, 50, 80, 50, 50,
       // bounce
       200, 150, 150, 150, 150, 150, 200,
       // settle back + bounce
-      120, 200, 300,
-      150, 150, 200,
+      120, 200, 300, 150, 150, 200,
       // blink
-      50, 50, 50, 80, 50, 50,
-      200, 800,
+      50, 50, 50, 80, 50, 50, 200, 800,
     ],
   },
 };
@@ -253,7 +344,7 @@ export function header(opts = {}) {
   const icon = eyes(expression);
   const gap = '  ';
 
-  const title = chalk.bold.hex(currentPalette.body)('The ReadMe CLI') + (version ? ' ' + chalk.dim(`v${version}`) : '');
+  const title = chalk.bold.hex(currentPalette.body)('The ReadMe CLI') + (version ? ` ${chalk.dim(`v${version}`)}` : '');
   const bin = binName ? chalk.white(binName) : '';
   const greetLine = greeting ? chalk.dim(greeting) : '';
 
@@ -296,7 +387,8 @@ export function animate(name, opts = {}) {
   const headerLines = [];
   if (version || bin) {
     const gap = '  ';
-    headerLines[0] = gap + chalk.bold.hex(currentPalette.body)('The ReadMe CLI') + (version ? ' ' + chalk.dim(`v${version}`) : '');
+    headerLines[0] =
+      gap + chalk.bold.hex(currentPalette.body)('The ReadMe CLI') + (version ? ` ${chalk.dim(`v${version}`)}` : '');
     headerLines[1] = gap + (bin ? chalk.white(bin) : '');
     if (subtitle) headerLines[2] = gap + subtitle;
   }
@@ -340,7 +432,7 @@ export function animate(name, opts = {}) {
       firstDraw = false;
 
       for (const line of lines) {
-        process.stdout.write(indent + line + '\n');
+        process.stdout.write(`${indent + line}\n`);
       }
 
       const duration = anim.durations[i % anim.durations.length];

package/src/utils/git.js

@@ -63,10 +63,10 @@ export function detectRemotePlatform() {
   const remotes = readRemotes();
   if (!remotes) return null;
   for (const [key, def] of Object.entries(PLATFORMS)) {
-    if (def.remoteHosts && def.remoteHosts.some((h) => remotes.toLowerCase().includes(h))) {
+    if (def.remoteHosts && def.remoteHosts.some(h => remotes.toLowerCase().includes(h))) {
       return key;
     }
-    if (def.remotePathHints && def.remotePathHints.some((p) => remotes.toLowerCase().includes(p))) {
+    if (def.remotePathHints && def.remotePathHints.some(p => remotes.toLowerCase().includes(p))) {
       return key;
     }
   }
@@ -81,7 +81,7 @@ export function detectExistingCi(gitRoot) {
   if (!gitRoot) return [];
   const found = [];
   for (const [key, def] of Object.entries(PLATFORMS)) {
-    const hit = def.fsMarkers.some((marker) => fs.existsSync(path.join(gitRoot, marker)));
+    const hit = def.fsMarkers.some(marker => fs.existsSync(path.join(gitRoot, marker)));
     if (hit) found.push(key);
   }
   return found;

package/src/utils/lint.js

@@ -1,15 +1,16 @@
-import fs from 'node:fs'
-import path from 'node:path'
-import * as componentsValidator from '../validators/components.js'
-import * as contentValidator from '../validators/content.js'
-import * as duplicatesValidator from '../validators/duplicates.js'
-import * as frontmatterValidator from '../validators/frontmatter.js'
-import * as linksValidator from '../validators/links.js'
-import * as nestingValidator from '../validators/nesting.js'
-import * as oasReferenceValidator from '../validators/oas-reference.js'
-import * as oasSchemaValidator from '../validators/oas-schema.js'
-import * as orderingValidator from '../validators/ordering.js'
-import * as recipesValidator from '../validators/recipes.js'
+import fs from 'node:fs';
+import path from 'node:path';
+
+import * as componentsValidator from '../validators/components.js';
+import * as contentValidator from '../validators/content.js';
+import * as duplicatesValidator from '../validators/duplicates.js';
+import * as frontmatterValidator from '../validators/frontmatter.js';
+import * as linksValidator from '../validators/links.js';
+import * as nestingValidator from '../validators/nesting.js';
+import * as oasReferenceValidator from '../validators/oas-reference.js';
+import * as oasSchemaValidator from '../validators/oas-schema.js';
+import * as orderingValidator from '../validators/ordering.js';
+import * as recipesValidator from '../validators/recipes.js';
 
 const TARGET_PATTERNS = [
   { dir: 'custom_blocks', ext: ['.mdx', '.md'] },
@@ -17,28 +18,28 @@ const TARGET_PATTERNS = [
   { dir: 'reference', ext: '.md' },
   { dir: 'custom_pages', ext: '.md' },
   { dir: 'recipes', ext: '.md' },
-]
+];
 
 /**
  * Collect all target files from the repo root.
  */
 export function collectFiles(gitRoot) {
-  const files = []
+  const files = [];
 
   for (const { dir, ext } of TARGET_PATTERNS) {
-    const dirPath = path.join(gitRoot, dir)
-    if (!fs.existsSync(dirPath)) continue
+    const dirPath = path.join(gitRoot, dir);
+    if (!fs.existsSync(dirPath)) continue;
 
-    const exts = Array.isArray(ext) ? ext : [ext]
-    const entries = fs.readdirSync(dirPath, { recursive: true })
+    const exts = Array.isArray(ext) ? ext : [ext];
+    const entries = fs.readdirSync(dirPath, { recursive: true });
     for (const entry of entries) {
-      if (exts.some((e) => entry.endsWith(e))) {
-        files.push(path.join(dir, entry))
+      if (exts.some(e => entry.endsWith(e))) {
+        files.push(path.join(dir, entry));
       }
     }
   }
 
-  return files.sort()
+  return files.sort();
 }
 
 // Every validator in src/validators/, imported statically (rather than
@@ -57,14 +58,14 @@ const ALL_VALIDATORS = [
   oasSchemaValidator,
   orderingValidator,
   recipesValidator,
-]
+];
 
 /**
  * Validators can export `validate()` for per-file checks and/or
  * `validateAll()` for cross-file checks (like ordering).
  */
 function loadValidators() {
-  return ALL_VALIDATORS.filter((mod) => mod.name && (mod.validate || mod.validateAll))
+  return ALL_VALIDATORS.filter(mod => mod.name && (mod.validate || mod.validateAll));
 }
 
 /**
@@ -73,42 +74,42 @@ function loadValidators() {
  * Calls `onFile(relativePath)` before processing each file (for progress reporting).
  */
 export async function runValidators(files, gitRoot, { onFile, onBeforeCrossFile, fix, nonInteractive } = {}) {
-  const validators = await loadValidators()
-  const results = []
+  const validators = await loadValidators();
+  const results = [];
 
   // Per-file validators.
   for (const relativePath of files) {
-    if (onFile) onFile(relativePath)
+    if (onFile) onFile(relativePath);
 
-    const filePath = path.join(gitRoot, relativePath)
-    const content = fs.readFileSync(filePath, 'utf-8')
+    const filePath = path.join(gitRoot, relativePath);
+    const content = fs.readFileSync(filePath, 'utf-8');
 
     for (const validator of validators) {
-      if (!validator.validate) continue
-      const result = validator.validate({ filePath, content, relativePath, fix })
+      if (!validator.validate) continue;
+      const result = validator.validate({ filePath, content, relativePath, fix });
       if (result) {
         if (Array.isArray(result)) {
-          results.push(...result)
+          results.push(...result);
         } else {
-          results.push(result)
+          results.push(result);
         }
       }
     }
   }
 
   // Cross-file validators — stop the spinner first so interactive prompts work.
-  if (onBeforeCrossFile) onBeforeCrossFile()
+  if (onBeforeCrossFile) onBeforeCrossFile();
   for (const validator of validators) {
-    if (!validator.validateAll) continue
-    const result = await validator.validateAll(files, gitRoot, { fix, nonInteractive })
+    if (!validator.validateAll) continue;
+    const result = await validator.validateAll(files, gitRoot, { fix, nonInteractive });
     if (result) {
       if (Array.isArray(result)) {
-        results.push(...result)
+        results.push(...result);
       } else {
-        results.push(result)
+        results.push(result);
       }
     }
   }
 
-  return results
+  return results;
 }