/[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 55 by rakinar2, Fri Aug 30 11:42:33 2024 UTC
# Line 25  const { exit } = require("process"); Line 25  const { exit } = require("process");
25  const { execSync } = require("child_process");  const { execSync } = 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 62  function checkForGit() { Line 70  function checkForGit() {
70    
71  function getGitLog(gitPath) {  function getGitLog(gitPath) {
72      try {      try {
73          return execSync(gitPath + " --no-pager log", { encoding: "utf8" });          return execSync(
74      }              gitPath +
75      catch {                  ` --no-pager log --pretty=format:"%h %H %an${GIT_SPACE_BOUNDARY} %ae %ad${GIT_SPACE_BOUNDARY} %B${GIT_COMMIT_BOUNDARY}"`,
76          perror("command `git --no-pager log' failed");              { encoding: "utf8" },
77            );
78        } catch {
79            perror("command `git log' failed");
80          exit(1);          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) {  function parseGitLog(gitLog) {
     const lines = gitLog.split("\n");  
116      const commits = [];      const commits = [];
117    
118      for (let i = 0; i < lines.length; ) {      let i = 0;
         if (!lines[i].startsWith("commit")) {  
             i++;  
             continue;  
         }  
119    
120          const [, hash] = lines[i++].split(' ');      while (i < gitLog.length) {
121          const headerProps = {};          const { output, size } = strUntil(gitLog.slice(i), GIT_COMMIT_BOUNDARY);
122            i += size;
123    
124          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++;  
         }  
125    
126          const messageLines = [];          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          while (i < lines.length && !lines[i].startsWith("commit")) {          outputIndex += shortId.length + id.length + 2;
             const lineToPush = lines[i++].replace(/^    /, "");  
132    
133              if (!lineToPush) {          const { output: authorName, size: authorNameSize } = strUntil(
134                  continue;              output.slice(outputIndex),
135              }              GIT_SPACE_BOUNDARY,
136                        );
137              messageLines.push(lineToPush);  
138          }          outputIndex += authorNameSize + 1;
139    
140          let mindex = messageLines.length - 1;          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 = {};          const footerProps = {};
166          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();  
167    
168              if (!validFooterProps.includes(name)) {          for (const line of body.split("\n")) {
169                  continue;              const colonIndex = line.indexOf(":");
170              }              const key = line.slice(0, colonIndex).trim().toLowerCase();
171                            const value = line.slice(colonIndex + 1).trim();
             const value = messageLine.slice(colonIndex + 1).trim();  
172    
173              if (name in footerProps && !Array.isArray(footerProps[name])) {              if (validFooterProps.includes(key)) {
174                  footerProps[name] = [footerProps[name]];                  footerProps[key] = value;
175              }              }
176    
177              if (Array.isArray(footerProps[name])) {              if (key === "co-authored-by") {
178                  footerProps[name].push(value);                  const name = value.slice(0, value.lastIndexOf(" ")).trim();
             }  
             else {  
                 footerProps[name] = value;  
             }  
179    
180              messageLines.splice(mindex - 1, 1);                  coAuthors.push({
181                        name,
182                        email: value
183                            .slice(name.length)
184                            .trim()
185                            .replace(/^<|>$/g, ""),
186                    });
187                }
188          }          }
189    
         const message = messageLines.join("\n");  
           
190          commits.push({          commits.push({
191              hash,              shortId,
192              message,              id,
193              headerProps,              author: {
194                    name: authorName,
195                    email: authorEmail,
196                },
197                date: new Date(date),
198                subject,
199                body,
200              footerProps,              footerProps,
201              signedOffBy: footerProps["signed-off-by"],              message,
202              onBehalfOf: footerProps["on-behalf-of"],              coAuthors,
203              author: headerProps["author"],              authors: [
204              createdAt: new Date(headerProps["date"])                  {
205                        name: authorName,
206                        email: authorEmail,
207                    },
208                    ...coAuthors,
209                ],
210          });          });
211      }      }
212    
213      return commits;      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) {  function generateChangelog(commits) {
292      let output = "";      let output = "";
293    
294      const grouppedCommitsByDate = {};      const grouppedCommitsByDate = {};
295        
296      for (const commit of commits) {      for (const commit of commits) {
297          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)}-${(
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] ??= [];          grouppedCommitsByDate[key] ??= [];
306          grouppedCommitsByDate[key].push(commit);          grouppedCommitsByDate[key].push(commit);
307      }      }
# Line 165  function generateChangelog(commits) { Line 311  function generateChangelog(commits) {
311          const date = key.slice(0, separatorPosition);          const date = key.slice(0, separatorPosition);
312          const commits = grouppedCommitsByDate[key];          const commits = grouppedCommitsByDate[key];
313    
314          output += `${date}  ${Array.isArray(commits[0].author) ? commits[0].author.join(", ") : commits[0].author}\n\n`;          output += `${date}  ${commits[0].authors
315                .map((a) => `${a.name} <${a.email}>`)
316                .join(", ")}\n\n`;
317    
318          for (const commit of commits) {          for (const commit of commits) {
319              output += `        ${commit.message.replaceAll("\n", "\n        ")}\n\n`;              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();      return output.trim();
327  }  }
328    
# Line 183  function printHelp() { Line 334  function printHelp() {
334      console.log("Options:");      console.log("Options:");
335      console.log("  -h, --help           Show this help and exit.");      console.log("  -h, --help           Show this help and exit.");
336      console.log("  -v, --version        Show this script's version.");      console.log("  -v, --version        Show this script's version.");
337      console.log("  -o, --output=[FILE]  Write the generated changelog to");      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.");      console.log("                       a file instead of standard output.");
342      console.log("      --no-overwrite   Disallow overwriting of the output");      console.log("      --no-overwrite   Disallow overwriting of the output");
343      console.log("                       file if it exists already.");      console.log("                       file if it exists already.");
344      console.log();      console.log();
345      console.log("Send general inquiries, questions and bug reports");      console.log("Send general inquiries, questions and bug reports");
346      console.log("to <[email protected]>.");      console.log("to <[email protected]>.");
347  }  }
348    
349  function printVersion() {  function printVersion() {
350      console.log("Copyright (C) 2024 OSN, Inc.");      console.log("Copyright (C) 2024 OSN, Inc.");
351      console.log("License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.");      console.log(
352      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>.",
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.");      console.log("There is NO WARRANTY, to the extent permitted by law.");
358      console.log();      console.log();
359      console.log("Written by Ar Rakin.");      console.log("Written by Ar Rakin.");
# Line 212  async function main() { Line 370  async function main() {
370              options: {              options: {
371                  help: {                  help: {
372                      type: "boolean",                      type: "boolean",
373                      alias: 'h'                      alias: "h",
374                  },                  },
375                  version: {                  version: {
376                      type: "boolean",                      type: "boolean",
377                      alias: "v"                      alias: "v",
378                  },                  },
379                  output: {                  output: {
380                      type: "string",                      type: "string",
381                      short: "o"                      short: "o",
382                  },                  },
383                  "no-overwrite": {                  "no-overwrite": {
384                      type: "boolean"                      type: "boolean",
385                  }                  },
386              }                  format: {
387                        type: "string",
388                        short: "f",
389                    },
390                },
391          }).values;          }).values;
392      }      } catch (error) {
     catch (error) {  
393          perror(`${error?.message ?? error}`);          perror(`${error?.message ?? error}`);
394          exit(1);          exit(1);
395      }      }
# Line 243  async function main() { Line 404  async function main() {
404          exit(0);          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"]) {      if (!options.output && options["no-overwrite"]) {
415          perror("option `--no-overwrite' without `--output` does not make sense");          perror(
416                "option `--no-overwrite' without `--output` does not make sense",
417            );
418          exit(1);          exit(1);
419      }      }
420        
421      if (options.output && options["no-overwrite"] && existsSync(options.output)) {      if (
422            options.output &&
423            options["no-overwrite"] &&
424            existsSync(options.output)
425        ) {
426          perror(`${options.output}: cannot write changelog: File exists`);          perror(`${options.output}: cannot write changelog: File exists`);
427          exit(1);          exit(1);
428      }      }
429        
430      const gitPath = checkForGit();      const gitPath = checkForGit();
431      const gitLog = getGitLog(gitPath);      const gitLog = getGitLog(gitPath);
432      const commits = parseGitLog(gitLog);      const commits = parseGitLog(gitLog);
433      const changelog = generateChangelog(commits);      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) {              if (options.output) {
445          try {          try {
446              await writeFile(options.output, changelog);              await writeFile(options.output, changelog);
447          }          } catch (error) {
448          catch (error) {              perror(
449              perror(`${options.output}: failed to write changelog: ${error?.message ?? error}`);                  `${options.output}: failed to write changelog: ${
450                        error?.message ?? error
451                    }`,
452                );
453              exit(1);              exit(1);
454          }          }
455    
456          print(`wrote generated changelog to ${options.output}`);          print(`wrote generated changelog to ${options.output}`);
457      }      } else {
     else {  
458          console.log(changelog);          console.log(changelog);
459      }      }
460  }  }
Legend:
Removed from v.11  
changed lines
  Added in v.55
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26