feat(cli): add support for dry-run, verbose

Author: avivkeller

.github/workflows/create-meeting-artifacts-manual.yml

@@ -31,6 +31,11 @@ on:
           - uvwasi
           - userfeedback
           - web-server-frameworks
+      dry_run:
+        type: boolean
+        description: 'Dry run?'
+        default: false
+        required: true
 
 jobs:
   create-artifacts:
@@ -68,7 +73,7 @@ jobs:
           GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
           HACKMD_API_TOKEN: ${{ secrets.HACKMD_API_TOKEN }}
           GOOGLE_API_KEY: ${{ secrets.GOOGLE_API_KEY }}
-        run: node create-node-meeting-artifacts.mjs ${{ github.event.inputs.meeting_group }}
+        run: node create-node-meeting-artifacts.mjs ${{ github.event.inputs.meeting_group }} --verbose ${{ github.event.inputs.dry_run && '--dry-run' }}
 
       - name: Upload artifacts
         if: always()

.github/workflows/create-meeting-artifacts-scheduled.yml

@@ -68,7 +68,7 @@ jobs:
           GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
           HACKMD_API_TOKEN: ${{ secrets.HACKMD_API_TOKEN }}
           GOOGLE_API_KEY: ${{ secrets.GOOGLE_API_KEY }}
-        run: node create-node-meeting-artifacts.mjs ${{ matrix.meeting_group }}
+        run: node create-node-meeting-artifacts.mjs ${{ matrix.meeting_group }} --verbose
 
       - name: Upload artifacts
         if: always()

create-node-meeting-artifacts.mjs

@@ -9,14 +9,28 @@
  * npm run dev -- tsc
  */
 
-import { getConfig } from './src/config.mjs';
+import { Command } from 'commander';
+
+import environmentConfig from './src/config.mjs';
 import * as github from './src/github.mjs';
 import * as google from './src/google.mjs';
 import * as hackmd from './src/hackmd.mjs';
 import * as meetings from './src/meeting.mjs';
 
+const program = new Command();
+program
+  .argument('<group>', 'Meeting group')
+  .option('--dry-run', 'Show output without creating/updating anything', false)
+  .option('--verbose', 'Show debug output')
+  .parse(process.argv);
+
 // Step 1: Application configuration
-const config = getConfig();
+/** @type {import('./src/types').AppConfig} */
+const config = {
+  ...environmentConfig,
+  ...program.opts(),
+  meetingGroup: program.args[0],
+};
 
 // Step 2: Initialize Google Calendar client with API Key
 const calendarClient = google.createCalendarClient(config.google);
@@ -28,7 +42,8 @@ const githubClient = github.createGitHubClient(config);
 const meetingConfig = await meetings.readMeetingConfig(config);
 
 // Step 5: Initialize HackMD client with meeting configuration
-const hackmdClient = hackmd.createHackMDClient(config, meetingConfig);
+const hackmdClient =
+  config.dryRun || hackmd.createHackMDClient(config, meetingConfig);
 
 // Step 6: Find next meeting event in calendar
 const event = await google.findNextMeetingEvent(calendarClient, meetingConfig);
@@ -54,11 +69,9 @@ const gitHubAgendaIssues = await github.getAgendaIssues(
 const meetingAgenda = meetings.generateMeetingAgenda(gitHubAgendaIssues);
 
 // Step 11: Create HackMD document with meeting notes and tags
-const hackmdNote = await hackmd.createMeetingNotesDocument(
-  hackmdClient,
-  meetingTitle,
-  ''
-);
+const hackmdNote = config.dryRun
+  ? {}
+  : await hackmd.createMeetingNotesDocument(hackmdClient, meetingTitle, '');
 
 // Step 12: Get the HackMD document link
 const minutesDocLink =
@@ -74,12 +87,14 @@ const issueContent = await meetings.generateMeetingIssue(
 );
 
 // Step 14: Create GitHub issue with HackMD link
-const githubIssue = await github.createGitHubIssue(
-  githubClient,
-  meetingConfig,
-  meetingTitle,
-  issueContent
-);
+const githubIssue = config.dryRun
+  ? {}
+  : await github.createGitHubIssue(
+      githubClient,
+      meetingConfig,
+      meetingTitle,
+      issueContent
+    );
 
 // Step 15: Update the minutes content with the HackMD link
 const minutesContent = await meetings.generateMeetingMinutes(
@@ -91,13 +106,19 @@ const minutesContent = await meetings.generateMeetingMinutes(
   githubIssue.html_url
 );
 
-// Step 16: Update the HackMD document with the self-referencing link
-await hackmd.updateMeetingNotesDocument(
-  hackmdClient,
-  hackmdNote.id,
-  minutesContent
-);
-
-// Output success information with links
-console.log(`Created GitHub issue: ${githubIssue.html_url}`);
-console.log(`Created HackMD document: ${minutesDocLink}`);
+if (config.dryRun) {
+  console.log('Would create GitHub issue with the following content:');
+  console.log(issueContent);
+  console.log('Would create HackMD note with the following content:');
+  console.log(minutesContent);
+} else {
+  // Step 16: Update the HackMD document with the self-referencing link
+  await hackmd.updateMeetingNotesDocument(
+    hackmdClient,
+    hackmdNote.id,
+    minutesContent
+  );
+
+  console.log(`Created GitHub issue: ${githubIssue.html_url}`);
+  console.log(`Created HackMD document: ${minutesDocLink}`);
+}

package-lock.json

@@ -14,6 +14,7 @@
     "@googleapis/calendar": "^11.0.1",
     "@hackmd/api": "^2.5.0",
     "@octokit/rest": "^22.0.0",
+    "commander": "^14.0.1",
     "dedent": "^1.6.0",
     "dotenv": "^17.2.2"
   },

package.json

@@ -4,13 +4,9 @@ import { join, dirname } from 'node:path';
 const defaultMeetingsDirectory = join(homedir(), '.make-node-meeting');
 
 /**
- * Gets the application configuration from environment variables and arguments
- * @returns {import('./types.d.ts').AppConfig} Application configuration object
+ * @type {import('./types.d.ts').EnvironmentConfig} Environment configuration object
  */
-export const getConfig = () => ({
-  // Meeting group from command line argument, defaults to 'tsc'
-  meetingGroup: process.argv[2],
-
+export default {
   // GitHub personal access token from environment
   githubToken: process.env.GITHUB_TOKEN,
 
@@ -32,4 +28,4 @@ export const getConfig = () => ({
     output: process.env.MEETINGS_OUTPUT_DIR || defaultMeetingsDirectory,
     templates: join(dirname(import.meta.dirname), 'templates'),
   },
-});
+};

src/config.mjs

@@ -7,8 +7,8 @@ import { DEFAULT_CONFIG } from './constants.mjs';
  * @param {import('./types.d.ts').AppConfig} config - Application configuration
  * @returns {import('@octokit/rest').Octokit} Configured GitHub API client
  */
-export const createGitHubClient = ({ githubToken: auth }) =>
-  new Octokit({ auth });
+export const createGitHubClient = ({ githubToken: auth, verbose }) =>
+  new Octokit({ auth, log: verbose ? console : undefined });
 
 /**
  * Creates GitHub issue with meeting information and Google Doc link

src/github.mjs

@@ -1,9 +1,7 @@
 /**
  * Application configuration object
  */
-export interface AppConfig {
-  /** Meeting group from command line argument */
-  meetingGroup: string;
+export interface EnvironmentConfig {
   /** GitHub personal access token */
   githubToken: string;
   /** Google API configuration (Calendar only) */
@@ -14,6 +12,17 @@ export interface AppConfig {
   directories: DirectoryConfig;
 }
 
+/**
+ * CLI configuration object
+ */
+export interface CLIConfig {
+  verbose: boolean;
+  dryRun: boolean;
+  meetingGroup: string;
+}
+
+export type AppConfig = EnvironmentConfig & CLIConfig;
+
 /**
  * Google authentication configuration (Calendar only)
  */