@programinglive/commiter 1.2.8 → 1.2.12

package/scripts/update-release-notes.cjs

@@ -1,182 +1,182 @@
-#!/usr/bin/env node
-
-const fs = require('fs');
-const path = require('path');
-
-function updateReleaseNotes({
-  rootDir = process.cwd(),
-  releaseNotesRelativePath = path.join('docs', 'release-notes', 'RELEASE_NOTES.md'),
-  changelogRelativePath = 'CHANGELOG.md',
-  packageJsonRelativePath = 'package.json',
-  now = () => new Date()
-} = {}) {
-  const releaseNotesPath = path.join(rootDir, releaseNotesRelativePath);
-  if (!fs.existsSync(releaseNotesPath)) {
-    console.log(`ℹ️  Release notes file not found at ${releaseNotesPath}; skipping update.`);
-    return false;
-  }
-
-  const packageJsonPath = path.join(rootDir, packageJsonRelativePath);
-  if (!fs.existsSync(packageJsonPath)) {
-    console.log(`ℹ️  package.json not found at ${packageJsonPath}; skipping release notes update.`);
-    return false;
-  }
-
-  const changelogPath = path.join(rootDir, changelogRelativePath);
-  if (!fs.existsSync(changelogPath)) {
-    console.log(`ℹ️  CHANGELOG not found at ${changelogPath}; skipping release notes update.`);
-    return false;
-  }
-
-  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
-  const version = packageJson.version;
-  if (!version) {
-    console.log('ℹ️  package.json version is missing; skipping release notes update.');
-    return false;
-  }
-
-  const releaseNotesContent = fs.readFileSync(releaseNotesPath, 'utf8');
-  if (releaseNotesContent.includes(`| ${version} `) || releaseNotesContent.includes(`## ${version}`)) {
-    console.log(`ℹ️  Release notes already contain version ${version}; skipping.`);
-    return false;
-  }
-
-  const changelogContent = fs.readFileSync(changelogPath, 'utf8');
-  const changelogInfo = extractChangelogInfo({ changelogContent, version });
-
-  const releaseDate = changelogInfo.date || formatDate(now());
-  const highlight = changelogInfo.highlight || changelogInfo.heading || 'See CHANGELOG for details.';
-  const sectionHeading = changelogInfo.heading || '';
-  const detailBullets = Array.isArray(changelogInfo.bullets) && changelogInfo.bullets.length > 0
-    ? changelogInfo.bullets
-    : [highlight];
-
-  const updatedContent = insertReleaseNotesEntry({
-    content: releaseNotesContent,
-    version,
-    releaseDate,
-    highlight,
-    sectionHeading,
-    detailBullets
-  });
-
-  fs.writeFileSync(releaseNotesPath, updatedContent);
-  console.log(`✅ Added release notes entry for version ${version}.`);
-  return true;
-}
-
-function insertReleaseNotesEntry({ content, version, releaseDate, highlight, sectionHeading, detailBullets }) {
-  const lines = content.split('\n');
-  const headerSeparatorIndex = lines.findIndex((line) => line.trim().startsWith('|---------'));
-  if (headerSeparatorIndex === -1) {
-    throw new Error('Unable to locate release notes table header.');
-  }
-
-  const newRow = `| ${version} | ${releaseDate} | ${escapePipes(highlight)} |`;
-  lines.splice(headerSeparatorIndex + 1, 0, newRow);
-
-  const sectionLines = [];
-  sectionLines.push('');
-  const trimmedHeading = typeof sectionHeading === 'string' ? sectionHeading.trim() : '';
-  const headingSuffix = trimmedHeading ? ` – ${trimmedHeading}` : '';
-  sectionLines.push(`## ${version}${headingSuffix}`);
-  sectionLines.push('');
-  sectionLines.push(`Released on **${releaseDate}**.`);
-  sectionLines.push('');
-  for (const bullet of detailBullets) {
-    sectionLines.push(`- ${bullet}`);
-  }
-  sectionLines.push('');
-
-  const firstSectionIndex = lines.findIndex((line, idx) => idx > headerSeparatorIndex && line.startsWith('## '));
-  if (firstSectionIndex === -1) {
-    lines.push(...sectionLines);
-  } else {
-    lines.splice(firstSectionIndex, 0, ...sectionLines);
-  }
-
-  return lines.join('\n');
-}
-
-function extractChangelogInfo({ changelogContent, version }) {
-  const versionHeadingRegex = new RegExp(`^### \\[${escapeRegExp(version)}\\][^\n]*`, 'm');
-  const match = changelogContent.match(versionHeadingRegex);
-  if (!match) {
-    return {};
-  }
-
-  const headingIndex = match.index;
-  const rest = changelogContent.slice(headingIndex + match[0].length);
-  const nextVersionRegex = /^### \[[^\n]*\]/m;
-  const nextVersionMatch = nextVersionRegex.exec(rest);
-  const section = nextVersionMatch ? rest.slice(0, nextVersionMatch.index) : rest;
-
-  const dateMatch = match[0].match(/\((\d{4}-\d{2}-\d{2})\)/);
-  const date = dateMatch ? dateMatch[1] : undefined;
-
-  const categoryRegex = /^###\s+([^\n]+)$/m;
-  const categoryMatch = section.match(categoryRegex);
-  let heading;
-  if (categoryMatch) {
-    heading = sanitizeText(categoryMatch[1]);
-  }
-
-  const bullets = [];
-  const bulletRegex = /^\*\s+([^\n]+)$/gm;
-  let bulletMatch;
-  while ((bulletMatch = bulletRegex.exec(section)) !== null) {
-    const sanitized = sanitizeText(bulletMatch[1]);
-    if (!bullets.includes(sanitized)) {
-      bullets.push(sanitized);
-    }
-  }
-
-  const highlight = bullets.length > 0 ? bullets[0] : undefined;
-
-  return {
-    date,
-    highlight,
-    heading,
-    bullets
-  };
-}
-
-function sanitizeText(text) {
-  return text
-    .replace(/\[([^\]]+)\]\([^\)]+\)/g, '$1')
-    .replace(/\s+/g, ' ')
-    .trim();
-}
-
-function escapeRegExp(string) {
-  return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-}
-
-function escapePipes(text) {
-  return text.replace(/\|/g, '\\|');
-}
-
-function formatDate(date) {
-  const year = date.getFullYear();
-  const month = String(date.getMonth() + 1).padStart(2, '0');
-  const day = String(date.getDate()).padStart(2, '0');
-  return `${year}-${month}-${day}`;
-}
-
-module.exports = {
-  updateReleaseNotes,
-  insertReleaseNotesEntry,
-  extractChangelogInfo,
-  sanitizeText,
-  escapePipes,
-  formatDate
-};
-
-if (require.main === module) {
-  try {
-    updateReleaseNotes();
-  } catch (error) {
-    console.error(`❌ Failed to update release notes: ${error.message}`);
-    process.exit(1);
-  }
-}
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+function updateReleaseNotes({
+  rootDir = process.cwd(),
+  releaseNotesRelativePath = path.join('docs', 'release-notes', 'RELEASE_NOTES.md'),
+  changelogRelativePath = 'CHANGELOG.md',
+  packageJsonRelativePath = 'package.json',
+  now = () => new Date()
+} = {}) {
+  const releaseNotesPath = path.join(rootDir, releaseNotesRelativePath);
+  if (!fs.existsSync(releaseNotesPath)) {
+    console.log(`ℹ️  Release notes file not found at ${releaseNotesPath}; skipping update.`);
+    return false;
+  }
+
+  const packageJsonPath = path.join(rootDir, packageJsonRelativePath);
+  if (!fs.existsSync(packageJsonPath)) {
+    console.log(`ℹ️  package.json not found at ${packageJsonPath}; skipping release notes update.`);
+    return false;
+  }
+
+  const changelogPath = path.join(rootDir, changelogRelativePath);
+  if (!fs.existsSync(changelogPath)) {
+    console.log(`ℹ️  CHANGELOG not found at ${changelogPath}; skipping release notes update.`);
+    return false;
+  }
+
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+  const version = packageJson.version;
+  if (!version) {
+    console.log('ℹ️  package.json version is missing; skipping release notes update.');
+    return false;
+  }
+
+  const releaseNotesContent = fs.readFileSync(releaseNotesPath, 'utf8');
+  if (releaseNotesContent.includes(`| ${version} `) || releaseNotesContent.includes(`## ${version}`)) {
+    console.log(`ℹ️  Release notes already contain version ${version}; skipping.`);
+    return false;
+  }
+
+  const changelogContent = fs.readFileSync(changelogPath, 'utf8');
+  const changelogInfo = extractChangelogInfo({ changelogContent, version });
+
+  const releaseDate = changelogInfo.date || formatDate(now());
+  const highlight = changelogInfo.highlight || changelogInfo.heading || 'See CHANGELOG for details.';
+  const sectionHeading = changelogInfo.heading || '';
+  const detailBullets = Array.isArray(changelogInfo.bullets) && changelogInfo.bullets.length > 0
+    ? changelogInfo.bullets
+    : [highlight];
+
+  const updatedContent = insertReleaseNotesEntry({
+    content: releaseNotesContent,
+    version,
+    releaseDate,
+    highlight,
+    sectionHeading,
+    detailBullets
+  });
+
+  fs.writeFileSync(releaseNotesPath, updatedContent);
+  console.log(`✅ Added release notes entry for version ${version}.`);
+  return true;
+}
+
+function insertReleaseNotesEntry({ content, version, releaseDate, highlight, sectionHeading, detailBullets }) {
+  const lines = content.split('\n');
+  const headerSeparatorIndex = lines.findIndex((line) => line.trim().startsWith('|---------'));
+  if (headerSeparatorIndex === -1) {
+    throw new Error('Unable to locate release notes table header.');
+  }
+
+  const newRow = `| ${version} | ${releaseDate} | ${escapePipes(highlight)} |`;
+  lines.splice(headerSeparatorIndex + 1, 0, newRow);
+
+  const sectionLines = [];
+  sectionLines.push('');
+  const trimmedHeading = typeof sectionHeading === 'string' ? sectionHeading.trim() : '';
+  const headingSuffix = trimmedHeading ? ` – ${trimmedHeading}` : '';
+  sectionLines.push(`## ${version}${headingSuffix}`);
+  sectionLines.push('');
+  sectionLines.push(`Released on **${releaseDate}**.`);
+  sectionLines.push('');
+  for (const bullet of detailBullets) {
+    sectionLines.push(`- ${bullet}`);
+  }
+  sectionLines.push('');
+
+  const firstSectionIndex = lines.findIndex((line, idx) => idx > headerSeparatorIndex && line.startsWith('## '));
+  if (firstSectionIndex === -1) {
+    lines.push(...sectionLines);
+  } else {
+    lines.splice(firstSectionIndex, 0, ...sectionLines);
+  }
+
+  return lines.join('\n');
+}
+
+function extractChangelogInfo({ changelogContent, version }) {
+  const versionHeadingRegex = new RegExp(`^### \\[${escapeRegExp(version)}\\][^\n]*`, 'm');
+  const match = changelogContent.match(versionHeadingRegex);
+  if (!match) {
+    return {};
+  }
+
+  const headingIndex = match.index;
+  const rest = changelogContent.slice(headingIndex + match[0].length);
+  const nextVersionRegex = /^### \[[^\n]*\]/m;
+  const nextVersionMatch = nextVersionRegex.exec(rest);
+  const section = nextVersionMatch ? rest.slice(0, nextVersionMatch.index) : rest;
+
+  const dateMatch = match[0].match(/\((\d{4}-\d{2}-\d{2})\)/);
+  const date = dateMatch ? dateMatch[1] : undefined;
+
+  const categoryRegex = /^###\s+([^\n]+)$/m;
+  const categoryMatch = section.match(categoryRegex);
+  let heading;
+  if (categoryMatch) {
+    heading = sanitizeText(categoryMatch[1]);
+  }
+
+  const bullets = [];
+  const bulletRegex = /^\*\s+([^\n]+)$/gm;
+  let bulletMatch;
+  while ((bulletMatch = bulletRegex.exec(section)) !== null) {
+    const sanitized = sanitizeText(bulletMatch[1]);
+    if (!bullets.includes(sanitized)) {
+      bullets.push(sanitized);
+    }
+  }
+
+  const highlight = bullets.length > 0 ? bullets[0] : undefined;
+
+  return {
+    date,
+    highlight,
+    heading,
+    bullets
+  };
+}
+
+function sanitizeText(text) {
+  return text
+    .replace(/\[([^\]]+)\]\([^\)]+\)/g, '$1')
+    .replace(/\s+/g, ' ')
+    .trim();
+}
+
+function escapeRegExp(string) {
+  return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
+function escapePipes(text) {
+  return text.replace(/\|/g, '\\|');
+}
+
+function formatDate(date) {
+  const year = date.getFullYear();
+  const month = String(date.getMonth() + 1).padStart(2, '0');
+  const day = String(date.getDate()).padStart(2, '0');
+  return `${year}-${month}-${day}`;
+}
+
+module.exports = {
+  updateReleaseNotes,
+  insertReleaseNotesEntry,
+  extractChangelogInfo,
+  sanitizeText,
+  escapePipes,
+  formatDate
+};
+
+if (require.main === module) {
+  try {
+    updateReleaseNotes();
+  } catch (error) {
+    console.error(`❌ Failed to update release notes: ${error.message}`);
+    process.exit(1);
+  }
+}

package/web/README.md

@@ -1,79 +1,79 @@
-# Commiter Website
-
-This is the static website for the Commiter project. It can be deployed to any web server or hosting platform.
-
-## 📁 Structure
-
-```
-web/
-├── index.html          # Main landing page
-├── css/
-│   └── style.css      # Styles with modern dark theme
-├── js/
-│   └── script.js      # Interactive features
-└── README.md          # This file
-```
-
-## 🚀 Deployment Options
-
-### Option 1: Plesk / cPanel
-1. Compress the `web` folder contents into a ZIP file
-2. Upload to your Plesk/cPanel file manager
-3. Extract in your public_html or desired directory
-4. Access via your domain
-
-### Option 2: Static Hosting (Netlify, Vercel, GitHub Pages)
-1. Push the `web` folder to a Git repository
-2. Connect to your hosting platform
-3. Set the build directory to `web`
-4. Deploy
-
-### Option 3: Simple HTTP Server (Testing)
-```bash
-# Navigate to the web directory
-cd web
-
-# Python 3
-python -m http.server 8000
-
-# Node.js (if you have http-server installed)
-npx http-server -p 8000
-
-# PHP
-php -S localhost:8000
-```
-
-Then open http://localhost:8000 in your browser.
-
-## 🎨 Features
-
-- **Modern Design**: Dark theme with glassmorphism effects
-- **Fully Responsive**: Works on desktop, tablet, and mobile
-- **Smooth Animations**: Scroll animations and transitions
-- **Interactive Elements**: Copy-to-clipboard, smooth scrolling
-- **SEO Optimized**: Meta tags and semantic HTML
-- **Fast Loading**: Optimized CSS and JavaScript
-
-## 🛠️ Customization
-
-### Colors
-Edit CSS variables in `css/style.css`:
-```css
-:root {
-    --primary: #6366f1;
-    --secondary: #8b5cf6;
-    --accent: #ec4899;
-    /* ... more variables */
-}
-```
-
-### Content
-Edit `index.html` to update:
-- Version numbers
-- Release information
-- Links and URLs
-- Text content
-
-## 📝 License
-
-This website is part of the Commiter project and is released under the MIT License.
+# Commiter Website
+
+This is the static website for the Commiter project. It can be deployed to any web server or hosting platform.
+
+## 📁 Structure
+
+```
+web/
+├── index.html          # Main landing page
+├── css/
+│   └── style.css      # Styles with modern dark theme
+├── js/
+│   └── script.js      # Interactive features
+└── README.md          # This file
+```
+
+## 🚀 Deployment Options
+
+### Option 1: Plesk / cPanel
+1. Compress the `web` folder contents into a ZIP file
+2. Upload to your Plesk/cPanel file manager
+3. Extract in your public_html or desired directory
+4. Access via your domain
+
+### Option 2: Static Hosting (Netlify, Vercel, GitHub Pages)
+1. Push the `web` folder to a Git repository
+2. Connect to your hosting platform
+3. Set the build directory to `web`
+4. Deploy
+
+### Option 3: Simple HTTP Server (Testing)
+```bash
+# Navigate to the web directory
+cd web
+
+# Python 3
+python -m http.server 8000
+
+# Node.js (if you have http-server installed)
+npx http-server -p 8000
+
+# PHP
+php -S localhost:8000
+```
+
+Then open http://localhost:8000 in your browser.
+
+## 🎨 Features
+
+- **Modern Design**: Dark theme with glassmorphism effects
+- **Fully Responsive**: Works on desktop, tablet, and mobile
+- **Smooth Animations**: Scroll animations and transitions
+- **Interactive Elements**: Copy-to-clipboard, smooth scrolling
+- **SEO Optimized**: Meta tags and semantic HTML
+- **Fast Loading**: Optimized CSS and JavaScript
+
+## 🛠️ Customization
+
+### Colors
+Edit CSS variables in `css/style.css`:
+```css
+:root {
+    --primary: #6366f1;
+    --secondary: #8b5cf6;
+    --accent: #ec4899;
+    /* ... more variables */
+}
+```
+
+### Content
+Edit `index.html` to update:
+- Version numbers
+- Release information
+- Links and URLs
+- Text content
+
+## 📝 License
+
+This website is part of the Commiter project and is released under the MIT License.