/[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 54 by rakinar2, Thu Aug 29 06:17:33 2024 UTC
# Line 37  function perror(...args) { Line 37  function perror(...args) {
37  }  }
38    
39  function findInPath(executable) {  function findInPath(executable) {
40      for (const segment of process.env.PATH?.split(process.platform === "win32" ? ";" : ":") ?? []) {      for (const segment of process.env.PATH?.split(
41          const executablePath = path.join(segment, executable + (process.platform === "win32" ? ".exe" : ""));          process.platform === "win32" ? ";" : ":"
42                ) ?? []) {
43            const executablePath = path.join(
44                segment,
45                executable + (process.platform === "win32" ? ".exe" : "")
46            );
47    
48          if (existsSync(executablePath)) {          if (existsSync(executablePath)) {
49              return executablePath;              return executablePath;
50          }          }
# Line 63  function checkForGit() { Line 68  function checkForGit() {
68  function getGitLog(gitPath) {  function getGitLog(gitPath) {
69      try {      try {
70          return execSync(gitPath + " --no-pager log", { encoding: "utf8" });          return execSync(gitPath + " --no-pager log", { encoding: "utf8" });
71      }      } catch {
     catch {  
72          perror("command `git --no-pager log' failed");          perror("command `git --no-pager log' failed");
73          exit(1);          exit(1);
74      }      }
# Line 80  function parseGitLog(gitLog) { Line 84  function parseGitLog(gitLog) {
84              continue;              continue;
85          }          }
86    
87          const [, hash] = lines[i++].split(' ');          const [, hash] = lines[i++].split(" ");
88          const headerProps = {};          const headerProps = {};
89    
90          while (i < lines.length && lines[i].trim() !== "" && !/^\s/.test(lines[i])) {          while (
91                i < lines.length &&
92                lines[i].trim() !== "" &&
93                !/^\s/.test(lines[i])
94            ) {
95              const colonIndex = lines[i].indexOf(":");              const colonIndex = lines[i].indexOf(":");
96              const name = lines[i].slice(0, colonIndex).toLowerCase();              const name = lines[i].slice(0, colonIndex).toLowerCase();
97              const value = lines[i].slice(colonIndex + 1).trim();              const value = lines[i].slice(colonIndex + 1).trim();
# Line 99  function parseGitLog(gitLog) { Line 107  function parseGitLog(gitLog) {
107              if (!lineToPush) {              if (!lineToPush) {
108                  continue;                  continue;
109              }              }
110                
111              messageLines.push(lineToPush);              messageLines.push(lineToPush);
112          }          }
113    
114          let mindex = messageLines.length - 1;          let mindex = messageLines.length - 1;
115          const footerProps = {};          const footerProps = {};
116          const validFooterProps = ["signed-off-by", "co-authored-by", "on-behalf-of"];          const validFooterProps = [
117                        "signed-off-by",
118          while (mindex >= 1 && /^[A-Za-z0-9-]+: /.test(messageLines.at(mindex))) {              "co-authored-by",
119                "on-behalf-of",
120            ];
121    
122            while (
123                mindex >= 1 &&
124                /^[A-Za-z0-9-]+: /.test(messageLines.at(mindex))
125            ) {
126              const messageLine = messageLines[mindex--];              const messageLine = messageLines[mindex--];
127              const colonIndex = messageLine.indexOf(":");              const colonIndex = messageLine.indexOf(":");
128              const name = messageLine.slice(0, colonIndex).toLowerCase();              const name = messageLine.slice(0, colonIndex).toLowerCase();
# Line 115  function parseGitLog(gitLog) { Line 130  function parseGitLog(gitLog) {
130              if (!validFooterProps.includes(name)) {              if (!validFooterProps.includes(name)) {
131                  continue;                  continue;
132              }              }
133                
134              const value = messageLine.slice(colonIndex + 1).trim();              const value = messageLine.slice(colonIndex + 1).trim();
135    
136              if (name in footerProps && !Array.isArray(footerProps[name])) {              if (name in footerProps && !Array.isArray(footerProps[name])) {
# Line 124  function parseGitLog(gitLog) { Line 139  function parseGitLog(gitLog) {
139    
140              if (Array.isArray(footerProps[name])) {              if (Array.isArray(footerProps[name])) {
141                  footerProps[name].push(value);                  footerProps[name].push(value);
142              }              } else {
             else {  
143                  footerProps[name] = value;                  footerProps[name] = value;
144              }              }
145    
# Line 133  function parseGitLog(gitLog) { Line 147  function parseGitLog(gitLog) {
147          }          }
148    
149          const message = messageLines.join("\n");          const message = messageLines.join("\n");
150            
151          commits.push({          commits.push({
152              hash,              hash,
153              message,              message,
# Line 142  function parseGitLog(gitLog) { Line 156  function parseGitLog(gitLog) {
156              signedOffBy: footerProps["signed-off-by"],              signedOffBy: footerProps["signed-off-by"],
157              onBehalfOf: footerProps["on-behalf-of"],              onBehalfOf: footerProps["on-behalf-of"],
158              author: headerProps["author"],              author: headerProps["author"],
159              createdAt: new Date(headerProps["date"])              createdAt: new Date(headerProps["date"]),
160          });          });
161      }      }
162    
163      return commits;      return commits;
164  }  }
165    
166    function generateMarkdownChangelog(commits) {
167        let output = "# Changelog\n\n";
168    
169        const grouppedCommitsByDate = {};
170    
171        for (const commit of commits) {
172            const key = `${commit.createdAt
173                .getUTCDate()
174                .toString()
175                .padStart(2, 0)}-${(commit.createdAt.getUTCMonth() + 1)
176                .toString()
177                .padStart(2, "0")}-${commit.createdAt.getUTCFullYear()}::${
178                Array.isArray(commit.author)
179                    ? commit.author.join(":")
180                    : commit.author
181            }`;
182            grouppedCommitsByDate[key] ??= [];
183            grouppedCommitsByDate[key].push(commit);
184        }
185    
186        for (const key in grouppedCommitsByDate) {
187            const [date, author] = key.split("::");
188            output += `### ${date} [${author}]\n\n`;
189    
190            for (const commit of grouppedCommitsByDate[key]) {
191                const newLineIndex = commit.message.indexOf("\n");
192                output += `* ${commit.message.slice(0, newLineIndex === -1 ? undefined : newLineIndex)}\n`;
193            }
194    
195            output += "\n";
196        }
197    
198        return output;
199    }
200    
201  function generateChangelog(commits) {  function generateChangelog(commits) {
202      let output = "";      let output = "";
203    
204      const grouppedCommitsByDate = {};      const grouppedCommitsByDate = {};
205        
206      for (const commit of commits) {      for (const commit of commits) {
207          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.createdAt
208                .getUTCDate()
209                .toString()
210                .padStart(2, 0)}-${(commit.createdAt.getUTCMonth() + 1)
211                .toString()
212                .padStart(2, "0")}-${commit.createdAt.getUTCFullYear()}::${
213                Array.isArray(commit.author)
214                    ? commit.author.join(":")
215                    : commit.author
216            }`;
217          grouppedCommitsByDate[key] ??= [];          grouppedCommitsByDate[key] ??= [];
218          grouppedCommitsByDate[key].push(commit);          grouppedCommitsByDate[key].push(commit);
219      }      }
# Line 165  function generateChangelog(commits) { Line 223  function generateChangelog(commits) {
223          const date = key.slice(0, separatorPosition);          const date = key.slice(0, separatorPosition);
224          const commits = grouppedCommitsByDate[key];          const commits = grouppedCommitsByDate[key];
225    
226          output += `${date}  ${Array.isArray(commits[0].author) ? commits[0].author.join(", ") : commits[0].author}\n\n`;          output += `${date}  ${
227                Array.isArray(commits[0].author)
228                    ? commits[0].author.join(", ")
229                    : commits[0].author
230            }\n\n`;
231    
232          for (const commit of commits) {          for (const commit of commits) {
233              output += `        ${commit.message.replaceAll("\n", "\n        ")}\n\n`;              output += `        ${commit.message.replaceAll(
234                    "\n",
235                    "\n        "
236                )}\n\n`;
237          }          }
238      }      }
239        
240      return output.trim();      return output.trim();
241  }  }
242    
# Line 183  function printHelp() { Line 248  function printHelp() {
248      console.log("Options:");      console.log("Options:");
249      console.log("  -h, --help           Show this help and exit.");      console.log("  -h, --help           Show this help and exit.");
250      console.log("  -v, --version        Show this script's version.");      console.log("  -v, --version        Show this script's version.");
251      console.log("  -o, --output=[FILE]  Write the generated changelog to");      console.log("  -f, --format=        Set the changelog format.");
252        console.log("                       Supported formats are: plain,");
253        console.log("                       markdown.");
254        console.log("  -o, --output=<FILE>  Write the generated changelog to");
255      console.log("                       a file instead of standard output.");      console.log("                       a file instead of standard output.");
256      console.log("      --no-overwrite   Disallow overwriting of the output");      console.log("      --no-overwrite   Disallow overwriting of the output");
257      console.log("                       file if it exists already.");      console.log("                       file if it exists already.");
258      console.log();      console.log();
259      console.log("Send general inquiries, questions and bug reports");      console.log("Send general inquiries, questions and bug reports");
260      console.log("to <[email protected]>.");      console.log("to <[email protected]>.");
261  }  }
262    
263  function printVersion() {  function printVersion() {
264      console.log("Copyright (C) 2024 OSN, Inc.");      console.log("Copyright (C) 2024 OSN, Inc.");
265      console.log("License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.");      console.log(
266      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>."
267        );
268        console.log(
269            "This is free software: you are free to change and redistribute it."
270        );
271      console.log("There is NO WARRANTY, to the extent permitted by law.");      console.log("There is NO WARRANTY, to the extent permitted by law.");
272      console.log();      console.log();
273      console.log("Written by Ar Rakin.");      console.log("Written by Ar Rakin.");
# Line 212  async function main() { Line 284  async function main() {
284              options: {              options: {
285                  help: {                  help: {
286                      type: "boolean",                      type: "boolean",
287                      alias: 'h'                      alias: "h",
288                  },                  },
289                  version: {                  version: {
290                      type: "boolean",                      type: "boolean",
291                      alias: "v"                      alias: "v",
292                  },                  },
293                  output: {                  output: {
294                      type: "string",                      type: "string",
295                      short: "o"                      short: "o",
296                  },                  },
297                  "no-overwrite": {                  "no-overwrite": {
298                      type: "boolean"                      type: "boolean",
299                    },
300                    format: {
301                        type: "string",
302                        short: "f"
303                  }                  }
304              }              },
305          }).values;          }).values;
306      }      } catch (error) {
     catch (error) {  
307          perror(`${error?.message ?? error}`);          perror(`${error?.message ?? error}`);
308          exit(1);          exit(1);
309      }      }
# Line 243  async function main() { Line 318  async function main() {
318          exit(0);          exit(0);
319      }      }
320    
321        if (options.format && !["markdown", "plain"].includes(options.format)) {
322            perror("option `--format` or `-f` only accepts one of the following: markdown, plain");
323            exit(1);
324        }
325    
326      if (!options.output && options["no-overwrite"]) {      if (!options.output && options["no-overwrite"]) {
327          perror("option `--no-overwrite' without `--output` does not make sense");          perror(
328                "option `--no-overwrite' without `--output` does not make sense"
329            );
330          exit(1);          exit(1);
331      }      }
332        
333      if (options.output && options["no-overwrite"] && existsSync(options.output)) {      if (
334            options.output &&
335            options["no-overwrite"] &&
336            existsSync(options.output)
337        ) {
338          perror(`${options.output}: cannot write changelog: File exists`);          perror(`${options.output}: cannot write changelog: File exists`);
339          exit(1);          exit(1);
340      }      }
341        
342      const gitPath = checkForGit();      const gitPath = checkForGit();
343      const gitLog = getGitLog(gitPath);      const gitLog = getGitLog(gitPath);
344      const commits = parseGitLog(gitLog);      const commits = parseGitLog(gitLog);
345      const changelog = generateChangelog(commits);      const filteredCommits = commits.filter(
346            (commit) =>
347                !/Merge pull request #\d+ from|Merge branch '\S+' of/.test(
348                    commit.message
349                )
350        );
351        const changelog = options.format === "markdown" ? generateMarkdownChangelog(filteredCommits) : generateChangelog(filteredCommits);
352    
353      if (options.output) {              if (options.output) {
354          try {          try {
355              await writeFile(options.output, changelog);              await writeFile(options.output, changelog);
356          }          } catch (error) {
357          catch (error) {              perror(
358              perror(`${options.output}: failed to write changelog: ${error?.message ?? error}`);                  `${options.output}: failed to write changelog: ${
359                        error?.message ?? error
360                    }`
361                );
362              exit(1);              exit(1);
363          }          }
364    
365          print(`wrote generated changelog to ${options.output}`);          print(`wrote generated changelog to ${options.output}`);
366      }      } else {
     else {  
367          console.log(changelog);          console.log(changelog);
368      }      }
369  }  }
Legend:
Removed from v.11  
changed lines
  Added in v.54
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26