browser-commander 0.2.0

package/scripts/format-github-release.mjs

@@ -0,0 +1,83 @@
+#!/usr/bin/env node
+
+/**
+ * Format GitHub release notes using the format-release-notes.mjs script
+ * Usage: node scripts/format-github-release.mjs --release-version <version> --repository <repository> --commit-sha <commit_sha>
+ *   release-version: Version number (e.g., 1.0.0)
+ *   repository: GitHub repository (e.g., owner/repo)
+ *   commit_sha: Commit SHA for PR detection
+ *
+ * Uses link-foundation libraries:
+ * - use-m: Dynamic package loading without package.json dependencies
+ * - command-stream: Modern shell command execution with streaming support
+ * - lino-arguments: Unified configuration from CLI args, env vars, and .lenv files
+ */
+
+// Load use-m dynamically
+const { use } = eval(
+  await (await fetch('https://unpkg.com/use-m/use.js')).text()
+);
+
+// Import link-foundation libraries
+const { $ } = await use('command-stream');
+const { makeConfig } = await use('lino-arguments');
+
+// Parse CLI arguments using lino-arguments
+// Note: Using --release-version instead of --version to avoid conflict with yargs' built-in --version flag
+const config = makeConfig({
+  yargs: ({ yargs, getenv }) =>
+    yargs
+      .option('release-version', {
+        type: 'string',
+        default: getenv('VERSION', ''),
+        describe: 'Version number (e.g., 1.0.0)',
+      })
+      .option('repository', {
+        type: 'string',
+        default: getenv('REPOSITORY', ''),
+        describe: 'GitHub repository (e.g., owner/repo)',
+      })
+      .option('commit-sha', {
+        type: 'string',
+        default: getenv('COMMIT_SHA', ''),
+        describe: 'Commit SHA for PR detection',
+      }),
+});
+
+const { releaseVersion: version, repository, commitSha } = config;
+
+if (!version || !repository || !commitSha) {
+  console.error('Error: Missing required arguments');
+  console.error(
+    'Usage: node scripts/format-github-release.mjs --release-version <version> --repository <repository> --commit-sha <commit_sha>'
+  );
+  process.exit(1);
+}
+
+const tag = `v${version}`;
+
+try {
+  // Get the release ID for this version
+  let releaseId = '';
+  try {
+    const result =
+      await $`gh api "repos/${repository}/releases/tags/${tag}" --jq '.id'`.run(
+        { capture: true }
+      );
+    releaseId = result.stdout.trim();
+  } catch {
+    console.log(`\u26A0\uFE0F Could not find release for ${tag}`);
+    process.exit(0);
+  }
+
+  if (releaseId) {
+    console.log(`Formatting release notes for ${tag}...`);
+    // Pass the trigger commit SHA for PR detection
+    // This allows proper PR lookup even if the changelog doesn't have a commit hash
+    await $`node scripts/format-release-notes.mjs --release-id "${releaseId}" --release-version "${tag}" --repository "${repository}" --commit-sha "${commitSha}"`;
+    console.log(`\u2705 Formatted release notes for ${tag}`);
+  }
+} catch (error) {
+  console.error('Error formatting release:', error.message);
+  process.exit(1);
+}

package/scripts/format-release-notes.mjs

@@ -0,0 +1,216 @@
+#!/usr/bin/env node
+
+/**
+ * Script to format GitHub release notes with proper formatting:
+ * - Fix special characters like \n
+ * - Add link to PR that contains the release commit (if found)
+ * - Add shields.io NPM version badge
+ * - Format nicely with proper markdown
+ *
+ * PR Detection Logic:
+ * 1. Extract commit hash from changelog entry (if present)
+ * 2. Fall back to --commit-sha argument (passed from workflow)
+ * 3. Look up PRs that contain the commit via GitHub API
+ * 4. If no PR found, simply don't display any PR link (no guessing)
+ *
+ * Uses link-foundation libraries:
+ * - use-m: Dynamic package loading without package.json dependencies
+ * - command-stream: Modern shell command execution with streaming support
+ * - lino-arguments: Unified configuration from CLI args, env vars, and .lenv files
+ *
+ * Note: Uses --release-version instead of --version to avoid conflict with yargs' built-in --version flag.
+ */
+
+const PACKAGE_NAME = 'browser-commander';
+
+// Load use-m dynamically
+const { use } = eval(
+  await (await fetch('https://unpkg.com/use-m/use.js')).text()
+);
+
+// Import link-foundation libraries
+const { $ } = await use('command-stream');
+const { makeConfig } = await use('lino-arguments');
+
+// Parse CLI arguments using lino-arguments
+// Note: Using --release-version instead of --version to avoid conflict with yargs' built-in --version flag
+const config = makeConfig({
+  yargs: ({ yargs, getenv }) =>
+    yargs
+      .option('release-version', {
+        type: 'string',
+        default: getenv('VERSION', ''),
+        describe: 'Version number (e.g., v0.8.36)',
+      })
+      .option('release-id', {
+        type: 'string',
+        default: getenv('RELEASE_ID', ''),
+        describe: 'GitHub release ID',
+      })
+      .option('repository', {
+        type: 'string',
+        default: getenv('REPOSITORY', ''),
+        describe: 'GitHub repository (e.g., owner/repo)',
+      })
+      .option('commit-sha', {
+        type: 'string',
+        default: getenv('COMMIT_SHA', ''),
+        describe: 'Commit SHA for PR detection',
+      }),
+});
+
+const releaseId = config.releaseId;
+const version = config.releaseVersion;
+const repository = config.repository;
+const passedCommitSha = config.commitSha;
+
+if (!releaseId || !version || !repository) {
+  console.error(
+    'Usage: format-release-notes.mjs --release-id <releaseId> --release-version <version> --repository <repository> [--commit-sha <sha>]'
+  );
+  process.exit(1);
+}
+
+try {
+  // Get current release body
+  const result = await $`gh api repos/${repository}/releases/${releaseId}`.run({
+    capture: true,
+  });
+  const releaseData = JSON.parse(result.stdout);
+
+  const currentBody = releaseData.body || '';
+
+  // Skip if already formatted (has shields.io badge image)
+  if (currentBody.includes('img.shields.io')) {
+    console.log('ℹ️ Release notes already formatted');
+    process.exit(0);
+  }
+
+  // Extract changes section (Major, Minor, or Patch)
+  // This regex handles multiple formats:
+  // 1. With commit hash: "### [Major|Minor|Patch] Changes\n- abc1234: Description"
+  // 2. Without commit hash: "### [Major|Minor|Patch] Changes\n- Description"
+  const changesPattern =
+    /### (Major|Minor|Patch) Changes\s*\n\s*-\s+(?:([a-f0-9]+):\s+)?(.+?)$/s;
+  const changesMatch = currentBody.match(changesPattern);
+
+  let commitHash = null;
+  let rawDescription = null;
+  let changeType = null;
+
+  if (changesMatch) {
+    // Extract: [full match, changeType, commitHash (optional), description]
+    [, changeType, commitHash, rawDescription] = changesMatch;
+    console.log(`ℹ️ Found ${changeType} Changes section`);
+
+    // If commitHash is undefined and description contains it, try to extract
+    if (!commitHash && rawDescription) {
+      // This handles the case where description itself might be null/undefined
+      // and we need to safely check for commit hash at the start
+      const descWithHashMatch = rawDescription.match(/^([a-f0-9]+):\s+(.+)$/s);
+      if (descWithHashMatch) {
+        [, commitHash, rawDescription] = descWithHashMatch;
+      }
+    }
+  } else {
+    console.log('⚠️ Could not parse changes from release notes');
+    console.log('   Looking for pattern: ### [Major|Minor|Patch] Changes');
+    process.exit(0);
+  }
+
+  // Clean up the description:
+  // 1. Convert literal \n sequences (escaped newlines from GitHub API) to actual newlines
+  // 2. Remove leading/trailing quotes (including escaped quotes from command-stream shell escaping)
+  // 3. Remove any trailing npm package links or markdown that might be there
+  // 4. Normalize whitespace while preserving line breaks
+  const cleanDescription = rawDescription
+    .replace(/\\n/g, '\n') // Convert escaped \n to actual newlines
+    .replace(/^(\\['"])+/g, '') // Remove leading escaped quotes (e.g., \', \", \'', \'')
+    .replace(/(['"])+$/g, '') // Remove trailing unescaped quotes (e.g., ', ", '', '')
+    .replace(/^(['"])+/g, '') // Remove leading unescaped quotes
+    .replace(/📦.*$/s, '') // Remove any existing npm package info
+    .replace(/---.*$/s, '') // Remove any existing separators and everything after
+    .trim()
+    .split('\n') // Split by lines
+    .map((line) => line.trim()) // Trim whitespace from each line
+    .join('\n') // Rejoin with newlines
+    .replace(/\n{3,}/g, '\n\n'); // Normalize excessive blank lines (3+ becomes 2)
+
+  // Find the PR that contains the release commit
+  // Uses commit hash from changelog or passed commit SHA from workflow
+  let prNumber = null;
+
+  // Determine which commit SHA to use for PR lookup
+  const commitShaToLookup = commitHash || passedCommitSha;
+
+  if (commitShaToLookup) {
+    const source = commitHash ? 'changelog' : 'workflow';
+    console.log(
+      `ℹ️ Looking up PR for commit ${commitShaToLookup} (from ${source})`
+    );
+
+    try {
+      const prResult =
+        await $`gh api "repos/${repository}/commits/${commitShaToLookup}/pulls"`.run(
+          { capture: true }
+        );
+      const prsData = JSON.parse(prResult.stdout);
+
+      // Find the PR that's not the version bump PR (not "chore: version packages")
+      const relevantPr = prsData.find(
+        (pr) => !pr.title.includes('version packages')
+      );
+
+      if (relevantPr) {
+        prNumber = relevantPr.number;
+        console.log(`✅ Found PR #${prNumber} containing commit`);
+      } else if (prsData.length > 0) {
+        console.log(
+          '⚠️ Found PRs but all are version bump PRs, not linking any'
+        );
+      } else {
+        console.log(
+          'ℹ️ No PR found containing this commit - not adding PR link'
+        );
+      }
+    } catch (error) {
+      console.log('⚠️ Could not find PR for commit', commitShaToLookup);
+      console.log('   Error:', error.message);
+      if (process.env.DEBUG) {
+        console.error(error);
+      }
+    }
+  } else {
+    // No commit hash available from any source
+    console.log('ℹ️ No commit SHA available - not adding PR link');
+  }
+
+  // Build formatted release notes
+  const versionWithoutV = version.replace(/^v/, '');
+  const npmBadge = `[![npm version](https://img.shields.io/badge/npm-${versionWithoutV}-blue.svg)](https://www.npmjs.com/package/${PACKAGE_NAME}/v/${versionWithoutV})`;
+
+  let formattedBody = `${cleanDescription}`;
+
+  // Add PR link if available
+  if (prNumber) {
+    formattedBody += `\n\n**Related Pull Request:** #${prNumber}`;
+  }
+
+  formattedBody += `\n\n---\n\n${npmBadge}`;
+
+  // Update the release using JSON input to properly handle special characters
+  const updatePayload = JSON.stringify({ body: formattedBody });
+  await $`gh api repos/${repository}/releases/${releaseId} -X PATCH --input -`.run(
+    { stdin: updatePayload }
+  );
+
+  console.log(`✅ Formatted release notes for v${versionWithoutV}`);
+  if (prNumber) {
+    console.log(`   - Added link to PR #${prNumber}`);
+  }
+  console.log('   - Added shields.io npm badge');
+  console.log('   - Cleaned up formatting');
+} catch (error) {
+  console.error('❌ Error formatting release notes:', error.message);
+  process.exit(1);
+}

package/scripts/instant-version-bump.mjs

@@ -0,0 +1,121 @@
+#!/usr/bin/env node
+
+/**
+ * Instant version bump script for manual releases
+ * Bypasses the changeset workflow and directly updates version and changelog
+ *
+ * Usage: node scripts/instant-version-bump.mjs --bump-type <major|minor|patch> [--description <description>]
+ *
+ * Uses link-foundation libraries:
+ * - use-m: Dynamic package loading without package.json dependencies
+ * - command-stream: Modern shell command execution with streaming support
+ * - lino-arguments: Unified configuration from CLI args, env vars, and .lenv files
+ */
+
+import { readFileSync, writeFileSync } from 'fs';
+
+// Load use-m dynamically
+const { use } = eval(
+  await (await fetch('https://unpkg.com/use-m/use.js')).text()
+);
+
+// Import link-foundation libraries
+const { $ } = await use('command-stream');
+const { makeConfig } = await use('lino-arguments');
+
+// Parse CLI arguments using lino-arguments
+const config = makeConfig({
+  yargs: ({ yargs, getenv }) =>
+    yargs
+      .option('bump-type', {
+        type: 'string',
+        default: getenv('BUMP_TYPE', ''),
+        describe: 'Version bump type: major, minor, or patch',
+        choices: ['major', 'minor', 'patch'],
+      })
+      .option('description', {
+        type: 'string',
+        default: getenv('DESCRIPTION', ''),
+        describe: 'Description for the version bump',
+      }),
+});
+
+try {
+  const { bumpType, description } = config;
+  const finalDescription = description || `Manual ${bumpType} release`;
+
+  if (!bumpType || !['major', 'minor', 'patch'].includes(bumpType)) {
+    console.error(
+      'Usage: node scripts/instant-version-bump.mjs --bump-type <major|minor|patch> [--description <description>]'
+    );
+    process.exit(1);
+  }
+
+  console.log(`\nBumping version (${bumpType})...`);
+
+  // Get current version
+  const packageJson = JSON.parse(readFileSync('package.json', 'utf-8'));
+  const oldVersion = packageJson.version;
+  console.log(`Current version: ${oldVersion}`);
+
+  // Bump version using npm version (doesn't create git tag)
+  await $`npm version ${bumpType} --no-git-tag-version`;
+
+  // Get new version
+  const updatedPackageJson = JSON.parse(readFileSync('package.json', 'utf-8'));
+  const newVersion = updatedPackageJson.version;
+  console.log(`New version: ${newVersion}`);
+
+  // Update CHANGELOG.md
+  console.log('\nUpdating CHANGELOG.md...');
+  const changelogPath = 'CHANGELOG.md';
+  let changelog = readFileSync(changelogPath, 'utf-8');
+
+  // Create new changelog entry
+  const newEntry = `## ${newVersion}
+
+### ${bumpType.charAt(0).toUpperCase() + bumpType.slice(1)} Changes
+
+- ${finalDescription}
+
+`;
+
+  // Insert new entry after the first heading (# Changelog or similar)
+  // Look for the first ## heading and insert before it
+  const firstVersionMatch = changelog.match(/^## /m);
+
+  if (firstVersionMatch) {
+    const insertPosition = firstVersionMatch.index;
+    changelog =
+      changelog.slice(0, insertPosition) +
+      newEntry +
+      changelog.slice(insertPosition);
+  } else {
+    // If no version headings exist, append after the main heading
+    const mainHeadingMatch = changelog.match(/^# .+$/m);
+    if (mainHeadingMatch) {
+      const insertPosition =
+        mainHeadingMatch.index + mainHeadingMatch[0].length;
+      changelog = `${changelog.slice(0, insertPosition)}\n\n${newEntry}${changelog.slice(insertPosition)}`;
+    } else {
+      // If no headings at all, prepend
+      changelog = `${newEntry}\n${changelog}`;
+    }
+  }
+
+  writeFileSync(changelogPath, changelog, 'utf-8');
+  console.log('✅ CHANGELOG.md updated');
+
+  // Synchronize package-lock.json
+  console.log('\nSynchronizing package-lock.json...');
+  await $`npm install --package-lock-only`;
+
+  console.log('\n✅ Instant version bump complete');
+  console.log(`Version: ${oldVersion} → ${newVersion}`);
+} catch (error) {
+  console.error('Error during instant version bump:', error.message);
+  if (process.env.DEBUG) {
+    console.error('Stack trace:', error.stack);
+  }
+  process.exit(1);
+}

package/scripts/merge-changesets.mjs

@@ -0,0 +1,260 @@
+#!/usr/bin/env node
+
+/**
+ * Merge multiple changeset files into a single changeset
+ *
+ * Key behavior:
+ * - Combines all pending changesets into a single changeset file
+ * - Uses the highest version bump type (major > minor > patch)
+ * - Preserves all descriptions in chronological order (by file modification time)
+ * - Removes the individual changeset files after merging
+ * - Does nothing if there's only one or no changesets
+ *
+ * This script is run before `changeset version` to ensure a clean release
+ * even when multiple PRs have merged before a release cycle.
+ */
+
+import {
+  readdirSync,
+  readFileSync,
+  writeFileSync,
+  unlinkSync,
+  statSync,
+} from 'fs';
+import { join } from 'path';
+
+const PACKAGE_NAME = 'browser-commander';
+const CHANGESET_DIR = '.changeset';
+
+// Version bump type priority (higher number = higher priority)
+const BUMP_PRIORITY = {
+  patch: 1,
+  minor: 2,
+  major: 3,
+};
+
+/**
+ * Generate a random changeset file name (similar to what @changesets/cli does)
+ * @returns {string}
+ */
+function generateChangesetName() {
+  const adjectives = [
+    'bright',
+    'calm',
+    'cool',
+    'cyan',
+    'dark',
+    'fast',
+    'gold',
+    'good',
+    'green',
+    'happy',
+    'kind',
+    'loud',
+    'neat',
+    'nice',
+    'pink',
+    'proud',
+    'quick',
+    'red',
+    'rich',
+    'safe',
+    'shy',
+    'soft',
+    'sweet',
+    'tall',
+    'warm',
+    'wise',
+    'young',
+  ];
+  const nouns = [
+    'apple',
+    'bird',
+    'book',
+    'car',
+    'cat',
+    'cloud',
+    'desk',
+    'dog',
+    'door',
+    'fish',
+    'flower',
+    'frog',
+    'grass',
+    'house',
+    'key',
+    'lake',
+    'leaf',
+    'moon',
+    'mouse',
+    'owl',
+    'park',
+    'rain',
+    'river',
+    'rock',
+    'sea',
+    'star',
+    'sun',
+    'tree',
+    'wave',
+    'wind',
+  ];
+
+  const randomAdjective =
+    adjectives[Math.floor(Math.random() * adjectives.length)];
+  const randomNoun = nouns[Math.floor(Math.random() * nouns.length)];
+
+  return `${randomAdjective}-${randomNoun}`;
+}
+
+/**
+ * Parse a changeset file and extract its metadata
+ * @param {string} filePath
+ * @returns {{type: string, description: string, mtime: Date} | null}
+ */
+function parseChangeset(filePath) {
+  try {
+    const content = readFileSync(filePath, 'utf-8');
+    const stats = statSync(filePath);
+
+    // Extract version type - support both quoted and unquoted package names
+    const versionTypeRegex = new RegExp(
+      `^['"]?${PACKAGE_NAME.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}['"]?:\\s+(major|minor|patch)`,
+      'm'
+    );
+    const versionTypeMatch = content.match(versionTypeRegex);
+
+    if (!versionTypeMatch) {
+      console.warn(
+        `Warning: Could not parse version type from ${filePath}, skipping`
+      );
+      return null;
+    }
+
+    // Extract description
+    const parts = content.split('---');
+    const description =
+      parts.length >= 3 ? parts.slice(2).join('---').trim() : '';
+
+    return {
+      type: versionTypeMatch[1],
+      description,
+      mtime: stats.mtime,
+    };
+  } catch (error) {
+    console.warn(`Warning: Failed to parse ${filePath}: ${error.message}`);
+    return null;
+  }
+}
+
+/**
+ * Get the highest priority bump type
+ * @param {string[]} types
+ * @returns {string}
+ */
+function getHighestBumpType(types) {
+  let highest = 'patch';
+  for (const type of types) {
+    if (BUMP_PRIORITY[type] > BUMP_PRIORITY[highest]) {
+      highest = type;
+    }
+  }
+  return highest;
+}
+
+/**
+ * Create a merged changeset file
+ * @param {string} type
+ * @param {string[]} descriptions
+ * @returns {string}
+ */
+function createMergedChangeset(type, descriptions) {
+  const combinedDescription = descriptions.join('\n\n');
+
+  return `---
+'${PACKAGE_NAME}': ${type}
+---
+
+${combinedDescription}
+`;
+}
+
+function main() {
+  console.log('Checking for multiple changesets to merge...');
+
+  // Get all changeset files
+  const changesetFiles = readdirSync(CHANGESET_DIR).filter(
+    (file) => file.endsWith('.md') && file !== 'README.md'
+  );
+
+  console.log(`Found ${changesetFiles.length} changeset file(s)`);
+
+  // If 0 or 1 changesets, nothing to merge
+  if (changesetFiles.length <= 1) {
+    console.log('No merging needed (0 or 1 changeset found)');
+    return;
+  }
+
+  console.log('Multiple changesets found, merging...');
+  changesetFiles.forEach((file) => console.log(`  - ${file}`));
+
+  // Parse all changesets
+  const parsedChangesets = [];
+  for (const file of changesetFiles) {
+    const filePath = join(CHANGESET_DIR, file);
+    const parsed = parseChangeset(filePath);
+    if (parsed) {
+      parsedChangesets.push({
+        file,
+        filePath,
+        ...parsed,
+      });
+    }
+  }
+
+  if (parsedChangesets.length === 0) {
+    console.error('Error: No valid changesets could be parsed');
+    process.exit(1);
+  }
+
+  // Sort by modification time (oldest first) to preserve chronological order
+  parsedChangesets.sort((a, b) => a.mtime.getTime() - b.mtime.getTime());
+
+  // Determine the highest bump type
+  const bumpTypes = parsedChangesets.map((c) => c.type);
+  const highestBumpType = getHighestBumpType(bumpTypes);
+
+  console.log(`\nMerge summary:`);
+  console.log(`  Bump types found: ${[...new Set(bumpTypes)].join(', ')}`);
+  console.log(`  Using highest: ${highestBumpType}`);
+
+  // Collect descriptions in chronological order
+  const descriptions = parsedChangesets
+    .filter((c) => c.description)
+    .map((c) => c.description);
+
+  console.log(`  Descriptions to merge: ${descriptions.length}`);
+
+  // Create merged changeset content
+  const mergedContent = createMergedChangeset(highestBumpType, descriptions);
+
+  // Generate a unique name for the merged changeset
+  const mergedFileName = `merged-${generateChangesetName()}.md`;
+  const mergedFilePath = join(CHANGESET_DIR, mergedFileName);
+
+  // Write the merged changeset
+  writeFileSync(mergedFilePath, mergedContent);
+  console.log(`\nCreated merged changeset: ${mergedFileName}`);
+
+  // Remove the original changeset files
+  console.log('\nRemoving original changeset files:');
+  for (const changeset of parsedChangesets) {
+    unlinkSync(changeset.filePath);
+    console.log(`  Removed: ${changeset.file}`);
+  }
+
+  console.log('\nChangeset merge completed successfully');
+  console.log(`\nMerged changeset content:\n${mergedContent}`);
+}
+
+main();