| 1 |
#!/usr/bin/env node |
| 2 |
|
| 3 |
/** |
| 4 |
* Copyright (C) 2024 OSN, Inc. |
| 5 |
* |
| 6 |
* This program is free software: you can redistribute it and/or modify |
| 7 |
* it under the terms of the GNU General Public License as published by |
| 8 |
* the Free Software Foundation, either version 3 of the License, or |
| 9 |
* (at your option) any later version. |
| 10 |
* |
| 11 |
* This program is distributed in the hope that it will be useful, |
| 12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 |
* GNU General Public License for more details. |
| 15 |
* |
| 16 |
* You should have received a copy of the GNU General Public License |
| 17 |
* along with this program. If not, see <https://www.gnu.org/licenses/>. |
| 18 |
*/ |
| 19 |
|
| 20 |
"use strict"; |
| 21 |
|
| 22 |
const path = require("path"); |
| 23 |
const { existsSync } = require("fs"); |
| 24 |
const { exit } = require("process"); |
| 25 |
const { execSync } = require("child_process"); |
| 26 |
const { writeFile } = require("fs/promises"); |
| 27 |
const { parseArgs } = require("util"); |
| 28 |
const crypto = require("crypto"); |
| 29 |
|
| 30 |
const ME = path.basename(process.argv[1]); |
| 31 |
const GIT_COMMIT_BOUNDARY = crypto.randomBytes(64).toString("hex"); |
| 32 |
const GIT_SPACE_BOUNDARY = crypto.randomBytes(64).toString("hex"); |
| 33 |
|
| 34 |
function print(...args) { |
| 35 |
console.log(`${ME}: ${args.join(" ")}`); |
| 36 |
} |
| 37 |
|
| 38 |
function perror(...args) { |
| 39 |
console.error(`\x1b[0m${ME}: error: ${args.join(" ")}`); |
| 40 |
} |
| 41 |
|
| 42 |
function findInPath(executable) { |
| 43 |
for (const segment of process.env.PATH?.split( |
| 44 |
process.platform === "win32" ? ";" : ":", |
| 45 |
) ?? []) { |
| 46 |
const executablePath = path.join( |
| 47 |
segment, |
| 48 |
executable + (process.platform === "win32" ? ".exe" : ""), |
| 49 |
); |
| 50 |
|
| 51 |
if (existsSync(executablePath)) { |
| 52 |
return executablePath; |
| 53 |
} |
| 54 |
} |
| 55 |
|
| 56 |
return null; |
| 57 |
} |
| 58 |
|
| 59 |
function checkForGit() { |
| 60 |
const gitPath = findInPath("git"); |
| 61 |
|
| 62 |
if (!gitPath) { |
| 63 |
perror("could not find git in $PATH"); |
| 64 |
perror("please make sure git is installed and available in $PATH"); |
| 65 |
exit(1); |
| 66 |
} |
| 67 |
|
| 68 |
return gitPath; |
| 69 |
} |
| 70 |
|
| 71 |
function getGitLog(gitPath) { |
| 72 |
try { |
| 73 |
return execSync( |
| 74 |
gitPath + |
| 75 |
` --no-pager log --pretty=format:"%h %H %an${GIT_SPACE_BOUNDARY} %ae %ad${GIT_SPACE_BOUNDARY} %B${GIT_COMMIT_BOUNDARY}"`, |
| 76 |
{ encoding: "utf8" }, |
| 77 |
); |
| 78 |
} catch { |
| 79 |
perror("command `git log' failed"); |
| 80 |
exit(1); |
| 81 |
} |
| 82 |
} |
| 83 |
|
| 84 |
function strUntil(str, boundary) { |
| 85 |
let output = ""; |
| 86 |
let i = 0; |
| 87 |
|
| 88 |
for (i = 0; i < str.length; i++) { |
| 89 |
if (str[i] === boundary[0]) { |
| 90 |
let boundaryIndex = 0; |
| 91 |
let previousI = i; |
| 92 |
|
| 93 |
while ( |
| 94 |
boundaryIndex < boundary.length && |
| 95 |
i < str.length && |
| 96 |
str[i] === boundary[boundaryIndex] |
| 97 |
) { |
| 98 |
i++; |
| 99 |
boundaryIndex++; |
| 100 |
} |
| 101 |
|
| 102 |
if (boundaryIndex === boundary.length) { |
| 103 |
return { output, size: i }; |
| 104 |
} |
| 105 |
|
| 106 |
i = previousI; |
| 107 |
} |
| 108 |
|
| 109 |
output += str[i]; |
| 110 |
} |
| 111 |
|
| 112 |
return { output, size: i }; |
| 113 |
} |
| 114 |
|
| 115 |
function parseGitLog(gitLog) { |
| 116 |
const commits = []; |
| 117 |
|
| 118 |
let i = 0; |
| 119 |
|
| 120 |
while (i < gitLog.length) { |
| 121 |
const { output, size } = strUntil(gitLog.slice(i), GIT_COMMIT_BOUNDARY); |
| 122 |
i += size; |
| 123 |
|
| 124 |
let outputIndex = 0; |
| 125 |
|
| 126 |
const shortIdSpaceIndex = output.indexOf(" "); |
| 127 |
const idSpaceIndex = output.indexOf(" ", shortIdSpaceIndex + 1); |
| 128 |
const shortId = output.slice(outputIndex, shortIdSpaceIndex); |
| 129 |
const id = output.slice(shortIdSpaceIndex + 1, idSpaceIndex); |
| 130 |
|
| 131 |
outputIndex += shortId.length + id.length + 2; |
| 132 |
|
| 133 |
const { output: authorName, size: authorNameSize } = strUntil( |
| 134 |
output.slice(outputIndex), |
| 135 |
GIT_SPACE_BOUNDARY, |
| 136 |
); |
| 137 |
|
| 138 |
outputIndex += authorNameSize + 1; |
| 139 |
|
| 140 |
const authorEmailSpaceIndex = output.indexOf(" ", outputIndex + 1); |
| 141 |
const authorEmail = output.slice(outputIndex, authorEmailSpaceIndex); |
| 142 |
|
| 143 |
outputIndex += authorEmail.length + 1; |
| 144 |
|
| 145 |
const { output: date, size: dateSize } = strUntil( |
| 146 |
output.slice(outputIndex), |
| 147 |
GIT_SPACE_BOUNDARY, |
| 148 |
); |
| 149 |
|
| 150 |
outputIndex += dateSize + 1; |
| 151 |
|
| 152 |
const message = output.slice(outputIndex); |
| 153 |
const newlineIndex = message.indexOf("\n"); |
| 154 |
const subject = message.slice( |
| 155 |
0, |
| 156 |
newlineIndex === -1 ? undefined : newlineIndex, |
| 157 |
); |
| 158 |
const body = newlineIndex === -1 ? "" : message.slice(newlineIndex + 1); |
| 159 |
|
| 160 |
const validFooterProps = [ |
| 161 |
"signed-off-by", |
| 162 |
"co-authored-by", |
| 163 |
"on-behalf-of", |
| 164 |
]; |
| 165 |
const footerProps = {}; |
| 166 |
const coAuthors = []; |
| 167 |
|
| 168 |
for (const line of body.split("\n")) { |
| 169 |
const colonIndex = line.indexOf(":"); |
| 170 |
const key = line.slice(0, colonIndex).trim().toLowerCase(); |
| 171 |
const value = line.slice(colonIndex + 1).trim(); |
| 172 |
|
| 173 |
if (validFooterProps.includes(key)) { |
| 174 |
footerProps[key] = value; |
| 175 |
} |
| 176 |
|
| 177 |
if (key === "co-authored-by") { |
| 178 |
const name = value.slice(0, value.lastIndexOf(" ")).trim(); |
| 179 |
|
| 180 |
coAuthors.push({ |
| 181 |
name, |
| 182 |
email: value |
| 183 |
.slice(name.length) |
| 184 |
.trim() |
| 185 |
.replace(/^<|>$/g, ""), |
| 186 |
}); |
| 187 |
} |
| 188 |
} |
| 189 |
|
| 190 |
commits.push({ |
| 191 |
shortId, |
| 192 |
id, |
| 193 |
author: { |
| 194 |
name: authorName, |
| 195 |
email: authorEmail, |
| 196 |
}, |
| 197 |
date: new Date(date), |
| 198 |
subject, |
| 199 |
body, |
| 200 |
footerProps, |
| 201 |
message, |
| 202 |
coAuthors, |
| 203 |
authors: [ |
| 204 |
{ |
| 205 |
name: authorName, |
| 206 |
email: authorEmail, |
| 207 |
}, |
| 208 |
...coAuthors, |
| 209 |
], |
| 210 |
}); |
| 211 |
} |
| 212 |
|
| 213 |
return commits; |
| 214 |
} |
| 215 |
|
| 216 |
function escapeMarkdown(str) { |
| 217 |
return str.replace(/([_*~`])/g, "\\$1"); |
| 218 |
} |
| 219 |
|
| 220 |
function generateMarkdownChangelog(commits) { |
| 221 |
let output = "# Changelog\n\n"; |
| 222 |
|
| 223 |
const grouppedCommitsByDate = {}; |
| 224 |
|
| 225 |
for (const commit of commits) { |
| 226 |
const key = `${commit.date.getUTCDate().toString().padStart(2, 0)}-${( |
| 227 |
commit.date.getUTCMonth() + 1 |
| 228 |
) |
| 229 |
.toString() |
| 230 |
.padStart(2, "0")}-${commit.date.getUTCFullYear()}::${commit.authors |
| 231 |
.map((a) => `[${escapeMarkdown(a.name)}](mailto:${a.email})`) |
| 232 |
.join(":")}`; |
| 233 |
grouppedCommitsByDate[key] ??= []; |
| 234 |
grouppedCommitsByDate[key].push(commit); |
| 235 |
} |
| 236 |
|
| 237 |
for (const key in grouppedCommitsByDate) { |
| 238 |
const [date, author] = key.split("::"); |
| 239 |
output += `### ${date} - [${author}]\n\n`; |
| 240 |
|
| 241 |
for (const commit of grouppedCommitsByDate[key]) { |
| 242 |
const conventionalCommitType = commit.subject.match( |
| 243 |
/^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test|release|deps)(\(.+\))?:/, |
| 244 |
); |
| 245 |
let needsBreakingChangeWarning = conventionalCommitType?.[0] |
| 246 |
?.trim() |
| 247 |
?.endsWith("!:"); |
| 248 |
|
| 249 |
if (conventionalCommitType) { |
| 250 |
output += ` * **${conventionalCommitType[0]}**${commit.subject.slice(conventionalCommitType[0].length)}`; |
| 251 |
} else { |
| 252 |
output += ` * ${commit.subject}`; |
| 253 |
} |
| 254 |
|
| 255 |
if (commit.body) { |
| 256 |
output += " \n"; |
| 257 |
|
| 258 |
for (const line of commit.body.split("\n")) { |
| 259 |
const colonIndex = line.indexOf(":"); |
| 260 |
|
| 261 |
if (colonIndex !== -1) { |
| 262 |
const name = line.slice(0, colonIndex); |
| 263 |
const value = line.slice(colonIndex + 1); |
| 264 |
output += ` **${name}:** ${value} \n`; |
| 265 |
|
| 266 |
if (name === "BREAKING CHANGE") { |
| 267 |
needsBreakingChangeWarning = false; |
| 268 |
} |
| 269 |
} else { |
| 270 |
output += ` ${line} \n`; |
| 271 |
} |
| 272 |
} |
| 273 |
} |
| 274 |
|
| 275 |
if (needsBreakingChangeWarning) { |
| 276 |
output += " **This is a breaking change.** \n"; |
| 277 |
output += " \n"; |
| 278 |
} |
| 279 |
|
| 280 |
if (!commit.body && !needsBreakingChangeWarning) { |
| 281 |
output += "\n"; |
| 282 |
} |
| 283 |
} |
| 284 |
|
| 285 |
output += "\n"; |
| 286 |
} |
| 287 |
|
| 288 |
return output.trimEnd(); |
| 289 |
} |
| 290 |
|
| 291 |
function generateChangelog(commits) { |
| 292 |
let output = ""; |
| 293 |
|
| 294 |
const grouppedCommitsByDate = {}; |
| 295 |
|
| 296 |
for (const commit of commits) { |
| 297 |
const key = `${commit.date.getUTCDate().toString().padStart(2, 0)}-${( |
| 298 |
commit.date.getUTCMonth() + 1 |
| 299 |
) |
| 300 |
.toString() |
| 301 |
.padStart( |
| 302 |
2, |
| 303 |
"0", |
| 304 |
)}-${commit.date.getUTCFullYear()}::${commit.authors.map((a) => `${a.name} <${a.email}>`).join(":")}`; |
| 305 |
grouppedCommitsByDate[key] ??= []; |
| 306 |
grouppedCommitsByDate[key].push(commit); |
| 307 |
} |
| 308 |
|
| 309 |
for (const key in grouppedCommitsByDate) { |
| 310 |
const separatorPosition = key.indexOf("::"); |
| 311 |
const date = key.slice(0, separatorPosition); |
| 312 |
const commits = grouppedCommitsByDate[key]; |
| 313 |
|
| 314 |
output += `${date} ${commits[0].authors |
| 315 |
.map((a) => `${a.name} <${a.email}>`) |
| 316 |
.join(", ")}\n\n`; |
| 317 |
|
| 318 |
for (const commit of commits) { |
| 319 |
output += ` [*] ${commit.subject}\n${commit.body |
| 320 |
.split("\n") |
| 321 |
.map((part) => ` ${part}`) |
| 322 |
.join("\n")}\n\n`; |
| 323 |
} |
| 324 |
} |
| 325 |
|
| 326 |
return output.trim(); |
| 327 |
} |
| 328 |
|
| 329 |
function printHelp() { |
| 330 |
console.log("Usage:"); |
| 331 |
console.log(` ${ME} [OPTION]...`); |
| 332 |
console.log("Generate a formatted ChangeLog from Git commit logs."); |
| 333 |
console.log(); |
| 334 |
console.log("Options:"); |
| 335 |
console.log(" -h, --help Show this help and exit."); |
| 336 |
console.log(" -v, --version Show this script's version."); |
| 337 |
console.log(" -f, --format Set the changelog format."); |
| 338 |
console.log(" Supported formats are: plain,"); |
| 339 |
console.log(" markdown."); |
| 340 |
console.log(" -o, --output=<FILE> Write the generated changelog to"); |
| 341 |
console.log(" a file instead of standard output."); |
| 342 |
console.log(" --no-overwrite Disallow overwriting of the output"); |
| 343 |
console.log(" file if it exists already."); |
| 344 |
console.log(); |
| 345 |
console.log("Send general inquiries, questions and bug reports"); |
| 346 |
console.log("to <[email protected]>."); |
| 347 |
} |
| 348 |
|
| 349 |
function printVersion() { |
| 350 |
console.log("Copyright (C) 2024 OSN, Inc."); |
| 351 |
console.log( |
| 352 |
"License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.", |
| 353 |
); |
| 354 |
console.log( |
| 355 |
"This is free software: you are free to change and redistribute it.", |
| 356 |
); |
| 357 |
console.log("There is NO WARRANTY, to the extent permitted by law."); |
| 358 |
console.log(); |
| 359 |
console.log("Written by Ar Rakin."); |
| 360 |
} |
| 361 |
|
| 362 |
async function main() { |
| 363 |
let options; |
| 364 |
|
| 365 |
try { |
| 366 |
options = parseArgs({ |
| 367 |
argv: process.argv.slice(1), |
| 368 |
strict: true, |
| 369 |
allowPositionals: false, |
| 370 |
options: { |
| 371 |
help: { |
| 372 |
type: "boolean", |
| 373 |
alias: "h", |
| 374 |
}, |
| 375 |
version: { |
| 376 |
type: "boolean", |
| 377 |
alias: "v", |
| 378 |
}, |
| 379 |
output: { |
| 380 |
type: "string", |
| 381 |
short: "o", |
| 382 |
}, |
| 383 |
"no-overwrite": { |
| 384 |
type: "boolean", |
| 385 |
}, |
| 386 |
format: { |
| 387 |
type: "string", |
| 388 |
short: "f", |
| 389 |
}, |
| 390 |
}, |
| 391 |
}).values; |
| 392 |
} catch (error) { |
| 393 |
perror(`${error?.message ?? error}`); |
| 394 |
exit(1); |
| 395 |
} |
| 396 |
|
| 397 |
if (options.help) { |
| 398 |
printHelp(); |
| 399 |
exit(0); |
| 400 |
} |
| 401 |
|
| 402 |
if (options.version) { |
| 403 |
printVersion(); |
| 404 |
exit(0); |
| 405 |
} |
| 406 |
|
| 407 |
if (options.format && !["markdown", "plain"].includes(options.format)) { |
| 408 |
perror( |
| 409 |
"option `--format` or `-f` only accepts one of the following: markdown, plain", |
| 410 |
); |
| 411 |
exit(1); |
| 412 |
} |
| 413 |
|
| 414 |
if (!options.output && options["no-overwrite"]) { |
| 415 |
perror( |
| 416 |
"option `--no-overwrite' without `--output` does not make sense", |
| 417 |
); |
| 418 |
exit(1); |
| 419 |
} |
| 420 |
|
| 421 |
if ( |
| 422 |
options.output && |
| 423 |
options["no-overwrite"] && |
| 424 |
existsSync(options.output) |
| 425 |
) { |
| 426 |
perror(`${options.output}: cannot write changelog: File exists`); |
| 427 |
exit(1); |
| 428 |
} |
| 429 |
|
| 430 |
const gitPath = checkForGit(); |
| 431 |
const gitLog = getGitLog(gitPath); |
| 432 |
const commits = parseGitLog(gitLog); |
| 433 |
const filteredCommits = commits.filter( |
| 434 |
(commit) => |
| 435 |
!/Merge pull request #\d+ from|Merge branch '\S+' of/.test( |
| 436 |
commit.message, |
| 437 |
), |
| 438 |
); |
| 439 |
const changelog = |
| 440 |
options.format === "markdown" |
| 441 |
? generateMarkdownChangelog(filteredCommits) |
| 442 |
: generateChangelog(filteredCommits); |
| 443 |
|
| 444 |
if (options.output) { |
| 445 |
try { |
| 446 |
await writeFile(options.output, changelog); |
| 447 |
} catch (error) { |
| 448 |
perror( |
| 449 |
`${options.output}: failed to write changelog: ${ |
| 450 |
error?.message ?? error |
| 451 |
}`, |
| 452 |
); |
| 453 |
exit(1); |
| 454 |
} |
| 455 |
|
| 456 |
print(`wrote generated changelog to ${options.output}`); |
| 457 |
} else { |
| 458 |
console.log(changelog); |
| 459 |
} |
| 460 |
} |
| 461 |
|
| 462 |
main(); |
Parent Directory
| 
Revision Log