feat: add debugging option

deno.jsonc

@@ -7,6 +7,7 @@
     "zod": "https://deno.land/x/zod@v3.20.1/mod.ts",
     "rambda": "https://mckgnjtrq3abdh6fhic5ddwopjdoxtpu2vvkyphhzwui4egizoma.arweave.net/YJRmpnGGwBGfxToF0Y7OekbrzfTVaqw8582ojhDIy5g/mod.ts",
     "memoizy": "https://deno.land/x/memoizy@1.0.0/mod.ts",
+    "logger": "https://deno.land/x/logger@v1.1.1/logger.ts",
     "version": "./version.ts",
     "commands/config": "./src/commands/config/mod.ts",
     "models/repository": "./src/models/repository/mod.ts",
@@ -20,11 +21,7 @@
     }
   },
   "fmt": {
-    "files": {
-      "exclude": ["dist"]
-    },
-    "options": {
-      "singleQuote": true
-    }
+    "singleQuote": true,
+    "exclude": ["dist"]
   }
 }

src/commands/add.ts

@@ -1,37 +1,47 @@
 import { EOL } from 'std/fs';
 import { basename } from 'std/path';
 import { Checkbox, colors, Command } from 'cliffy';
+import { logger } from 'lib';
 import { getConfig, RepoType, setConfig } from '../config.ts';
 import { getAuthors } from '../git.ts';
 
 export default new Command()
   .description('Add one or more local repositories for syncing.')
   .arguments('<...repositories:string>')
-  .option('-e, --email <email:string>', 'Email to sync', { collect: true })
-  .action(async (_, ...repoPaths) => {
+  .option('-d, --debug', 'Enable debug output.')
+  .action(async ({ debug }, ...repoPaths) => {
+    if (debug) logger.enable();
+
+    logger.info('Adding following repositories:', repoPaths);
     const config = await getConfig();
+
+    logger.info('Current config:', config);
     const mutableConfig = { ...config };
 
     for (const repoPath of repoPaths) {
       const authors = await getAuthors(repoPath);
+      logger.info('Authors:', authors);
 
       const selectedAuthors: string[] = await Checkbox.prompt({
         message: `Select authors of commits to extract from the "${
           basename(repoPath)
         } repository". Use arrow keys for navigation, space to select, and enter to submit.`,
         options: authors.map((author) => `${author.name} <${author.email}>`),
       });
+      logger.info('Selected authors:', selectedAuthors);
 
       const repo: RepoType = {
         dir: repoPath,
         authors: authors.filter((author) =>
           selectedAuthors.includes(`${author.name} <${author.email}>`)
         ),
       };
+      logger.info('Repository details:', repo);
 
       mutableConfig.repos[basename(repoPath)] = repo;
     }
 
+    logger.info('Setting new config:', mutableConfig);
     await setConfig(mutableConfig);
 
     console.log(

src/commands/sync.ts

@@ -1,6 +1,6 @@
 import { colors, Command, Select } from 'cliffy';
 import { join } from 'std/path';
-import { ghNoReplyCheck, promptAllInputs, validate } from 'lib';
+import { ghNoReplyCheck, logger, promptAllInputs, validate } from 'lib';
 import { getConfig, getConfigDir, setConfig } from '../config.ts';
 import {
   AuthorSchema,
@@ -22,11 +22,17 @@ const SYNC_REPO_PATH = join(getConfigDir(), 'sync-repo');
 
 export default new Command()
   .description('Synchronize commits from local repositories to GitHub profile.')
-  .action(async () => {
+  .option('-d, --debug', 'Enable debug output.')
+  .action(async ({ debug }) => {
+    if (debug) logger.enable();
+
     let config = await getConfig();
+    logger.info('Current config:', config);
 
     if (!config.syncRepo) {
+      logger.info('No sync repository found. Cloning one...');
       const repos = await getRepositories();
+      logger.info('Found repositories:', repos);
 
       const id = await Select.prompt({
         message: 'Choose a repository to sync commits to:',
@@ -35,15 +41,23 @@ export default new Command()
         options: repos.map((repo) => ({ value: repo.id, name: repo.name })),
       });
       const selectedRepo = repos.find((repo) => repo.id === id);
+      logger.info('Selected repository:', selectedRepo);
       await cloneRepository(selectedRepo!, 'sync-repo', getConfigDir());
       await setConfig({ syncRepo: selectedRepo });
       config = await getConfig();
+      logger.info('New config:', config);
     } else {
+      logger.info('Sync repository found. Pulling latest changes...');
       await pullRepositoryChanges(SYNC_REPO_PATH);
     }
 
     if (!config.author) {
+      logger.info('No author found. Prompting one...');
       const currentGitAuthor = await getGitAuthor();
+      logger.info(
+        'Current git author configured in git config:',
+        currentGitAuthor,
+      );
       const [name, email] = await promptAllInputs(
         Object.keys(AuthorSchema.shape).map((key) => ({
           message: `Authoring ${key}:`,
@@ -59,11 +73,14 @@ export default new Command()
       ghNoReplyCheck(email);
 
       const author: AuthorType = { name, email };
+      logger.info('Selected author:', { name, email });
       await setConfig({ author });
       config = await getConfig();
+      logger.info('New config:', config);
     }
 
     const history = await getGitHistory(SYNC_REPO_PATH);
+    logger.info('Current history:', history);
     const authorsWithDirs: Array<AuthorType & { dir: string }> = Object.values(
       config.repos,
     ).flatMap((repo) =>
@@ -76,6 +93,7 @@ export default new Command()
     )).flat().filter((commit) =>
       !history.some((entry) => entry?.hash === commit.hash)
     );
+    logger.info('New commits:', commits);
 
     if (!commits.length) {
       console.log('No new commits to synchronize. Exiting...');
@@ -88,12 +106,14 @@ export default new Command()
     );
 
     commits.forEach((commit) => {
+      logger.info('Creating commit:', commit);
       createCommit(
         { ...commit, author: config.author! },
         SYNC_REPO_PATH,
       );
     });
 
+    logger.info('Pushing changes to sync repository...');
     await pushRepositoryChanges(SYNC_REPO_PATH);
 
     console.log(

src/gh.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { logger } from 'lib';
 
 export const RepositorySchema = z.object({
   id: z.string().trim(),
@@ -59,6 +60,7 @@ export async function pullRepositoryChanges(
 
     if (cmdOutput.code !== 0) throw new TextDecoder().decode(cmdOutput.stderr);
   } catch (err) {
+    logger.error('Pulling repository changes failed:', err);
     // with a clean repo there are no changes to pull yet
     if (typeof err != 'string' || !err.includes('invalid refspec')) throw err;
   }

src/git.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { logger } from 'lib';
 
 export const AuthorSchema = z.object({
   name: z.string().min(1).trim(),
@@ -75,7 +76,8 @@ export async function getGitAuthor(): Promise<AuthorType | undefined> {
 
   try {
     return AuthorSchema.parse({ name, email });
-  } catch (_) { // todo: debugger
+  } catch (err) {
+    logger.error('Failed to parse git author:', err);
     return;
   }
 }

src/lib/logger.ts

@@ -0,0 +1,7 @@
+import Logger from 'logger';
+
+const logger = new Logger();
+
+logger.disable();
+
+export { logger };

src/lib/mod.ts

@@ -3,3 +3,4 @@ export { validate } from './validate.ts';
 export { promptAllInputs } from './promptAllInputs.ts';
 export { ghNoReplyCheck } from './ghNoReplyCheck.ts';
 export { ensurePath } from './ensurePath.ts';
+export { logger } from './logger.ts';

src/main.ts

@@ -12,6 +12,7 @@ await new Command()
   .action(function (this: Command) {
     this.showHelp();
   })
+  .option('-d, --debug', 'Enable debug output.', { global: true })
   .command('add', add)
   .command('sync', sync)
   .parse(Deno.args);