@logickernel/agileflow 0.2.0 → 0.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logickernel/agileflow",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Automatic semantic versioning and changelog generation based on conventional commits",
   "main": "src/index.js",
   "bin": {
@@ -34,6 +34,6 @@
     "type": "git",
     "url": "git@code.logickernel.com:kernel/agileflow.git"
   },
-  "author": "",
+  "author": "Víctor H. Valle <victor.valle@logickernel.com>",
   "license": "ISC"
 }

package/src/git-push.js

@@ -1,6 +1,9 @@
 'use strict';
 
-const { run } = require('./utils');
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
 
 /**
  * Creates an annotated tag and pushes it to the remote repository.
@@ -11,16 +14,27 @@ const { run } = require('./utils');
  */
 async function pushTag(tagName, message) {
   const safeTag = String(tagName).replace(/"/g, '\\"');
-  const safeMsg = String(message).replace(/"/g, '\\"');
   
-  // Create annotated tag
-  run(`git tag -a "${safeTag}" -m "${safeMsg}"`);
-  
-  // Push to origin
-  run(`git push origin "${safeTag}"`);
+  // Write message to a temp file to avoid shell escaping issues with special characters
+  const tempFile = path.join(os.tmpdir(), `agileflow-tag-${Date.now()}.txt`);
+  try {
+    fs.writeFileSync(tempFile, message, 'utf8');
+    
+    // Create annotated tag using -F to read message from file
+    execSync(`git tag -a "${safeTag}" -F "${tempFile}"`, { stdio: 'pipe' });
+    
+    // Push to origin
+    execSync(`git push origin "${safeTag}"`, { stdio: 'pipe' });
+  } finally {
+    // Clean up temp file
+    try {
+      fs.unlinkSync(tempFile);
+    } catch {
+      // Ignore cleanup errors
+    }
+  }
 }
 
 module.exports = {
   pushTag,
 };
-

package/src/index.js

@@ -38,24 +38,32 @@ function parseArgs(args) {
 
 /**
  * Displays version info to the console.
- * @param {{currentVersion: string|null, nextVersion: string|null, commits: Array, changelog: string}} info
- * @param {boolean} quiet - Only output the next version
+ * @param {{currentVersion: string|null, newVersion: string|null, commits: Array, changelog: string}} info
+ * @param {boolean} quiet - Only output the new version
  */
 function displayVersionInfo(info, quiet) {
-  const { currentVersion, nextVersion, commits, changelog } = info;
+  const { currentVersion, newVersion, commits, changelog } = info;
   
   if (quiet) {
-    if (nextVersion) {
-      console.log(nextVersion);
+    if (newVersion) {
+      console.log(newVersion);
     }
     return;
   }
   
-  console.log(`Current version: ${currentVersion || 'none'}`);
-  console.log(`Next version: ${nextVersion || 'no bump needed'}`);
-  console.log(`Commits since current version: ${commits.length}`);
+  
+  // List commits
+  console.log(`Commits since current version (${commits.length}):`);
+  for (const commit of commits) {
+    const subject = commit.message.split('\n')[0].trim();
+    const shortHash = commit.hash.substring(0, 7);
+    console.log(`  ${shortHash} ${subject}`);
+  }
+  
+  console.log(`\nCurrent version: ${currentVersion || 'none'}`);
+  console.log(`New version: ${newVersion || 'no bump needed'}`);
   if (changelog) {
-    console.log(`\nChangelog:\n${changelog}`);
+    console.log(`\nChangelog:\n\n${changelog}`);
   }
 }
 
@@ -71,10 +79,7 @@ async function handlePushCommand(pushType, options) {
   displayVersionInfo(info, options.quiet);
   
   // Skip push if no version bump needed
-  if (!info.nextVersion) {
-    if (!options.quiet) {
-      console.log('\nNo version bump needed. Skipping tag creation.');
-    }
+  if (!info.newVersion) {
     return;
   }
   
@@ -93,16 +98,16 @@ async function handlePushCommand(pushType, options) {
   }
   
   // Create tag message from changelog
-  const tagMessage = info.changelog || info.nextVersion;
+  const tagMessage = info.changelog || info.newVersion;
   
   if (!options.quiet) {
-    console.log(`\nCreating tag ${info.nextVersion}...`);
+    console.log(`\nCreating tag ${info.newVersion}...`);
   }
   
-  await pushModule.pushTag(info.nextVersion, tagMessage);
+  await pushModule.pushTag(info.newVersion, tagMessage);
   
   if (!options.quiet) {
-    console.log(`Tag ${info.nextVersion} created and pushed successfully.`);
+    console.log(`Tag ${info.newVersion} created and pushed successfully.`);
   }
 }
 

package/src/utils.js

@@ -67,6 +67,21 @@ const TYPE_ORDER = ['feat', 'fix', 'perf', 'refactor', 'style', 'test', 'docs',
 const PATCH_TYPES = ['fix', 'perf', 'refactor', 'test', 'build', 'ci', 'revert'];
 const SEMVER_PATTERN = /^v(\d+)\.(\d+)\.(\d+)(-[a-zA-Z0-9.-]+)?$/;
 
+// Friendly header names for changelog
+const TYPE_HEADERS = {
+  feat: 'Features:',
+  fix: 'Fixes:',
+  perf: 'Performance:',
+  refactor: 'Refactors:',
+  style: 'Style:',
+  test: 'Tests:',
+  docs: 'Documentation:',
+  build: 'Build:',
+  ci: 'CI:',
+  chore: 'Chores:',
+  revert: 'Reverts:',
+};
+
 /**
  * Fetches tags from remote (non-destructive) if a remote is configured.
  * @returns {boolean} True if tags were fetched, false if using local tags only
@@ -242,6 +257,16 @@ function analyzeCommitsForVersioning(commits) {
   return { hasBreaking, hasFeat, hasPatchTypes, commitsByType };
 }
 
+/**
+ * Capitalizes the first letter of a string.
+ * @param {string} str - The string to capitalize
+ * @returns {string} Capitalized string
+ */
+function capitalize(str) {
+  if (!str) return str;
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}
+
 /**
  * Generates changelog entries for a commit type section.
  * @param {Array} commits - Commits of this type
@@ -271,20 +296,22 @@ function generateTypeChangelog(commits) {
   
   const lines = [];
   for (const entry of noScope) {
-    lines.push(`- ${entry.description}${entry.issueRef}`);
+    const ref = entry.issueRef ? ` ${entry.issueRef}` : '';
+    lines.push(`- ${capitalize(entry.description)}${ref}`);
   }
   for (const scope of Object.keys(byScope).sort()) {
     for (const entry of byScope[scope]) {
-      lines.push(`- **${scope}**: ${entry.description}${entry.issueRef}`);
+      const ref = entry.issueRef ? ` ${entry.issueRef}` : '';
+      lines.push(`- ${scope}: ${capitalize(entry.description)}${ref}`);
     }
   }
   return lines;
 }
 
 /**
- * Calculates the next version and generates a changelog.
+ * Calculates the new version and generates a changelog.
  * @param {{latestVersion: string|null, commits: Array}} expandedInfo
- * @returns {{nextVersion: string|null, changelog: string}}
+ * @returns {{newVersion: string|null, changelog: string}}
  */
 function calculateNextVersionAndChangelog(expandedInfo) {
   const { latestVersion, commits } = expandedInfo;
@@ -292,7 +319,7 @@ function calculateNextVersionAndChangelog(expandedInfo) {
   const analysis = analyzeCommitsForVersioning(commits);
   
   const bump = determineVersionBumpType(analysis, current.major === 0);
-  const nextVersion = applyVersionBump(current, bump);
+  const newVersion = applyVersionBump(current, bump);
   
   // Generate changelog
   const changelogLines = [];
@@ -300,7 +327,7 @@ function calculateNextVersionAndChangelog(expandedInfo) {
     const typeCommits = analysis.commitsByType[type];
     if (!typeCommits?.length) continue;
     
-    changelogLines.push(`### ${type}`);
+    changelogLines.push(TYPE_HEADERS[type] || `${capitalize(type)}:`);
     changelogLines.push(...generateTypeChangelog(typeCommits));
     changelogLines.push('');
   }
@@ -309,7 +336,7 @@ function calculateNextVersionAndChangelog(expandedInfo) {
     changelogLines.pop();
   }
   
-  return { nextVersion, changelog: changelogLines.join('\n') };
+  return { newVersion, changelog: changelogLines.join('\n') };
 }
 
 /**
@@ -355,7 +382,7 @@ function getAllBranchCommits(branch) {
 
 /**
  * Processes version information for the current branch.
- * @returns {Promise<{currentVersion: string|null, nextVersion: string|null, commits: Array, changelog: string}>}
+ * @returns {Promise<{currentVersion: string|null, newVersion: string|null, commits: Array, changelog: string}>}
  */
 async function processVersionInfo() {
   ensureGitRepo();
@@ -365,11 +392,11 @@ async function processVersionInfo() {
   const allCommits = getAllBranchCommits(branch);
   const expandedInfo = expandCommitInfo(allCommits);
   const { latestVersion, commits } = expandedInfo;
-  const { nextVersion, changelog } = calculateNextVersionAndChangelog(expandedInfo);
+  const { newVersion, changelog } = calculateNextVersionAndChangelog(expandedInfo);
   
   return {
     currentVersion: latestVersion,
-    nextVersion,
+    newVersion,
     commits,
     changelog,
   };