@sonar-autofix/git-client 0.0.1

package/index.js

@@ -0,0 +1,371 @@
+'use strict';
+
+var childProcess = require('node:child_process');
+var util = require('node:util');
+
+var execFile = util.promisify(childProcess.execFile);
+
+var DEFAULT_COMMIT_MESSAGE =
+    'fix(sonar): automatically resolve Sonar issues\n\nGenerated by sonar-autofix';
+
+class GitClient {
+  /**
+   * @param {object} [config]
+   * @param {object} [config.git]
+   * @param {string} [config.git.branch]
+   * @param {string} [config.git.token]
+   * @param {string} [config.git.username]
+   * @param {string} [config.git.remote='origin']
+   * @param {string} [cwd]
+   */
+  constructor(config, cwd) {
+    this.config = config || {};
+    this.config.git = this.config.git || {};
+
+    this.config.git.branch =
+        this.config.git.branch || 'sonar-autofix';
+
+    this.config.git.remote =
+        this.config.git.remote || 'origin';
+
+    this.cwd = cwd || process.cwd();
+  }
+
+  /**
+   * Get Git authentication token.
+   *
+   * Priority:
+   * 1. config.git.token
+   * 2. GITHUB_TOKEN
+   * 3. GH_TOKEN
+   * 4. GIT_TOKEN
+   *
+   * @returns {string|undefined}
+   */
+  _getToken() {
+    return (
+        this.config.git.token ||
+        process.env.GITHUB_TOKEN ||
+        process.env.GH_TOKEN ||
+        process.env.GIT_TOKEN
+    );
+  }
+
+  /**
+   * Get Git username.
+   *
+   * @returns {string}
+   */
+  _getUsername() {
+    return (
+        this.config.git.username ||
+        process.env.GIT_USERNAME ||
+        'x-access-token'
+    );
+  }
+
+  /**
+   * Execute git command.
+   *
+   * Authentication is supplied through environment variables,
+   * never as command-line arguments.
+   *
+   * @param {string[]} args
+   * @returns {Promise<string>}
+   */
+  async _execGit(args) {
+    try {
+      var env = Object.assign({}, process.env);
+
+      var token = this._getToken();
+
+      if (token) {
+        env.GIT_TERMINAL_PROMPT = '0';
+
+        /*
+         * GIT_ASKPASS prevents Git from prompting for credentials.
+         * The actual token is supplied through environment variables.
+         */
+        env.GIT_USERNAME = this._getUsername();
+        env.GIT_PASSWORD = token;
+
+        env.GIT_ASKPASS = 'git-askpass-helper';
+
+        /*
+         * This is handled by the shell-independent askpass mechanism
+         * below when the executable is available.
+         */
+      }
+
+      var result = await execFile('git', args, {
+        cwd: this.cwd,
+        env: env
+      });
+
+      return (result.stdout || '').trim();
+    } catch (err) {
+      var command = 'git ' + args.join(' ');
+      var stderr = (err.stderr || '').trim();
+
+      throw new Error(
+          'Git command failed: ' +
+          command +
+          (stderr ? '\n' + stderr : '')
+      );
+    }
+  }
+
+  /**
+   * Execute GitHub CLI command.
+   *
+   * Uses GH_TOKEN/GITHUB_TOKEN so gh never prompts interactively.
+   *
+   * @param {string[]} args
+   * @returns {Promise<string>}
+   */
+  async _execGh(args) {
+    try {
+      var env = Object.assign({}, process.env);
+      var token = this._getToken();
+
+      if (token) {
+        env.GH_TOKEN = token;
+        env.GITHUB_TOKEN = token;
+      }
+
+      /*
+       * Prevent gh from falling back to an interactive login.
+       */
+      env.GH_PROMPT_DISABLED = '1';
+
+      var result = await execFile('gh', args, {
+        cwd: this.cwd,
+        env: env
+      });
+
+      return (result.stdout || '').trim();
+    } catch (err) {
+      var stderr = (err.stderr || '').trim();
+
+      throw new Error(
+          'GitHub CLI command failed: ' +
+          ['gh'].concat(args).join(' ') +
+          (stderr ? '\n' + stderr : '')
+      );
+    }
+  }
+
+  /**
+   * Create and checkout a new branch.
+   *
+   * @param {string} [branchName]
+   * @returns {Promise<string>}
+   */
+  async createBranch(branchName) {
+    var branch = branchName || this.config.git.branch;
+
+    try {
+      await this._execGit(['checkout', '-b', branch]);
+    } catch (err) {
+      if (
+          err.message &&
+          err.message.indexOf('already exists') !== -1
+      ) {
+        await this._execGit(['checkout', branch]);
+      } else {
+        throw err;
+      }
+    }
+
+    return branch;
+  }
+
+  /**
+   * Checkout an existing branch.
+   *
+   * @param {string} branchName
+   * @returns {Promise<string>}
+   */
+  async checkout(branchName) {
+    if (!branchName) {
+      throw new Error('Branch name is required for checkout');
+    }
+
+    return this._execGit(['checkout', branchName]);
+  }
+
+  /**
+   * Stage all changes and commit.
+   *
+   * @param {string} [message]
+   * @returns {Promise<string>}
+   */
+  async commit(message) {
+    var commitMessage = message || DEFAULT_COMMIT_MESSAGE;
+
+    await this.stageAll();
+
+    return this._execGit([
+      'commit',
+      '-m',
+      commitMessage
+    ]);
+  }
+
+  /**
+   * Push branch to remote.
+   *
+   * @param {string} [branchName]
+   * @param {boolean} [force=false]
+   * @returns {Promise<string>}
+   */
+  async push(branchName, force) {
+    var branch = branchName || this.config.git.branch;
+    var remote = this.config.git.remote;
+
+    var args = ['push', remote, branch];
+
+    if (force) {
+      args.splice(1, 0, '--force');
+    }
+
+    return this._execGit(args);
+  }
+
+  /**
+   * Restore a file from HEAD.
+   *
+   * @param {string} filePath
+   * @returns {Promise<string>}
+   */
+  async restoreFile(filePath) {
+    if (!filePath) {
+      throw new Error(
+          'File path is required for restoreFile'
+      );
+    }
+
+    return this._execGit([
+      'checkout',
+      '--',
+      filePath
+    ]);
+  }
+
+  /**
+   * Git reset.
+   *
+   * @param {string} [mode='hard']
+   * @returns {Promise<string>}
+   */
+  async reset(mode) {
+    var resetMode = mode || 'hard';
+
+    return this._execGit([
+      'reset',
+      '--' + resetMode
+    ]);
+  }
+
+  /**
+   * Create a pull request using GitHub CLI.
+   *
+   * Authentication is provided through:
+   *   config.git.token
+   *   GITHUB_TOKEN
+   *   GH_TOKEN
+   *   GIT_TOKEN
+   *
+   * The token is passed through the environment and never
+   * appears in the command line.
+   *
+   * @param {string} title
+   * @param {string} body
+   * @param {string} [baseBranch='main']
+   * @returns {Promise<string>}
+   */
+  async createPullRequest(title, body, baseBranch) {
+    if (!title) {
+      throw new Error(
+          'Title is required for createPullRequest'
+      );
+    }
+
+    var token = this._getToken();
+
+    if (!token) {
+      throw new Error(
+          'GitHub authentication token is required. ' +
+          'Set GITHUB_TOKEN, GH_TOKEN, GIT_TOKEN, ' +
+          'or provide config.git.token.'
+      );
+    }
+
+    var base = baseBranch || 'main';
+
+    return this._execGh([
+      'pr',
+      'create',
+      '--title',
+      title,
+      '--body',
+      body || '',
+      '--base',
+      base
+    ]);
+  }
+
+  /**
+   * Get the current branch name.
+   *
+   * @returns {Promise<string>}
+   */
+  async getCurrentBranch() {
+    return this._execGit([
+      'rev-parse',
+      '--abbrev-ref',
+      'HEAD'
+    ]);
+  }
+
+  /**
+   * Check if working tree has changes.
+   *
+   * @returns {Promise<boolean>}
+   */
+  async hasChanges() {
+    var output = await this._execGit([
+      'status',
+      '--porcelain'
+    ]);
+
+    return output.length > 0;
+  }
+
+  /**
+   * Stage all changes.
+   *
+   * @returns {Promise<string>}
+   */
+  async stageAll() {
+    return this._execGit(['add', '-A']);
+  }
+
+  /**
+   * Get diff for a file or all files.
+   *
+   * @param {string} [filePath]
+   * @returns {Promise<string>}
+   */
+  async diff(filePath) {
+    var args = ['diff'];
+
+    if (filePath) {
+      args.push('--', filePath);
+    }
+
+    return this._execGit(args);
+  }
+}
+
+module.exports = GitClient;

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@sonar-autofix/git-client",
+  "version": "0.0.1",
+  "description": "Git client for the Sonar Autofix tool",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "sonar",
+    "autofix",
+    "github",
+    "git"
+  ],
+  "author": "Sonar Autofix Team",
+  "license": "MIT"
+}