glab-setup-git-identity 0.6.0

package/docs/case-studies/issue-7/effect-template-analysis.json

@@ -0,0 +1,178 @@
+{
+  "repository": "https://github.com/ProverCoderAI/effect-template",
+  "analysis_date": "2025-12-18",
+  "description": "Minimal Vite-powered TypeScript console starter using Effect",
+  "package_manager": "pnpm@10.24.0",
+  "configuration_files": {
+    "build_and_development": [
+      "vite.config.ts",
+      "vitest.config.ts",
+      "tsconfig.json"
+    ],
+    "code_quality": [
+      "biome.json",
+      "eslint.config.mts",
+      "linter.config.json",
+      ".jscpd.json"
+    ],
+    "environment": [
+      "flake.nix",
+      "package.json",
+      "pnpm-lock.yaml",
+      ".gitignore"
+    ],
+    "documentation": ["AGENTS.md"],
+    "editor_config": [".vscode/settings.json"],
+    "changesets": [".changeset/config.json"]
+  },
+  "github_workflows": {
+    "check.yml": {
+      "triggers": ["workflow_dispatch", "pull_request", "push to main"],
+      "jobs": ["build", "types", "lint", "test"],
+      "timeout": "10 minutes",
+      "concurrency": "cancel-in-progress"
+    },
+    "release.yml": {
+      "triggers": ["push to main"],
+      "purpose": "Automated versioning and npm publishing via Changesets",
+      "permissions": [
+        "contents: write",
+        "id-token: write",
+        "pull-requests: write"
+      ]
+    },
+    "snapshot.yml": {
+      "triggers": ["pull_request", "workflow_dispatch"],
+      "purpose": "Package snapshot creation for PRs"
+    }
+  },
+  "custom_github_actions": {
+    ".github/actions/setup/action.yml": {
+      "purpose": "Standard setup and dependency installation",
+      "steps": [
+        "pnpm installation",
+        "Node.js setup with caching",
+        "dependency installation"
+      ],
+      "default_node_version": "20.16.0"
+    }
+  },
+  "eslint_rules": {
+    "complexity_limits": {
+      "max_cyclomatic_complexity": 8,
+      "max_function_lines": 50,
+      "max_file_lines": 300,
+      "max_function_parameters": 5,
+      "max_nesting_depth": 4
+    },
+    "typescript_rules": {
+      "restrict_template_expressions": true,
+      "array_type": "generic",
+      "consistent_type_imports": true,
+      "unused_variables": "error"
+    },
+    "prohibited_patterns": {
+      "unknown_keyword": true,
+      "switch_statements": true,
+      "async_await": true,
+      "promise_constructor": true,
+      "commonjs_require": true,
+      "throw_string_literals": true
+    },
+    "formatting": {
+      "line_width": 120,
+      "quotes": "double",
+      "semicolons": "asi"
+    }
+  },
+  "typescript_config": {
+    "strict_options": {
+      "strict": true,
+      "alwaysStrict": true,
+      "noUnusedLocals": true,
+      "noUnusedParameters": true,
+      "noImplicitReturns": true,
+      "noFallthroughCasesInSwitch": true,
+      "exactOptionalPropertyTypes": true,
+      "noUncheckedIndexedAccess": true,
+      "noImplicitOverride": true,
+      "noPropertyAccessFromIndexSignature": true,
+      "allowUnusedLabels": false,
+      "allowUnreachableCode": false
+    },
+    "module_system": {
+      "target": "ES2022",
+      "module": "NodeNext",
+      "moduleResolution": "NodeNext"
+    },
+    "plugins": ["@effect/language-service"]
+  },
+  "vitest_config": {
+    "environment": "node",
+    "coverage_provider": "v8",
+    "coverage_thresholds": {
+      "core_modules": {
+        "branches": 100,
+        "functions": 100,
+        "lines": 100,
+        "statements": 100
+      },
+      "global_minimum": {
+        "branches": 10,
+        "functions": 10,
+        "lines": 10,
+        "statements": 10
+      }
+    },
+    "mock_management": {
+      "clearMocks": true,
+      "mockReset": true,
+      "restoreMocks": true
+    }
+  },
+  "jscpd_config": {
+    "threshold": 0,
+    "minTokens": 30,
+    "minLines": 5,
+    "skipComments": true,
+    "ignored_paths": [
+      "**/node_modules/**",
+      "**/build/**",
+      "**/dist/**",
+      "**/*.min.js",
+      "**/reports/**"
+    ]
+  },
+  "vscode_settings": {
+    "typescript_sdk": "node_modules/typescript/lib",
+    "import_preference": "relative",
+    "format_on_save": true,
+    "eslint_formatting": true,
+    "quick_suggestions": true,
+    "suggestion_delay": "10ms"
+  },
+  "nix_flake": {
+    "purpose": "Development environment",
+    "packages": ["corepack", "nodejs_22", "python3"]
+  },
+  "key_dependencies": {
+    "effect_ecosystem": [
+      "effect",
+      "@effect/cli",
+      "@effect/cluster",
+      "@effect/platform",
+      "@effect/schema",
+      "@effect/sql",
+      "@effect/workflow"
+    ],
+    "typescript_utilities": ["ts-morph", "ts-pattern"],
+    "testing": ["vitest", "@effect/vitest"],
+    "linting": [
+      "eslint",
+      "@biomejs/biome",
+      "typescript-eslint",
+      "eslint-plugin-sonarjs",
+      "eslint-plugin-unicorn"
+    ]
+  }
+}

package/eslint.config.js

@@ -0,0 +1,91 @@
+import js from '@eslint/js';
+import prettierConfig from 'eslint-config-prettier';
+import prettierPlugin from 'eslint-plugin-prettier';
+
+export default [
+  js.configs.recommended,
+  prettierConfig,
+  {
+    files: ['**/*.js', '**/*.mjs'],
+    plugins: {
+      prettier: prettierPlugin,
+    },
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        // Node.js globals
+        console: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+        // Node.js 18+ globals
+        fetch: 'readonly',
+        // Runtime-specific globals
+        Bun: 'readonly',
+        Deno: 'readonly',
+      },
+    },
+    rules: {
+      // Prettier integration
+      'prettier/prettier': 'error',
+
+      // Code quality rules
+      'no-unused-vars': 'error',
+      'no-console': 'off', // Allow console in this project
+      'no-debugger': 'error',
+
+      // Best practices
+      eqeqeq: ['error', 'always'],
+      curly: ['error', 'all'],
+      'no-var': 'error',
+      'prefer-const': 'error',
+      'prefer-arrow-callback': 'error',
+      'no-duplicate-imports': 'error',
+
+      // ES6+ features
+      'arrow-body-style': ['error', 'as-needed'],
+      'object-shorthand': ['error', 'always'],
+      'prefer-template': 'error',
+
+      // Async/await
+      'no-async-promise-executor': 'error',
+      'require-await': 'warn',
+
+      // Comments and documentation
+      'spaced-comment': ['error', 'always', { markers: ['/'] }],
+
+      // Complexity rules - reasonable thresholds for maintainability
+      complexity: ['warn', 15], // Cyclomatic complexity - allow more complex logic than strict 8
+      'max-depth': ['warn', 5], // Maximum nesting depth - slightly more lenient than strict 4
+      'max-lines-per-function': [
+        'warn',
+        {
+          max: 150, // More reasonable than strict 50 lines per function
+          skipBlankLines: true,
+          skipComments: true,
+        },
+      ],
+      'max-params': ['warn', 6], // Maximum function parameters - slightly more lenient than strict 5
+      'max-statements': ['warn', 60], // Maximum statements per function - reasonable limit for orchestration functions
+      'max-lines': ['error', 1500], // Maximum lines per file - counts all lines including blank lines and comments
+    },
+  },
+  {
+    // Test files have different requirements
+    files: ['tests/**/*.js', '**/*.test.js'],
+    rules: {
+      'require-await': 'off', // Async functions without await are common in tests
+    },
+  },
+  {
+    ignores: [
+      'node_modules/**',
+      'coverage/**',
+      'dist/**',
+      '*.min.js',
+      '.eslintcache',
+    ],
+  },
+];

package/examples/basic-usage.js

@@ -0,0 +1,64 @@
+/**
+ * Basic usage example for glab-setup-git-identity
+ * Demonstrates how to use the package
+ *
+ * Prerequisites:
+ * - GitLab CLI (glab) installed
+ * - Authenticated with GitLab via `glab auth login`
+ *
+ * Run with any runtime:
+ * - Bun: bun examples/basic-usage.js
+ * - Node.js: node examples/basic-usage.js
+ * - Deno: deno run --allow-run examples/basic-usage.js
+ */
+
+import {
+  defaultAuthOptions,
+  isGlabAuthenticated,
+  getGitLabUserInfo,
+  verifyGitIdentity,
+  setupGitIdentity,
+} from '../src/index.js';
+
+console.log('glab-setup-git-identity - Basic Usage Example\n');
+
+// Show default options
+console.log('Default auth options:');
+console.log(`  Hostname: ${defaultAuthOptions.hostname}`);
+console.log(`  Git protocol: ${defaultAuthOptions.gitProtocol}`);
+console.log(`  Use keyring: ${defaultAuthOptions.useKeyring}`);
+
+// Check current git identity
+console.log('\nCurrent git identity (global):');
+const currentIdentity = await verifyGitIdentity({ scope: 'global' });
+console.log(`  user.name: ${currentIdentity.username || '(not set)'}`);
+console.log(`  user.email: ${currentIdentity.email || '(not set)'}`);
+
+// Check if glab is authenticated
+console.log('\nChecking GitLab CLI authentication...');
+const authenticated = await isGlabAuthenticated();
+
+if (!authenticated) {
+  console.log('  GitLab CLI is not authenticated.');
+  console.log('  Please run: glab auth login');
+  console.log('\nExiting example.');
+  process.exit(0);
+}
+
+console.log('  GitLab CLI is authenticated!');
+
+// Get GitLab user info
+console.log('\nFetching GitLab user information...');
+try {
+  const { username, email } = await getGitLabUserInfo();
+  console.log(`  GitLab username: ${username}`);
+  console.log(`  GitLab email: ${email}`);
+
+  // Setup git identity (dry run)
+  console.log('\nDry run - would configure git as:');
+  await setupGitIdentity({ dryRun: true, verbose: false });
+} catch (error) {
+  console.error(`  Error: ${error.message}`);
+}
+
+console.log('\nExample completed!');

package/experiments/test-changeset-scripts.mjs

@@ -0,0 +1,303 @@
+#!/usr/bin/env bun
+
+/**
+ * Test suite for changeset-related scripts
+ * Tests validate-changeset.mjs and merge-changesets.mjs functionality
+ */
+
+import { execSync } from 'child_process';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+import {
+  mkdirSync,
+  writeFileSync,
+  rmSync,
+  existsSync,
+  readdirSync,
+  readFileSync,
+} from 'fs';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const projectRoot = join(__dirname, '..');
+const validateChangesetPath = join(
+  projectRoot,
+  'scripts',
+  'validate-changeset.mjs'
+);
+const mergeChangesetsPath = join(
+  projectRoot,
+  'scripts',
+  'merge-changesets.mjs'
+);
+
+let testsPassed = 0;
+let testsFailed = 0;
+
+function runTest(name, testFn) {
+  process.stdout.write(`Testing ${name}... `);
+  try {
+    testFn();
+    console.log('PASSED');
+    testsPassed++;
+  } catch (error) {
+    console.log(`FAILED: ${error.message}`);
+    testsFailed++;
+  }
+}
+
+function execCommand(command, options = {}) {
+  try {
+    return {
+      output: execSync(command, {
+        encoding: 'utf8',
+        stdio: 'pipe',
+        cwd: projectRoot,
+        ...options,
+      }),
+      exitCode: 0,
+    };
+  } catch (error) {
+    return {
+      output: (error.stdout || '') + (error.stderr || ''),
+      exitCode: error.status || 1,
+    };
+  }
+}
+
+// ==========================================
+// Tests for validate-changeset.mjs
+// ==========================================
+
+// Test 1: Script exists and is executable
+runTest('validate-changeset.mjs exists', () => {
+  if (!existsSync(validateChangesetPath)) {
+    throw new Error('validate-changeset.mjs not found');
+  }
+});
+
+// Test 2: Syntax check
+runTest('validate-changeset.mjs syntax check', () => {
+  const { output, exitCode } = execCommand(
+    `node --check ${validateChangesetPath}`
+  );
+  if (exitCode !== 0) {
+    throw new Error(`Syntax error: ${output}`);
+  }
+});
+
+// Test 3: Script runs without crashing (fallback mode)
+runTest('validate-changeset.mjs runs in fallback mode', () => {
+  // Without git diff context, it falls back to checking all changesets
+  const { output } = execCommand(`node ${validateChangesetPath}`);
+  // Should either pass (if there's exactly one changeset) or fail (if not)
+  // But should not crash with an exception
+  if (
+    output.includes('Error during changeset validation') &&
+    output.includes('Cannot read')
+  ) {
+    throw new Error('Script crashed unexpectedly');
+  }
+});
+
+// ==========================================
+// Tests for merge-changesets.mjs
+// ==========================================
+
+// Test 4: Script exists
+runTest('merge-changesets.mjs exists', () => {
+  if (!existsSync(mergeChangesetsPath)) {
+    throw new Error('merge-changesets.mjs not found');
+  }
+});
+
+// Test 5: Syntax check
+runTest('merge-changesets.mjs syntax check', () => {
+  const { output, exitCode } = execCommand(
+    `node --check ${mergeChangesetsPath}`
+  );
+  if (exitCode !== 0) {
+    throw new Error(`Syntax error: ${output}`);
+  }
+});
+
+// ==========================================
+// Unit tests using mock changeset directories
+// ==========================================
+
+const testDir = join(projectRoot, 'experiments', 'test-changesets-temp');
+const testChangesetDir = join(testDir, '.changeset');
+
+function setupTestEnvironment() {
+  // Clean up if exists
+  if (existsSync(testDir)) {
+    rmSync(testDir, { recursive: true });
+  }
+  mkdirSync(testChangesetDir, { recursive: true });
+
+  // Create README.md (should be ignored)
+  writeFileSync(join(testChangesetDir, 'README.md'), '# Changesets\n');
+
+  // Create config.json (should be ignored)
+  writeFileSync(join(testChangesetDir, 'config.json'), '{}');
+}
+
+function cleanupTestEnvironment() {
+  if (existsSync(testDir)) {
+    rmSync(testDir, { recursive: true });
+  }
+}
+
+function createChangeset(filename, type, description) {
+  const content = `---
+'my-package': ${type}
+---
+
+${description}
+`;
+  writeFileSync(join(testChangesetDir, filename), content);
+}
+
+// Test 6: Merge changesets correctly combines multiple changesets
+runTest('merge-changesets.mjs combines multiple changesets', () => {
+  setupTestEnvironment();
+  try {
+    // Create two changesets
+    createChangeset('first-change.md', 'patch', 'First change description');
+
+    // Wait a bit to ensure different mtime
+    execSync('sleep 0.1');
+
+    createChangeset('second-change.md', 'minor', 'Second change description');
+
+    // Run merge script in test directory
+    const { output, exitCode } = execCommand(`node ${mergeChangesetsPath}`, {
+      cwd: testDir,
+    });
+
+    if (exitCode !== 0) {
+      throw new Error(`Merge failed: ${output}`);
+    }
+
+    // Check that merged changeset was created
+    const files = readdirSync(testChangesetDir).filter(
+      (f) => f.endsWith('.md') && f !== 'README.md'
+    );
+    if (files.length !== 1) {
+      throw new Error(`Expected 1 merged changeset, found ${files.length}`);
+    }
+
+    // Check that it uses the higher bump type (minor)
+    if (!output.includes('Using highest: minor')) {
+      throw new Error('Expected merged changeset to use minor bump type');
+    }
+
+    // Check that both descriptions are included
+    const mergedContent = readFileSync(
+      join(testChangesetDir, files[0]),
+      'utf-8'
+    );
+    if (
+      !mergedContent.includes('First change description') ||
+      !mergedContent.includes('Second change description')
+    ) {
+      throw new Error('Merged changeset should contain both descriptions');
+    }
+  } finally {
+    cleanupTestEnvironment();
+  }
+});
+
+// Test 7: Merge changesets uses major if any is major
+runTest('merge-changesets.mjs uses highest bump type (major)', () => {
+  setupTestEnvironment();
+  try {
+    createChangeset('patch-change.md', 'patch', 'Patch change');
+    createChangeset('major-change.md', 'major', 'Major change');
+    createChangeset('minor-change.md', 'minor', 'Minor change');
+
+    const { output, exitCode } = execCommand(`node ${mergeChangesetsPath}`, {
+      cwd: testDir,
+    });
+
+    if (exitCode !== 0) {
+      throw new Error(`Merge failed: ${output}`);
+    }
+
+    if (!output.includes('Using highest: major')) {
+      throw new Error('Expected merged changeset to use major bump type');
+    }
+  } finally {
+    cleanupTestEnvironment();
+  }
+});
+
+// Test 8: Merge does nothing with single changeset
+runTest('merge-changesets.mjs skips with single changeset', () => {
+  setupTestEnvironment();
+  try {
+    createChangeset('only-change.md', 'patch', 'Only change');
+
+    const { output, exitCode } = execCommand(`node ${mergeChangesetsPath}`, {
+      cwd: testDir,
+    });
+
+    if (exitCode !== 0) {
+      throw new Error(`Script failed: ${output}`);
+    }
+
+    if (!output.includes('No merging needed')) {
+      throw new Error('Expected script to skip merging with single changeset');
+    }
+
+    // Verify original changeset still exists
+    const files = readdirSync(testChangesetDir).filter(
+      (f) => f.endsWith('.md') && f !== 'README.md'
+    );
+    if (files.length !== 1 || files[0] !== 'only-change.md') {
+      throw new Error('Original changeset should not be modified');
+    }
+  } finally {
+    cleanupTestEnvironment();
+  }
+});
+
+// Test 9: Merge does nothing with no changesets
+runTest('merge-changesets.mjs skips with no changesets', () => {
+  setupTestEnvironment();
+  try {
+    const { output, exitCode } = execCommand(`node ${mergeChangesetsPath}`, {
+      cwd: testDir,
+    });
+
+    if (exitCode !== 0) {
+      throw new Error(`Script failed: ${output}`);
+    }
+
+    if (!output.includes('No merging needed')) {
+      throw new Error('Expected script to skip merging with no changesets');
+    }
+  } finally {
+    cleanupTestEnvironment();
+  }
+});
+
+// Test 10: Validate changeset format checking
+runTest('validate-changeset.mjs format validation', () => {
+  // This test verifies the script can be imported and has expected functions
+  // Actual validation is tested through integration
+  const { exitCode } = execCommand(`node --check ${validateChangesetPath}`);
+  if (exitCode !== 0) {
+    throw new Error('Script has syntax errors');
+  }
+});
+
+// Summary
+console.log(`\n${'='.repeat(50)}`);
+console.log(`Test Results for changeset scripts:`);
+console.log(`  Passed: ${testsPassed}`);
+console.log(`  Failed: ${testsFailed}`);
+console.log('='.repeat(50));
+
+// Exit with appropriate code
+process.exit(testsFailed > 0 ? 1 : 0);