CODEWITHSUNDEEP
node.jsgit
user3438917
user3438917

Reputation: 497

Get current git branch with node.js

How can I get the current git branch with node.js without an external library? I need to be able to grab the current branch name to perform another function in my node file.

Update with partially working code

I'm able to get the branch name with this, but can't seem to log out a message if the stdout matches the given string.

const { exec } = require('child_process');
exec('git rev-parse --abbrev-ref HEAD', (err, stdout, stderr) => {
    if (stdout === 'name-of-branch') {
        console.log(this is the correct branch);
    }
});

Upvotes: 18

Views: 22768

Answers (4)

Rafael Mori
Rafael Mori

Reputation: 949

if, just if, you are indifferent in this strategy of your project, you can remove the external spaces from the string (trim method) and convert it to uppercase or lowercase (toUpperCase or toLowerCase methods) before or inside the conditional.. something like this:

 const stA = ' oOo  ';
 const stB = 'OOO';
 if(stA.trim().toUpperCase() === stB.trim().toUpperCase()) {
    return true;
 } else {
    return false;
 }

Or you can do what @jason-warner says

Upvotes: 0

jason-warner
jason-warner

Reputation: 111

Just adding to @Aayush Mall's answer as an ES6 module, so you can fetch the current branch wherever in your project and be used however you like.

import { exec } from 'child_process';

const getBranch = () => new Promise((resolve, reject) => {
    return exec('git rev-parse --abbrev-ref HEAD', (err, stdout, stderr) => {
        if (err)
            reject(`getBranch Error: ${err}`);
        else if (typeof stdout === 'string')
            resolve(stdout.trim());
    });
});

export { getBranch }


// --- --- Another File / Module --- ---

import { getBranch } from './moduleLocation.mjs'

const someAsyncFunction = async () => {
  console.log(await getBranch()); 
}

someAsyncFunction();

Upvotes: 7

Aayush Mall
Aayush Mall

Reputation: 1013

Please try this works

const { exec } = require('child_process');
exec('git rev-parse --abbrev-ref HEAD', (err, stdout, stderr) => {
    if (err) {
        // handle your error
    }

    if (typeof stdout === 'string' && (stdout.trim() === 'master')) {
      console.log(`The branch is master`);
      // Call your function here conditionally as per branch
    }
});

Receiving Output as

$: node test.js 
The branch is master

Upvotes: 28

Jakub S.
Jakub S.

Reputation: 628

This should do it:

const { exec } = require('child_process');
exec('git branch --show-current', (err, stdout, stderr) => {
    if (err) {
        // handle your error
    }
});

The stdout variable will contain your branch name. You need to have git installed for this to work.

Upvotes: 16

Related Questions