@kors/generate-changelog 0.1.11 → 0.2.0

package/distribution/cli.js

@@ -1,4 +1,38 @@
 #!/usr/bin/env node
 import { generateChangelog } from "./lib/index.js";
-const write = process.argv[2];
-console.log(generateChangelog({ write: write ? true : false }));
+import meow from 'meow';
+const cli = meow(`
+	Usage
+	  $ generate-changelog <input>
+
+	Options
+	  --write, -w 	Write output to changelog.json
+	  --owner, -o 	Fetch commits from github owner (used with --repo)
+	  --repo, -r 		Fetch commit from github repo (used with --owner)
+	  --version 		Print current version
+	  --help 				Print help message
+
+	Examples:
+        Generate from local repo:
+        $ generate-changelog --write 
+
+        Generate from remote repo:
+        $ generate-changelog --owner="StefKors" --repo="generate-changelog" 
+`, {
+    importMeta: import.meta,
+    flags: {
+        write: {
+            type: 'boolean',
+            shortFlag: 'w'
+        },
+        owner: {
+            type: 'string',
+            shortFlag: 'o'
+        },
+        repo: {
+            type: 'string',
+            shortFlag: 'r'
+        }
+    }
+});
+generateChangelog(cli.flags);

package/distribution/lib/fetchGitHubCommits.d.ts

@@ -0,0 +1 @@
+export declare const fetchGitHubCommits: (owner: string, repo: string) => Promise<string[]>;

package/distribution/lib/fetchGitHubCommits.js

@@ -0,0 +1,13 @@
+import { Octokit } from 'octokit';
+export const fetchGitHubCommits = async (owner, repo) => {
+    const octokit = new Octokit({});
+    const data = await octokit.paginate('GET /repos/{owner}/{repo}/commits', {
+        owner: owner,
+        repo: repo,
+        per_page: 100,
+    });
+    return data?.map((item) => {
+        // add short sha and commit message together
+        return `${item.sha.substring(0, 7)} ${item.commit.message}`;
+    });
+};

package/distribution/lib/getLocalCommits.d.ts

@@ -0,0 +1 @@
+export declare const getLocalCommits: () => string[];

package/distribution/lib/getLocalCommits.js

@@ -0,0 +1,6 @@
+import { execSync } from 'node:child_process';
+export const getLocalCommits = () => {
+    // Get git log output
+    const gitLog = execSync('git log --oneline  --no-color').toString();
+    return gitLog.split('\n');
+};

package/distribution/lib/index.d.ts

@@ -1,5 +1,7 @@
 export interface Options {
     write?: boolean;
+    repo?: string;
+    owner?: string;
 }
-declare const generateChangelog: ({ write }: Options) => {};
+declare const generateChangelog: ({ write, owner, repo }: Options) => Promise<{}>;
 export { generateChangelog };

package/distribution/lib/index.js

@@ -1,11 +1,17 @@
-// run with `npx tsx scripts/generate-changelog.ts` or something
-import { execSync } from 'node:child_process';
 import * as fs from 'node:fs';
-const generateChangelog = ({ write }) => {
+import { getLocalCommits } from './getLocalCommits.js';
+import { fetchGitHubCommits } from './fetchGitHubCommits.js';
+const generateChangelog = async ({ write, owner, repo }) => {
     try {
-        // Get git log output
-        const gitLog = execSync('git log --oneline  --no-color').toString();
-        const lines = gitLog.split('\n');
+        let lines = [];
+        if (repo && owner) {
+            console.log("fetching from remote", owner, repo);
+            lines = await fetchGitHubCommits(owner, repo);
+        }
+        else {
+            console.log("reading local commits");
+            lines = getLocalCommits();
+        }
         // Initialize changelog object
         const changelog = {
             releases: {},

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kors/generate-changelog",
   "description": "Generate a changelog json from a git commit history",
-  "version": "0.1.11",
+  "version": "0.2.0",
   "type": "module",
   "bin": {
     "generate-changelog": "./distribution/cli.js"
@@ -16,7 +16,13 @@
     "email": "stef.kors+npmpackage@gmail.com",
     "url": "https://github.com/StefKors"
   },
-  "repository": "https://github.com/StefKors/generate-changelog",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/StefKors/generate-changelog.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
   "files": [
     "distribution"
   ],
@@ -57,5 +63,9 @@
     "command-line tool",
     "open source",
     "developer tools"
-  ]
+  ],
+  "dependencies": {
+    "meow": "^13.2.0",
+    "octokit": "^4.0.2"
+  }
 }