gh-setup-git-identity 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # gh-setup-git-identity
 
+## 0.3.0
+
+### Minor Changes
+
+- 8c146cc: Automatically run `gh auth login` when GitHub CLI is not authenticated, enabling single-command setup instead of requiring manual login first
+
+## 0.2.3
+
+### Patch Changes
+
+- Test patch release
+
+## 0.2.2
+
+### Patch Changes
+
+- cead870: Add NPM version badge to README.md to display current package version from npm registry
+
+## 0.2.1
+
+### Patch Changes
+
+- 6158223: Update gh auth login command in docs and CLI to use `--git-protocol https --web` flags for improved browser-based authentication flow
+
 ## 0.2.0
 
 ### Minor Changes

package/README.md

@@ -2,6 +2,7 @@
 
 A tool to setup git identity based on current GitHub user.
 
+[![npm version](https://img.shields.io/npm/v/gh-setup-git-identity)](https://www.npmjs.com/package/gh-setup-git-identity)
 [![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](http://unlicense.org/)
 [![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org/)
 
@@ -12,7 +13,7 @@ A tool to setup git identity based on current GitHub user.
 Instead of manually running:
 
 ```bash
-gh auth login -h github.com -s repo,workflow,user,read:org,gist
+printf "y" | gh auth login -h github.com -s repo,workflow,user,read:org,gist --git-protocol https --web
 
 USERNAME=$(gh api user --jq '.login')
 EMAIL=$(gh api user/emails --jq '.[] | select(.primary==true) | .email')
@@ -92,16 +93,23 @@ Options:
 
 ### First Run (Not Authenticated)
 
-If you haven't authenticated with GitHub CLI yet, the tool will prompt you:
+If you haven't authenticated with GitHub CLI yet, the tool will automatically start the authentication process:
 
 ```
-GitHub CLI is not authenticated.
+GitHub CLI is not authenticated. Starting authentication...
 
-Please run the following command to login:
+Starting GitHub CLI authentication...
 
-  gh auth login -h github.com -s repo,workflow,user,read:org,gist
+! First copy your one-time code: XXXX-XXXX
+Press Enter to open github.com in your browser...
+```
+
+The tool runs `gh auth login` automatically with the required scopes (`repo,workflow,user,read:org,gist`). Follow the browser-based authentication flow to complete login.
+
+If automatic authentication fails, you can run the command manually:
 
-After logging in, run gh-setup-git-identity again.
+```bash
+printf "y" | gh auth login -h github.com -s repo,workflow,user,read:org,gist --git-protocol https --web
 ```
 
 ### Successful Run
@@ -158,6 +166,16 @@ Check if GitHub CLI is authenticated.
 
 **Returns:** `Promise<boolean>`
 
+#### `runGhAuthLogin(options?)`
+
+Run `gh auth login` interactively with the required scopes.
+
+**Parameters:**
+- `options.verbose` - Enable verbose logging (default: `false`)
+- `options.logger` - Custom logger (default: `console`)
+
+**Returns:** `Promise<boolean>` - `true` if login was successful
+
 #### `getGitHubUserInfo(options?)`
 
 Get GitHub user information (username and primary email).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gh-setup-git-identity",
-  "version": "0.2.0",
+  "version": "0.3.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 } from './index.js';
+import { setupGitIdentity, isGhAuthenticated, runGhAuthLogin } from './index.js';
 
 // Parse command-line arguments with environment variable and .lenv support
 const config = makeConfig({
@@ -67,14 +67,22 @@ async function main() {
 
     if (!authenticated) {
       console.log('');
-      console.log('GitHub CLI is not authenticated.');
+      console.log('GitHub CLI is not authenticated. Starting authentication...');
       console.log('');
-      console.log('Please run the following command to login:');
-      console.log('');
-      console.log('  gh auth login -h github.com -s repo,workflow,user,read:org,gist');
+
+      // Automatically run gh auth login
+      const loginSuccess = await runGhAuthLogin({ verbose: config.verbose });
+
+      if (!loginSuccess) {
+        console.log('');
+        console.log('Authentication failed. Please try running manually:');
+        console.log('');
+        console.log('  printf "y" | gh auth login -h github.com -s repo,workflow,user,read:org,gist --git-protocol https --web');
+        console.log('');
+        process.exit(1);
+      }
+
       console.log('');
-      console.log('After logging in, run gh-setup-git-identity again.');
-      process.exit(1);
     }
 
     // Prepare options

package/src/index.js

@@ -41,11 +41,12 @@ function createDefaultLogger(options = {}) {
  *
  * @param {string} command - The command to execute
  * @param {string[]} args - The command arguments
+ * @param {Object} options - Spawn options
  * @returns {Promise<{stdout: string, stderr: string, exitCode: number}>}
  */
-function execCommand(command, args = []) {
+function execCommand(command, args = [], options = {}) {
   return new Promise((resolve) => {
-    const child = spawn(command, args, { stdio: 'pipe', shell: false });
+    const child = spawn(command, args, { stdio: 'pipe', shell: false, ...options });
 
     let stdout = '';
     let stderr = '';
@@ -76,6 +77,78 @@ function execCommand(command, args = []) {
   });
 }
 
+/**
+ * Execute an interactive command (inheriting stdio)
+ *
+ * @param {string} command - The command to execute
+ * @param {string[]} args - The command arguments
+ * @param {Object} options - Options
+ * @param {string} options.input - Optional input to pipe to stdin
+ * @returns {Promise<{exitCode: number}>}
+ */
+function execInteractiveCommand(command, args = [], options = {}) {
+  return new Promise((resolve) => {
+    const { input } = options;
+    const child = spawn(command, args, {
+      stdio: input ? ['pipe', 'inherit', 'inherit'] : 'inherit',
+      shell: false
+    });
+
+    if (input && child.stdin) {
+      child.stdin.write(input);
+      child.stdin.end();
+    }
+
+    child.on('close', (exitCode) => {
+      resolve({
+        exitCode: exitCode || 0
+      });
+    });
+
+    child.on('error', (error) => {
+      console.error(`Failed to execute command: ${error.message}`);
+      resolve({
+        exitCode: 1
+      });
+    });
+  });
+}
+
+/**
+ * Run gh auth login interactively
+ *
+ * @param {Object} options - Options
+ * @param {boolean} options.verbose - Enable verbose logging
+ * @param {Object} options.logger - Custom logger
+ * @returns {Promise<boolean>} True if login was successful
+ */
+export async function runGhAuthLogin(options = {}) {
+  const { verbose = false, logger = console } = options;
+  const log = createDefaultLogger({ verbose, logger });
+
+  log(() => 'Starting GitHub CLI authentication...');
+  log(() => '');
+
+  // Run gh auth login with the required scopes
+  // Use 'y' as input to confirm default account selection
+  const result = await execInteractiveCommand('gh', [
+    'auth', 'login',
+    '-h', 'github.com',
+    '-s', 'repo,workflow,user,read:org,gist',
+    '--git-protocol', 'https',
+    '--web'
+  ], { input: 'y\n' });
+
+  if (result.exitCode !== 0) {
+    log.error(() => 'GitHub CLI authentication failed');
+    return false;
+  }
+
+  log(() => '');
+  log(() => 'GitHub CLI authentication successful!');
+  return true;
+}
+
 /**
  * Check if GitHub CLI is authenticated
  *
@@ -302,6 +375,7 @@ export async function verifyGitIdentity(options = {}) {
 
 export default {
   isGhAuthenticated,
+  runGhAuthLogin,
   getGitHubUsername,
   getGitHubEmail,
   getGitHubUserInfo,

package/test/index.test.js

@@ -5,6 +5,7 @@
 import { test, assert } from 'test-anywhere';
 import {
   isGhAuthenticated,
+  runGhAuthLogin,
   getGitHubUsername,
   getGitHubEmail,
   getGitHubUserInfo,
@@ -83,11 +84,17 @@ test('getGitHubUserInfo - returns user info when authenticated', async () => {
   assert.ok(info.email.includes('@'));
 });
 
+// Test: runGhAuthLogin function exists and is a function
+test('runGhAuthLogin - is exported as a function', async () => {
+  assert.equal(typeof runGhAuthLogin, 'function');
+});
+
 // Test: module exports
 test('module exports all expected functions', async () => {
   const module = await import('../src/index.js');
 
   assert.ok(typeof module.isGhAuthenticated === 'function');
+  assert.ok(typeof module.runGhAuthLogin === 'function');
   assert.ok(typeof module.getGitHubUsername === 'function');
   assert.ok(typeof module.getGitHubEmail === 'function');
   assert.ok(typeof module.getGitHubUserInfo === 'function');
@@ -104,6 +111,7 @@ test('default export contains all functions', async () => {
 
   assert.ok(typeof defaultExport === 'object');
   assert.ok(typeof defaultExport.isGhAuthenticated === 'function');
+  assert.ok(typeof defaultExport.runGhAuthLogin === 'function');
   assert.ok(typeof defaultExport.getGitHubUsername === 'function');
   assert.ok(typeof defaultExport.getGitHubEmail === 'function');
   assert.ok(typeof defaultExport.getGitHubUserInfo === 'function');