gh-setup-git-identity 0.4.1 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # gh-setup-git-identity
 
+## 0.5.0
+
+### Minor Changes
+
+- 071e6d3: feat: add --verify option to verify git identity configuration
+
+  - Added `--verify` CLI option to run all 3 verification commands at once
+  - Users can now use `gh-setup-git-identity --verify` instead of running individual commands
+  - Works with `--local` flag for local repository configuration
+  - Updated README with verification documentation and code blocks
+
+## 0.4.2
+
+### Patch Changes
+
+- 72d4185: Improve output formatting with better organization and verification commands
+
+  - Added blank lines between major sections for better visual grouping
+  - Applied consistent indentation (2 spaces) to detail lines under section headers
+  - Added helpful verification commands suggestion at the end of output
+  - Updated README.md to reflect the new output format
+  - Makes output more readable and professional while providing actionable next steps
+
 ## 0.4.1
 
 ### Patch Changes

package/README.md

@@ -74,6 +74,9 @@ gh-setup-git-identity --local
 # Preview what would be configured (dry run)
 gh-setup-git-identity --dry-run
 
+# Verify current git identity configuration
+gh-setup-git-identity --verify
+
 # Enable verbose output
 gh-setup-git-identity --verbose
 ```
@@ -87,6 +90,7 @@ Options:
   --global, -g     Set git config globally (default: true)
   --local, -l      Set git config locally (in current repository)
   --dry-run, --dry Dry run - show what would be done without making changes
+  --verify         Verify current git identity configuration
   --verbose, -v    Enable verbose output
   --help, -h       Show help
   --version        Show version number
@@ -117,20 +121,53 @@ printf "y" | gh auth login -h github.com -s repo,workflow,user,read:org,gist --g
 
 ```
 Fetching GitHub user information...
-GitHub user: your-username
-GitHub email: your-email@example.com
+  GitHub user: your-username
+  GitHub email: your-email@example.com
 
 Configuring git (global)...
-Git identity configured successfully!
+  Git identity configured successfully!
 
-Git configured:
+  Git configured:
+    user.name:  your-username
+    user.email: your-email@example.com
+  Scope: global (--global)
 
-  user.name:  your-username
-  user.email: your-email@example.com
+Git identity setup complete!
 
-Scope: global (--global)
+You can verify your configuration with:
+  gh auth status
+  git config --global user.name
+  git config --global user.email
+```
 
-Git identity setup complete!
+### Verifying Configuration
+
+You can verify your git identity configuration at any time using:
+
+```bash
+gh-setup-git-identity --verify
+```
+
+Or by running the three verification commands directly:
+
+```bash
+gh auth status
+git config --global user.name
+git config --global user.email
+```
+
+For local repository configuration, use `--local`:
+
+```bash
+gh-setup-git-identity --verify --local
+```
+
+Or:
+
+```bash
+gh auth status
+git config --local user.name
+git config --local user.email
 ```
 
 ## Library Usage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gh-setup-git-identity",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "A tool to setup git identity based on current gh user",
   "type": "module",
   "main": "src/index.js",

package/src/cli.js

@@ -7,7 +7,7 @@
  */
 
 import { makeConfig } from 'lino-arguments';
-import { setupGitIdentity, isGhAuthenticated, runGhAuthLogin } from './index.js';
+import { setupGitIdentity, isGhAuthenticated, runGhAuthLogin, verifyGitIdentity } from './index.js';
 
 // Parse command-line arguments with environment variable and .lenv support
 const config = makeConfig({
@@ -38,6 +38,11 @@ const config = makeConfig({
         description: 'Dry run mode - show what would be done without making changes',
         default: getenv('GH_SETUP_GIT_IDENTITY_DRY_RUN', false)
       })
+      .option('verify', {
+        type: 'boolean',
+        description: 'Verify current git identity configuration',
+        default: false
+      })
       .check((argv) => {
         // --global and --local are mutually exclusive
         if (argv.global && argv.local) {
@@ -48,12 +53,68 @@ const config = makeConfig({
       .example('$0', 'Setup git identity globally using GitHub user')
       .example('$0 --local', 'Setup git identity for current repository only')
       .example('$0 --dry-run', 'Show what would be configured without making changes')
+      .example('$0 --verify', 'Verify current git identity configuration')
       .help('h')
       .alias('h', 'help')
       .version('0.1.0')
       .strict(),
 });
 
+/**
+ * Run verification commands and display results
+ * @param {string} scope - 'global' or 'local'
+ * @param {boolean} verbose - Enable verbose logging
+ */
+async function runVerify(scope, verbose) {
+  const scopeFlag = scope === 'local' ? '--local' : '--global';
+
+  console.log('Verifying git identity configuration...');
+  console.log('');
+
+  // 1. Run gh auth status
+  console.log('1. GitHub CLI authentication status:');
+  console.log('   $ gh auth status');
+  console.log('');
+
+  const { spawn } = await import('node:child_process');
+
+  // Run gh auth status interactively to show full output
+  await new Promise((resolve) => {
+    const child = spawn('gh', ['auth', 'status'], { stdio: 'inherit' });
+    child.on('close', resolve);
+    child.on('error', resolve);
+  });
+
+  console.log('');
+
+  // 2. Get git config user.name
+  console.log(`2. Git user.name (${scope}):`);
+  console.log(`   $ git config ${scopeFlag} user.name`);
+
+  const identity = await verifyGitIdentity({ scope, verbose });
+
+  if (identity.username) {
+    console.log(`   ${identity.username}`);
+  } else {
+    console.log('   (not set)');
+  }
+
+  console.log('');
+
+  // 3. Get git config user.email
+  console.log(`3. Git user.email (${scope}):`);
+  console.log(`   $ git config ${scopeFlag} user.email`);
+
+  if (identity.email) {
+    console.log(`   ${identity.email}`);
+  } else {
+    console.log('   (not set)');
+  }
+
+  console.log('');
+  console.log('Verification complete!');
+}
+
 /**
  * Main CLI function
  */
@@ -62,6 +123,12 @@ async function main() {
     // Determine scope
     const scope = config.local ? 'local' : 'global';
 
+    // Handle --verify mode
+    if (config.verify) {
+      await runVerify(scope, config.verbose);
+      process.exit(0);
+    }
+
     // Check if gh is authenticated
     const authenticated = await isGhAuthenticated({ verbose: config.verbose });
 
@@ -100,14 +167,19 @@ async function main() {
 
     // Display results
     console.log('');
-    console.log(`${options.dryRun ? '[DRY MODE] Would configure' : 'Git configured'}:`);
-    console.log(`  user.name:  ${result.username}`);
-    console.log(`  user.email: ${result.email}`);
-    console.log(`Scope: ${scope === 'global' ? 'global (--global)' : 'local (--local)'}`);
-    console.log('');
+    console.log(`  ${options.dryRun ? '[DRY MODE] Would configure' : 'Git configured'}:`);
+    console.log(`    user.name:  ${result.username}`);
+    console.log(`    user.email: ${result.email}`);
+    console.log(`  Scope: ${scope === 'global' ? 'global (--global)' : 'local (--local)'}`);
 
     if (!options.dryRun) {
+      console.log('');
       console.log('Git identity setup complete!');
+      console.log('');
+      console.log('You can verify your configuration with:');
+      console.log('  gh auth status');
+      console.log(`  git config ${scope === 'global' ? '--global' : '--local'} user.name`);
+      console.log(`  git config ${scope === 'global' ? '--global' : '--local'} user.email`);
     }
 
     process.exit(0);

package/src/index.js

@@ -141,7 +141,7 @@ export async function runGhAuthLogin(options = {}) {
     return false;
   }
 
-  log(() => 'GitHub CLI authentication successful!');
+  log(() => '\nGitHub CLI authentication successful!');
   return true;
 }
 
@@ -323,13 +323,13 @@ export async function setupGitIdentity(options = {}) {
 
   const log = createDefaultLogger({ verbose, logger });
 
-  log(() => 'Fetching GitHub user information...');
+  log(() => '\nFetching GitHub user information...');
 
   // Get GitHub user info
   const { username, email } = await getGitHubUserInfo({ verbose, logger });
 
-  log(() => `GitHub user: ${username}`);
-  log(() => `GitHub email: ${email}`);
+  log(() => `  GitHub user: ${username}`);
+  log(() => `  GitHub email: ${email}`);
 
   if (dryRun) {
     log(() => 'DRY MODE: Would configure the following:');
@@ -339,12 +339,12 @@ export async function setupGitIdentity(options = {}) {
   }
 
   // Set git config
-  log(() => `Configuring git (${scope})...`);
+  log(() => `\nConfiguring git (${scope})...`);
 
   await setGitConfig('user.name', username, { scope, verbose, logger });
   await setGitConfig('user.email', email, { scope, verbose, logger });
 
-  log(() => 'Git identity configured successfully!');
+  log(() => '  Git identity configured successfully!');
 
   return { username, email };
 }