/[osn-commons]/trunk/git/genchangelog
ViewVC logotype

Diff of /trunk/git/genchangelog

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 11 by rakinar2, Sat Aug 3 15:50:38 2024 UTC revision 61 by rakinar2, Tue Sep 10 14:47:37 2024 UTC
# Line 1  Line 1 
1  #!/usr/bin/env node  #!/usr/bin/env node
2    
3  /**  /**
4   *  Copyright (C) 2024  OSN, Inc.   *  Copyright (C) 2024  OSN Developers.
5   *   *
6   *  This program is free software: you can redistribute it and/or modify   *  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   *  it under the terms of the GNU General Public License as published by
# Line 22  Line 22 
22  const path = require("path");  const path = require("path");
23  const { existsSync } = require("fs");  const { existsSync } = require("fs");
24  const { exit } = require("process");  const { exit } = require("process");
25  const { execSync } = require("child_process");  const { execSync, exec, spawn } = require("child_process");
26  const { writeFile } = require("fs/promises");  const { writeFile } = require("fs/promises");
27  const { parseArgs } = require("util");  const { parseArgs } = require("util");
28    const crypto = require("crypto");
29    
30  const ME = path.basename(process.argv[1]);  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) {  function print(...args) {
35      console.log(`${ME}: ${args.join(" ")}`);      console.log(`${ME}: ${args.join(" ")}`);
# Line 37  function perror(...args) { Line 40  function perror(...args) {
40  }  }
41    
42  function findInPath(executable) {  function findInPath(executable) {
43      for (const segment of process.env.PATH?.split(process.platform === "win32" ? ";" : ":") ?? []) {      for (const segment of process.env.PATH?.split(
44          const executablePath = path.join(segment, executable + (process.platform === "win32" ? ".exe" : ""));          process.platform === "win32" ? ";" : ":",
45                ) ?? []) {
46            const executablePath = path.join(
47                segment,
48                executable + (process.platform === "win32" ? ".exe" : ""),
49            );
50    
51          if (existsSync(executablePath)) {          if (existsSync(executablePath)) {
52              return executablePath;              return executablePath;
53          }          }
# Line 60  function checkForGit() { Line 68  function checkForGit() {
68      return gitPath;      return gitPath;
69  }  }
70    
71  function getGitLog(gitPath) {  async function getGitLog(gitPath) {
72      try {      try {
73          return execSync(gitPath + " --no-pager log", { encoding: "utf8" });          let output = "";
74      }  
75      catch {          const child = spawn(
76          perror("command `git --no-pager log' failed");              gitPath,
77                [
78                    "--no-pager",
79                    "log",
80                    `--pretty=format:%h %H %an${GIT_SPACE_BOUNDARY} %ae %ad${GIT_SPACE_BOUNDARY} %B${GIT_COMMIT_BOUNDARY}`,
81                ],
82                { encoding: "utf8", stdio: "pipe" },
83            );
84    
85            child.stdout.on("data", (data) => {
86                output += data;
87            });
88    
89            child.stderr.on("data", (data) => {
90                console.error(data);
91            });
92    
93            await new Promise((resolve) => {
94                child.on("close", (code) => {
95                    if (code !== 0) {
96                        perror("command `git log' failed with exit code " + code);
97                        exit(1);
98                    } else {
99                        resolve();
100                    }
101                });
102            });
103    
104            return output;
105        } catch (error) {
106            console.error(error);
107            perror("command `git log' failed");
108          exit(1);          exit(1);
109      }      }
110  }  }
111    
112    function strUntil(str, boundary) {
113        let output = "";
114        let i = 0;
115    
116        for (i = 0; i < str.length; i++) {
117            if (str[i] === boundary[0]) {
118                let boundaryIndex = 0;
119                let previousI = i;
120    
121                while (
122                    boundaryIndex < boundary.length &&
123                    i < str.length &&
124                    str[i] === boundary[boundaryIndex]
125                ) {
126                    i++;
127                    boundaryIndex++;
128                }
129    
130                if (boundaryIndex === boundary.length) {
131                    return { output, size: i };
132                }
133    
134                i = previousI;
135            }
136    
137            output += str[i];
138        }
139    
140        return { output, size: i };
141    }
142    
143  function parseGitLog(gitLog) {  function parseGitLog(gitLog) {
     const lines = gitLog.split("\n");  
144      const commits = [];      const commits = [];
145    
146      for (let i = 0; i < lines.length; ) {      let i = 0;
         if (!lines[i].startsWith("commit")) {  
             i++;  
             continue;  
         }  
147    
148          const [, hash] = lines[i++].split(' ');      while (i < gitLog.length) {
149          const headerProps = {};          const { output, size } = strUntil(gitLog.slice(i), GIT_COMMIT_BOUNDARY);
150            i += size;
151    
152          while (i < lines.length && lines[i].trim() !== "" && !/^\s/.test(lines[i])) {          let outputIndex = 0;
             const colonIndex = lines[i].indexOf(":");  
             const name = lines[i].slice(0, colonIndex).toLowerCase();  
             const value = lines[i].slice(colonIndex + 1).trim();  
             headerProps[name] = value;  
             i++;  
         }  
153    
154          const messageLines = [];          const shortIdSpaceIndex = output.indexOf(" ");
155            const idSpaceIndex = output.indexOf(" ", shortIdSpaceIndex + 1);
156            const shortId = output.slice(outputIndex, shortIdSpaceIndex);
157            const id = output.slice(shortIdSpaceIndex + 1, idSpaceIndex);
158    
159          while (i < lines.length && !lines[i].startsWith("commit")) {          outputIndex += shortId.length + id.length + 2;
             const lineToPush = lines[i++].replace(/^    /, "");  
160    
161              if (!lineToPush) {          const { output: authorName, size: authorNameSize } = strUntil(
162                  continue;              output.slice(outputIndex),
163              }              GIT_SPACE_BOUNDARY,
164                        );
165              messageLines.push(lineToPush);  
166          }          outputIndex += authorNameSize + 1;
167    
168            const authorEmailSpaceIndex = output.indexOf(" ", outputIndex + 1);
169            const authorEmail = output.slice(outputIndex, authorEmailSpaceIndex);
170    
171            outputIndex += authorEmail.length + 1;
172    
173            const { output: date, size: dateSize } = strUntil(
174                output.slice(outputIndex),
175                GIT_SPACE_BOUNDARY,
176            );
177    
178            outputIndex += dateSize + 1;
179    
180            const message = output.slice(outputIndex);
181            const newlineIndex = message.indexOf("\n");
182            const subject = message.slice(
183                0,
184                newlineIndex === -1 ? undefined : newlineIndex,
185            );
186            const body = newlineIndex === -1 ? "" : message.slice(newlineIndex + 1);
187    
188          let mindex = messageLines.length - 1;          const validFooterProps = [
189                "signed-off-by",
190                "co-authored-by",
191                "on-behalf-of",
192            ];
193          const footerProps = {};          const footerProps = {};
194          const validFooterProps = ["signed-off-by", "co-authored-by", "on-behalf-of"];          const coAuthors = [];
           
         while (mindex >= 1 && /^[A-Za-z0-9-]+: /.test(messageLines.at(mindex))) {  
             const messageLine = messageLines[mindex--];  
             const colonIndex = messageLine.indexOf(":");  
             const name = messageLine.slice(0, colonIndex).toLowerCase();  
195    
196              if (!validFooterProps.includes(name)) {          for (const line of body.split("\n")) {
197                  continue;              const colonIndex = line.indexOf(":");
198              }              const key = line.slice(0, colonIndex).trim().toLowerCase();
199                            const value = line.slice(colonIndex + 1).trim();
             const value = messageLine.slice(colonIndex + 1).trim();  
200    
201              if (name in footerProps && !Array.isArray(footerProps[name])) {              if (validFooterProps.includes(key)) {
202                  footerProps[name] = [footerProps[name]];                  footerProps[key] = value;
203              }              }
204    
205              if (Array.isArray(footerProps[name])) {              if (key === "co-authored-by") {
206                  footerProps[name].push(value);                  const name = value.slice(0, value.lastIndexOf(" ")).trim();
             }  
             else {  
                 footerProps[name] = value;  
             }  
207    
208              messageLines.splice(mindex - 1, 1);                  coAuthors.push({
209                        name,
210                        email: value
211                            .slice(name.length)
212                            .trim()
213                            .replace(/^<|>$/g, ""),
214                    });
215                }
216          }          }
217    
         const message = messageLines.join("\n");  
           
218          commits.push({          commits.push({
219              hash,              shortId,
220              message,              id,
221              headerProps,              author: {
222                    name: authorName,
223                    email: authorEmail,
224                },
225                date: new Date(date),
226                subject,
227                body,
228              footerProps,              footerProps,
229              signedOffBy: footerProps["signed-off-by"],              message,
230              onBehalfOf: footerProps["on-behalf-of"],              coAuthors,
231              author: headerProps["author"],              authors: [
232              createdAt: new Date(headerProps["date"])                  {
233                        name: authorName,
234                        email: authorEmail,
235                    },
236                    ...coAuthors,
237                ],
238          });          });
239      }      }
240    
241      return commits;      return commits;
242  }  }
243    
244    function escapeMarkdown(str) {
245        return str.replace(/([_*~`])/g, "\\$1");
246    }
247    
248    function generateMarkdownChangelog(commits) {
249        let output = "# Changelog\n\n";
250    
251        const grouppedCommitsByDate = {};
252    
253        for (const commit of commits) {
254            const key = `${commit.date.getUTCDate().toString().padStart(2, 0)}-${(
255                commit.date.getUTCMonth() + 1
256            )
257                .toString()
258                .padStart(2, "0")}-${commit.date.getUTCFullYear()}::${commit.authors
259                .map((a) => `[${escapeMarkdown(a.name)}](mailto:${a.email})`)
260                .join(":")}`;
261            grouppedCommitsByDate[key] ??= [];
262            grouppedCommitsByDate[key].push(commit);
263        }
264    
265        for (const key in grouppedCommitsByDate) {
266            const [date, author] = key.split("::");
267            output += `### ${date} - [${author}]\n\n`;
268    
269            for (const commit of grouppedCommitsByDate[key]) {
270                const conventionalCommitType = commit.subject.match(
271                    /^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test|release|deps)(\(.+\))?:/,
272                );
273                let needsBreakingChangeWarning = conventionalCommitType?.[0]
274                    ?.trim()
275                    ?.endsWith("!:");
276    
277                if (conventionalCommitType) {
278                    output += `  * **${conventionalCommitType[0]}**${commit.subject.slice(conventionalCommitType[0].length)}`;
279                } else {
280                    output += `  * ${commit.subject}`;
281                }
282    
283                if (commit.body) {
284                    output += "    \n";
285    
286                    for (const line of commit.body.split("\n")) {
287                        const colonIndex = line.indexOf(":");
288    
289                        if (colonIndex !== -1) {
290                            const name = line.slice(0, colonIndex);
291                            const value = line.slice(colonIndex + 1);
292                            output += `    **${name}:** ${value}  \n`;
293    
294                            if (name === "BREAKING CHANGE") {
295                                needsBreakingChangeWarning = false;
296                            }
297                        } else {
298                            output += `    ${line}  \n`;
299                        }
300                    }
301                }
302    
303                if (needsBreakingChangeWarning) {
304                    output += "    **This is a breaking change.**  \n";
305                    output += "    \n";
306                }
307    
308                if (!commit.body && !needsBreakingChangeWarning) {
309                    output += "\n";
310                }
311            }
312    
313            output += "\n";
314        }
315    
316        return output.trimEnd();
317    }
318    
319  function generateChangelog(commits) {  function generateChangelog(commits) {
320      let output = "";      let output = "";
321    
322      const grouppedCommitsByDate = {};      const grouppedCommitsByDate = {};
323        
324      for (const commit of commits) {      for (const commit of commits) {
325          const key = `${commit.createdAt.getUTCDate().toString().padStart(2, 0)}-${commit.createdAt.getUTCMonth().toString().padStart(2, '0')}-${commit.createdAt.getUTCFullYear()}::${Array.isArray(commit.author) ? commit.author.join(':') : commit.author}`;          const key = `${commit.date.getUTCDate().toString().padStart(2, 0)}-${(
326                commit.date.getUTCMonth() + 1
327            )
328                .toString()
329                .padStart(
330                    2,
331                    "0",
332                )}-${commit.date.getUTCFullYear()}::${commit.authors.map((a) => `${a.name} <${a.email}>`).join(":")}`;
333          grouppedCommitsByDate[key] ??= [];          grouppedCommitsByDate[key] ??= [];
334          grouppedCommitsByDate[key].push(commit);          grouppedCommitsByDate[key].push(commit);
335      }      }
# Line 165  function generateChangelog(commits) { Line 339  function generateChangelog(commits) {
339          const date = key.slice(0, separatorPosition);          const date = key.slice(0, separatorPosition);
340          const commits = grouppedCommitsByDate[key];          const commits = grouppedCommitsByDate[key];
341    
342          output += `${date}  ${Array.isArray(commits[0].author) ? commits[0].author.join(", ") : commits[0].author}\n\n`;          output += `${date}  ${commits[0].authors
343                .map((a) => `${a.name} <${a.email}>`)
344                .join(", ")}\n\n`;
345    
346          for (const commit of commits) {          for (const commit of commits) {
347              output += `        ${commit.message.replaceAll("\n", "\n        ")}\n\n`;              output += `     [*] ${commit.subject}\n${commit.body
348                    .split("\n")
349                    .map((part) => `         ${part}`)
350                    .join("\n")}\n\n`;
351          }          }
352      }      }
353        
354      return output.trim();      return output.trim();
355  }  }
356    
# Line 183  function printHelp() { Line 362  function printHelp() {
362      console.log("Options:");      console.log("Options:");
363      console.log("  -h, --help           Show this help and exit.");      console.log("  -h, --help           Show this help and exit.");
364      console.log("  -v, --version        Show this script's version.");      console.log("  -v, --version        Show this script's version.");
365      console.log("  -o, --output=[FILE]  Write the generated changelog to");      console.log("  -f, --format         Set the changelog format.");
366        console.log("                       Supported formats are: plain,");
367        console.log("                       markdown.");
368        console.log("  -o, --output=<FILE>  Write the generated changelog to");
369      console.log("                       a file instead of standard output.");      console.log("                       a file instead of standard output.");
370      console.log("      --no-overwrite   Disallow overwriting of the output");      console.log("      --no-overwrite   Disallow overwriting of the output");
371      console.log("                       file if it exists already.");      console.log("                       file if it exists already.");
372      console.log();      console.log();
373      console.log("Send general inquiries, questions and bug reports");      console.log("Send general inquiries, questions and bug reports");
374      console.log("to <[email protected]>.");      console.log("to <[email protected]>.");
375  }  }
376    
377  function printVersion() {  function printVersion() {
378      console.log("Copyright (C) 2024 OSN, Inc.");      console.log("Copyright (C) 2024 OSN, Inc.");
379      console.log("License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.");      console.log(
380      console.log("This is free software: you are free to change and redistribute it.");          "License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.",
381        );
382        console.log(
383            "This is free software: you are free to change and redistribute it.",
384        );
385      console.log("There is NO WARRANTY, to the extent permitted by law.");      console.log("There is NO WARRANTY, to the extent permitted by law.");
386      console.log();      console.log();
387      console.log("Written by Ar Rakin.");      console.log("Written by Ar Rakin.");
# Line 212  async function main() { Line 398  async function main() {
398              options: {              options: {
399                  help: {                  help: {
400                      type: "boolean",                      type: "boolean",
401                      alias: 'h'                      alias: "h",
402                  },                  },
403                  version: {                  version: {
404                      type: "boolean",                      type: "boolean",
405                      alias: "v"                      alias: "v",
406                  },                  },
407                  output: {                  output: {
408                      type: "string",                      type: "string",
409                      short: "o"                      short: "o",
410                  },                  },
411                  "no-overwrite": {                  "no-overwrite": {
412                      type: "boolean"                      type: "boolean",
413                  }                  },
414              }                  format: {
415                        type: "string",
416                        short: "f",
417                    },
418                },
419          }).values;          }).values;
420      }      } catch (error) {
     catch (error) {  
421          perror(`${error?.message ?? error}`);          perror(`${error?.message ?? error}`);
422          exit(1);          exit(1);
423      }      }
# Line 243  async function main() { Line 432  async function main() {
432          exit(0);          exit(0);
433      }      }
434    
435        if (options.format && !["markdown", "plain"].includes(options.format)) {
436            perror(
437                "option `--format` or `-f` only accepts one of the following: markdown, plain",
438            );
439            exit(1);
440        }
441    
442      if (!options.output && options["no-overwrite"]) {      if (!options.output && options["no-overwrite"]) {
443          perror("option `--no-overwrite' without `--output` does not make sense");          perror(
444                "option `--no-overwrite' without `--output` does not make sense",
445            );
446          exit(1);          exit(1);
447      }      }
448        
449      if (options.output && options["no-overwrite"] && existsSync(options.output)) {      if (
450            options.output &&
451            options["no-overwrite"] &&
452            existsSync(options.output)
453        ) {
454          perror(`${options.output}: cannot write changelog: File exists`);          perror(`${options.output}: cannot write changelog: File exists`);
455          exit(1);          exit(1);
456      }      }
457        
458      const gitPath = checkForGit();      const gitPath = checkForGit();
459      const gitLog = getGitLog(gitPath);      const gitLog = await getGitLog(gitPath);
460      const commits = parseGitLog(gitLog);      const commits = parseGitLog(gitLog);
461      const changelog = generateChangelog(commits);      const filteredCommits = commits.filter(
462            (commit) =>
463                !/Merge pull request #\d+ from|Merge branch '\S+' of/.test(
464                    commit.message,
465                ),
466        );
467        const changelog =
468            options.format === "markdown"
469                ? generateMarkdownChangelog(filteredCommits)
470                : generateChangelog(filteredCommits);
471    
472      if (options.output) {              if (options.output) {
473          try {          try {
474              await writeFile(options.output, changelog);              await writeFile(options.output, changelog);
475          }          } catch (error) {
476          catch (error) {              perror(
477              perror(`${options.output}: failed to write changelog: ${error?.message ?? error}`);                  `${options.output}: failed to write changelog: ${
478                        error?.message ?? error
479                    }`,
480                );
481              exit(1);              exit(1);
482          }          }
483    
484          print(`wrote generated changelog to ${options.output}`);          print(`wrote generated changelog to ${options.output}`);
485      }      } else {
     else {  
486          console.log(changelog);          console.log(changelog);
487      }      }
488  }  }
Legend:
Removed from v.11  
changed lines
  Added in v.61
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26