@writechoice/mint-cli 0.0.1 → 0.0.3

package/README.md

@@ -15,7 +15,7 @@ CLI tool for Mintlify documentation validation and utilities.
 ### Global Installation
 
 ```bash
-npm install -g writechoice-mint-cli
+npm install -g @writechoice/mint-cli
 ```
 
 ### Local Development
@@ -40,6 +40,26 @@ npm link
 
 ## Usage
 
+### Check Version
+
+Check the installed version:
+
+```bash
+writechoice --version
+# or
+writechoice -V
+```
+
+### Update to Latest Version
+
+Update to the latest version from npm:
+
+```bash
+writechoice update
+```
+
+The CLI also automatically checks for updates and displays a notification when a new version is available.
+
 ### Validate Links
 
 Validate all internal links and anchors in your MDX documentation:
@@ -122,6 +142,10 @@ The tool extracts internal links from MDX files in the following formats:
 3. **JSX Card components**: `<Card href="/path/to/page" title="Card Title" />`
 4. **JSX Button components**: `<Button href="/path/to/page#anchor">Button Text</Button>`
 
+**Images are automatically ignored:**
+- Markdown images: `![Alt Text](./image.png)`
+- HTML images: `<img src="./image.png" />`
+
 ### Validation Process
 
 1. **Local Validation**: First checks if the target MDX file exists locally
@@ -209,6 +233,27 @@ writechoice check links docs.example.com -o my_report.json
 writechoice check links docs.example.com --fix-from-report my_report.json
 ```
 
+## Updates
+
+The CLI automatically checks for new versions and displays a notification when an update is available:
+
+```
+┌─────────────────────────────────────────────────┐
+│  Update available: 0.0.2 → 0.0.3                │
+│  Run: writechoice update                        │
+└─────────────────────────────────────────────────┘
+```
+
+To update manually:
+
+```bash
+# Using the built-in update command (recommended)
+writechoice update
+
+# Or using npm directly
+npm install -g @writechoice/mint-cli@latest
+```
+
 ## Configuration
 
 ### Excluded Directories

package/bin/cli.js

@@ -4,6 +4,7 @@ import { Command } from "commander";
 import { fileURLToPath } from "url";
 import { dirname, join } from "path";
 import { readFileSync } from "fs";
+import { execSync } from "child_process";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -16,7 +17,7 @@ const program = new Command();
 program
   .name("writechoice")
   .description("CLI tool for Mintlify documentation validation and utilities")
-  .version(packageJson.version);
+  .version(packageJson.version, "-V, --version", "Output the current version");
 
 // Validate command
 const check = program.command("check").description("Validation commands for documentation");
@@ -41,4 +42,66 @@ check
     await validateLinks(baseUrl, options);
   });
 
+// Update command
+program
+  .command("update")
+  .description("Update @writechoice/mint-cli to the latest version")
+  .action(async () => {
+    console.log("Checking for updates...");
+
+    try {
+      // Get latest version from npm
+      const latestVersion = execSync(
+        `npm view ${packageJson.name} version`,
+        { encoding: "utf-8" }
+      ).trim();
+
+      const currentVersion = packageJson.version;
+
+      if (latestVersion === currentVersion) {
+        console.log(`✓ You're already on the latest version (${currentVersion})`);
+        return;
+      }
+
+      console.log(`\nUpdate available: ${currentVersion} → ${latestVersion}`);
+      console.log(`\nUpdating ${packageJson.name}...`);
+
+      // Update the package
+      execSync(`npm install -g ${packageJson.name}@latest`, {
+        stdio: "inherit",
+      });
+
+      console.log(`\n✓ Successfully updated to version ${latestVersion}`);
+    } catch (error) {
+      console.error("Error checking for updates:", error.message);
+      console.log("\nYou can manually update with:");
+      console.log(`  npm install -g ${packageJson.name}@latest`);
+      process.exit(1);
+    }
+  });
+
+// Check for updates on every command (non-blocking)
+async function checkForUpdates() {
+  try {
+    const latestVersion = execSync(
+      `npm view ${packageJson.name} version 2>/dev/null`,
+      { encoding: "utf-8", timeout: 2000 }
+    ).trim();
+
+    const currentVersion = packageJson.version;
+
+    if (latestVersion && latestVersion !== currentVersion) {
+      console.log(`\n┌─────────────────────────────────────────────────┐`);
+      console.log(`│  Update available: ${currentVersion} → ${latestVersion.padEnd(24)} │`);
+      console.log(`│  Run: writechoice update                       │`);
+      console.log(`└─────────────────────────────────────────────────┘\n`);
+    }
+  } catch (error) {
+    // Silently fail - don't interrupt the user
+  }
+}
+
+// Run update check in background (don't block execution)
+checkForUpdates();
+
 program.parse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@writechoice/mint-cli",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "CLI tool for Mintlify documentation validation and utilities",
   "main": "src/index.js",
   "type": "module",

package/src/commands/validate/links.js

@@ -35,7 +35,9 @@ const DEFAULT_CONCURRENCY = 25;
 // Link extraction patterns
 const LINK_PATTERNS = {
   markdown: /\[([^\]]+?)\]\(([^)]+?)\)/g,
+  markdownImage: /!\[([^\]]*?)\]\(([^)]+?)\)/g,
   htmlAnchor: /<a\s+href=["'](.*?)["'][^>]*?>(.*?)<\/a>/gs,
+  htmlImage: /<img[^>]+src=["'](.*?)["'][^>]*?>/gi,
   jsxCard: /<Card[^>]+?href=["'](.*?)["'][^>]*?(?:title=["'](.*?)["'])?[^>]*?>/g,
   jsxButton: /<Button[^>]+?href=["'](.*?)["'][^>]*?>(.*?)<\/Button>/gs,
 };
@@ -213,9 +215,31 @@ function extractLinksFromFile(filePath, baseUrl, repoRoot, verbose = false) {
   const { cleanedContent } = removeCodeBlocksAndFrontmatter(content);
   const links = [];
 
-  // Extract markdown links [text](url)
+  // Collect all image positions to skip them
+  const imagePositions = new Set();
+
+  // Find all markdown images ![alt](url)
+  const markdownImages = [...cleanedContent.matchAll(LINK_PATTERNS.markdownImage)];
+  for (const match of markdownImages) {
+    imagePositions.add(match.index);
+  }
+
+  // Find all HTML images <img src="url">
+  const htmlImages = [...cleanedContent.matchAll(LINK_PATTERNS.htmlImage)];
+  for (const match of htmlImages) {
+    imagePositions.add(match.index);
+  }
+
+  // Extract markdown links [text](url) - skip images
   const markdownMatches = [...cleanedContent.matchAll(LINK_PATTERNS.markdown)];
   for (const match of markdownMatches) {
+    // Check if this is actually an image by looking at the character before '['
+    const charBefore = match.index > 0 ? cleanedContent[match.index - 1] : '';
+    if (charBefore === '!') {
+      // This is a markdown image ![alt](url), skip it
+      continue;
+    }
+
     const linkText = match[1];
     const href = match[2];