Export Merge File Function from NodeGit

The NodeGit is Native Node bindings to Git,based on libgit2.

It's a great library, but not provides all APIs of libgit2.

I need to export the 3-Way-Merge algorithm from git_merge_file by myself.


  • First of all, clone a depository from my forked project.
git clone git@github.com:myname/nodegit.git
cd nodegit
npm i
  1. Edit the configuration file of Customize the generated code using.

generate/input/descriptor.json

{
  "types": {
    "merge": {
      "functions": {
        "git_merge_file": {
          // Remove `"ignore": true`, add config
          "args": {
            "out": {
              "isReturn": true, // As return value
              "shouldAlloc": true // Auto create
            },
            "opts": {
              "isOptional": true // Can be null
            }
          },
          "return": {
            "isErrorCode": true
          }
        }
      }
    },
    "merge_file_result": {
      "ignore": false // Can not be ignore
    }
  }
}
  1. Generate detail configuration JSON
npm run generateJson

output at:

generate/output/idefs.json

search "cFunctionName": "git_merge_file",, have got args and returns configuration.

  1. Build nodegit.node
npm run install

build/Release/nodegit.node

  1. Define a new JS function Merge.file for convert args.

lib/merge.js

var _file = Merge.file;

/**
 * Merge two files as they exist in the in-memory data structures, using
 * the given common ancestor as the baseline. (git_merge_file)
 *
 * @param {MergeFileInput} ancestor The contents of the ancestor file
 * @param {MergeFileInput} ours The contents of the file in "our" side
 * @param {MergeFileInput} theirs The contents of the file in "theirs" side
 * @param {MergeFileOptions} [options] The merge file options or `NULL` for defaults
 */
Merge.file = function(ancestor, ours, theirs, options) {
  ancestor = normalizeOptions(ancestor, NodeGit.MergeFileInput);
  ours = normalizeOptions(ours, NodeGit.MergeFileInput);
  theirs = normalizeOptions(theirs, NodeGit.MergeFileInput);
  options = normalizeOptions(options || {}, NodeGit.MergeFileOptions);
  return _file.call(this, ancestor, ours, theirs, options);
};
  1. Generate JS in dist/ with babel.
npm run prepublish
  1. Create test.

Create three Markdown files.

printf "a" > test/base.md
printf "a\nb" > test/ours.md
printf "a\nc" > test/theirs.md

Create test JS file.

test/mergefile.js

var NodeGit = require('..');
var path = require('path');
var fse = require('fs-extra');

const dir = '/mnt/d/workspace/nodegit/test';

async function newMergeFileInput(filePath) {
  const stat = await fse.stat(filePath);
  const content = await fse.readFile(filePath, 'utf-8');

  // Wrong: It will case Crash while without normalizeOptions in 'lib/merge.js'
  // const input = {
  //   ptr: content,
  //   size: content.length,
  //   mode: stat.mode,
  //   path: filePath,
  // }

  // Correct: Must create object from NodeGit class.
  const input = new NodeGit.MergeFileInput();
  input.ptr = content;
  input.size = stat.size; // UTF8 size! (not content.length)
  input.mode = stat.mode;
  input.path = filePath;

  return input;
}

function getFilePath(fileName) {
  return path.join(dir, fileName);
}

async function test() {
  // 3 files.
  const base = await newMergeFileInput(getFilePath('base.md'));
  const ours = await newMergeFileInput(getFilePath('ours.md'));
  const theirs = await newMergeFileInput(getFilePath('theirs.md'));

  console.log({ base, ours, theirs });

  // Call merge file function.
  const res = await NodeGit.Merge.file(base, ours, theirs, {
    version: 0,
    ancestorLabel: 'BASE',
    ourLabel: 'OUR',
    theirLabel: 'THEIR',
    favor: 0,
    flags: 0,
    markerSize: 10,
  });

  // Must cut UTF8 Buff with len, or be wrong.
  const ptr = Buffer.from(res.ptr(), 'utf-8').slice(0, res.len()).toString();

  // Must call function to get field.
  console.log('res:', {
    automergeable: res.automergeable(),
    path: res.path(),
    mode: res.mode(),
    ptr,
    len: res.len(),
  });
}

test();

Run.

node test/mergefile.js

Output.

{
  base: MergeFileInput {
    mode: 33279,
    path: '/mnt/d/workspace/nodegit/test/base.md',
    size: 1,
    ptr: 'a',
    version: 1
  },
  ours: MergeFileInput {
    mode: 33279,
    path: '/mnt/d/workspace/nodegit/test/ours.md',
    size: 3,
    ptr: 'a\nb',
    version: 1
  },
  theirs: MergeFileInput {
    mode: 33279,
    path: '/mnt/d/workspace/nodegit/test/theirs.md',
    size: 3,
    ptr: 'a\nc',
    version: 1
  }
}
res: {
  automergeable: 0,
  path: null,
  mode: 33279,
  ptr: 'a\n<<<<<<<<<< OUR\nb\n==========\nc\n>>>>>>>>>> THEIR\n',
  len: 49
}
  1. Publish

Change name and version in package.json for publish new version.

npm login
npm publish

Install it use yarn.

yarn add pj-nodegit@latest

IMPORTANT

If argument object don't create with NodeGit Class and without wrap normalizeOptions. The nodegit.node will be crash.

node: ../node_modules/nan/nan_object_wrap.h:32: static T* Nan::ObjectWrap::Unwrap(v8::Local<v8::Object>) [with T = GitMergeFileOptions]: Assertion `object->InternalFieldCount() > 0' failed.

Why?

It lacks embedder fields, by compare with object of correct function. The v8 object InternalFieldCount() only counts the embedder fields actually. What is it? I don't know, may be a special sign of v8 object. No mater how, create object with NodeGit Class will be correct. I found the solution according by function normalizeOptions in file lib/utils/normalize_options.js.

var NodeGit = require('../../');

function normalizeOptions(options, Ctor) {
  if (!options) {
    return null;
  }

  if (options instanceof Ctor) {
    return options;
  }

  var instance = new Ctor(); // here.

  Object.keys(options).forEach(function(key) {
    if (typeof options[key] !== 'undefined') {
      instance[key] = options[key];
    }
  });

  return instance;
}

NodeGit.Utils.normalizeOptions = normalizeOptions;
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,373评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,732评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,163评论 0 238
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,700评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,036评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,425评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,737评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,421评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,141评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,398评论 2 243
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,908评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,276评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,907评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,018评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,772评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,448评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,325评论 2 261

推荐阅读更多精彩内容