GitでのJSONファイルのセマンティックマージ

標準のgitツールによって実行されるマージ操作は、プログラムのソースコードを含むテキストファイルに適しています。 ただし、厳密に構造化されたデータ(特にJSON)を含むテキストファイルをマージすることは大きな頭痛の種です。



この問題を解決するには、JSONファイル用の別個のマージツールをgitに接続します。これは、行ごとには機能しませんが、JSONオブジェクトの構造を考慮します。



このためにJavaScriptスクリプトを使用することをお勧めします。このスクリプトは、マージされたJSONファイルを分析し、JSONオブジェクトの構造とネストに基づいてマージします。



それは何を与えますか?



たとえば、アプリケーション設定をJSONファイルに保持します。 同時に2人の開発者が新しいパラメーターをファイルの末尾に追加すると(それぞれ独自の名前が付けられます)、gitにマージすると競合が発生します。 セマンティックマージスクリプトは、2つの異なるパラメーターが追加されていることを把握し、結果ファイル内の両方のパラメーターを含め、競合なしに自動的にマージします。



また、同じプロパティセットを持つオブジェクトのリストがJSONに保存されている場合、セマンティックマージが保存されます。 そのようなリストの中央に新しいオブジェクトが追加され、プロパティ値が周囲のものと異なる場合、標準のgitマージ、および行ごとの比較ツールは混乱する可能性が高くなります。 テキストを注意深く見て、JSON構造を損なう危険性があるため、手動で競合を解決する必要があります。



JSONのオブジェクトの順序を変更する場合も同様です。



セマンティックマージの機能



ファイル内の名前付きオブジェクトの順序は無視されます。

名前のないオブジェクト(配列要素)の場合、行の順序が重要です。 配列の比較は、両方のファイルの配列要素の順序です。 配列の中央に要素を追加すると、この状況は認識されず、後続のすべての要素で競合が発生します。 マージされた両方のファイルで配列の最後に要素が追加された場合にも競合が発生します。



対立



競合が発生した場合(マージされた両方のバージョンのファイルで同じオブジェクトが変更された場合)、競合の本質を示す情報が結果のマージファイルに追加されます。

{ "CONFLICT": "<<<<<<<<>>>>>>>>", //        "OURS": ... // ""   "THEIRS": ... // ""   "ANCESTOR": ... //     "PATH": ... //       ,   }
      
      







スクリプトバージョン



Windowsアプリケーションを開発し、Windows用のgitを使用しているので、スクリプトを完成させて、「そのまま」Windowsで、つまりWindows Scripting Hostを介して動作するようにしました。 WSHはJSONをサポートしていないため、JSON解析ライブラリはスクリプトに直接含まれています。 node.jsを使用する準備ができている人のために、スクリプトのよりコンパクトなバージョンがあります。



Gitでマージドライバーを有効にする手順



1. jsonmerge.jsスクリプトをgit \ libフォルダー、たとえば%Program Files(x86)%\ Git \ lib \に配置します



2. gitで新しいmerge-driverを接続します。 これを行うには、git構成ファイルに変更を加えます。

1つのリポジトリに対してのみドライバーを有効にするには、ファイル<project folder> \。Git \ confgを変更します

または、すべてのローカルリポジトリに対してドライバーを有効にするには、ユーザー設定フォルダー(Windowsでは%userprofile%)にあるグローバル設定ファイル.gitconfigを変更します(例:C:\ Users \ <username> \)。



 [merge "json_merge"] name = A custom merge driver for json files driver = cscript //B //Nologo 'C:/Program Files (x86)/Git/lib/jsonmerge.js' %O %A %B recursive = binary
      
      





node.jsの場合、ドライバー行は次のようになります。

  driver = node 'C:/Program Files (x86)/Git/lib/jsonmerge.js' %O %A %B
      
      







jsonmerge.jsファイルへのパスを独自のものに変更することを忘れないでください。



3. .gitattributesファイルで、このドライバーを使用するファイル拡張子を示します。 効果を下位レベルのフォルダーに拡張するために、任意のプロジェクトフォルダーに配置できます。 通常、プロジェクトのルートフォルダにあります。



 *.json merge=json_merge
      
      







最初に、coffeescriptスクリプトはここから取得され 、純粋なjavacriptに転送され、標準のWindows Script Hostを介してWindowsで実行できるように改善されました。 エラー処理も追加されました。マージされたファイルのいずれかのJSON構造が正しくない場合、元のスクリプトは競合の兆候を返さず、gitはマージが成功したと見なします。 これは私のバージョンで修正されています。



サンプルソースデータと結果



たとえば、デバッグプロパティの競合する変更、および競合を引き起こさない2つの類似オブジェクトの追加。

共通の祖先
 { "widget": { "debug": "off", "window": { "title": "This is title", "name": "main_window", "width": 500, "height": 500 } } }
      
      









私たちのバージョン
 { "widget": { "debug": "on", "window": { "title": "This is title", "name": "main_window", "width": 500, "height": 500 }, "imageMoon": { "src": "Images/Moon.png", "name": "moon", "hOffset": 250, "vOffset": 250, "alignment": "center" } } }
      
      









彼らのバージョン
 { "widget": { "debug": "full", "window": { "title": "This is title", "name": "main_window", "width": 500, "height": 500 }, "imageSaturn": { "src": "Images/Saturn.png", "name": "saturn", "hOffset": 250, "vOffset": 250, "alignment": "center" } } }
      
      









結果をマージ
 { "widget": { "debug": { "CONFLICT": "<<<<<<<<>>>>>>>>", "OURS": "on", "THEIRS": "full", "ANCESTOR": "off", "PATH": "widget.debug" }, "window": { "title": "This is title", "name": "main_window", "width": 500, "height": 500 }, "imageMoon": { "src": "Images/Moon.png", "name": "moon", "hOffset": 250, "vOffset": 250, "alignment": "center" }, "imageSaturn": { "src": "Images/Saturn.png", "name": "saturn", "hOffset": 250, "vOffset": 250, "alignment": "center" } } }
      
      









実際、スクリプト自体



node.jsの下のJsonmerge.jsバージョン
 var ancestor, conflicts, fs, make_conflict_node, merge, ours, theirs; fs = require('fs'); try { ancestor = JSON.parse(fs.readFileSync(process.argv[2])); } catch(e) { console.log('Incorrect JSON in ancestor file '+process.argv[2]+ ' '+e.message); process.exit(1); } try { ours = JSON.parse(fs.readFileSync(process.argv[3])); } catch(e) { console.log('Incorrect JSON in ours file '+process.argv[3]+ ' '+e.message); process.exit(1); } try { theirs = JSON.parse(fs.readFileSync(process.argv[4])); } catch(e) { console.log('Incorrect JSON in theirs file '+process.argv[4]+ ' '+e.message); process.exit(1); } conflicts = false; make_conflict_node = function(ancestor_value, our_value, their_value, path) { var res; res = {}; res['CONFLICT'] = '<<<<<<<<>>>>>>>>'; res['OURS'] = our_value != null ? our_value : null; res['THEIRS'] = their_value != null ? their_value : null; res['ANCESTOR'] = ancestor_value != null ? ancestor_value : null; res['PATH'] = path.join('.'); return res; }; merge = function(ancestor_node, our_node, their_node, path) { var ancestor_value, key, keys, our_value, sub_path, their_value, _, _results; if (path == null) { path = []; } keys = {}; for (key in our_node) { _ = our_node[key]; keys[key] = true; } for (key in their_node) { _ = their_node[key]; keys[key] = true; } _results = []; for (key in keys) { _ = keys[key]; ancestor_value = ancestor_node != null ? ancestor_node[key] : void 0; our_value = our_node != null ? our_node[key] : void 0; their_value = their_node != null ? their_node[key] : void 0; sub_path = path.concat(key); if (our_value !== their_value) { if (JSON.stringify(their_value) === JSON.stringify(ancestor_value)) { continue; } else if (JSON.stringify(our_value) === JSON.stringify(ancestor_value)) { _results.push(our_node[key] = their_value); } else if (our_value && their_value && typeof our_value === 'object' && typeof their_value === 'object') { _results.push(merge(ancestor_value, our_value, their_value, sub_path)); } else { conflicts = true; _results.push(our_node[key] = make_conflict_node(ancestor_value, our_value, their_value, sub_path)); } } else { _results.push(void 0); } } return _results; }; merge(ancestor, ours, theirs); fs.writeFileSync(process.argv[3], JSON.stringify(ours, null, 4)); process.exit(conflicts ? 1 : 0);
      
      









WSH下のJsonmerge.jsバージョン
 /* json2.js 2014-02-04 Public Domain. NO WARRANTY EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK. See http://www.JSON.org/js.html This code should be minified before deployment. See http://javascript.crockford.com/jsmin.html USE YOUR OWN COPY. IT IS EXTREMELY UNWISE TO LOAD CODE FROM SERVERS YOU DO NOT CONTROL. This file creates a global JSON object containing two methods: stringify and parse. JSON.stringify(value, replacer, space) value any JavaScript value, usually an object or array. replacer an optional parameter that determines how object values are stringified for objects. It can be a function or an array of strings. space an optional parameter that specifies the indentation of nested structures. If it is omitted, the text will be packed without extra whitespace. If it is a number, it will specify the number of spaces to indent at each level. If it is a string (such as '\t' or ' '), it contains the characters used to indent at each level. This method produces a JSON text from a JavaScript value. When an object value is found, if the object contains a toJSON method, its toJSON method will be called and the result will be stringified. A toJSON method does not serialize: it returns the value represented by the name/value pair that should be serialized, or undefined if nothing should be serialized. The toJSON method will be passed the key associated with the value, and this will be bound to the value For example, this would serialize Dates as ISO strings. Date.prototype.toJSON = function (key) { function f(n) { // Format integers to have at least two digits. return n < 10 ? '0' + n : n; } return this.getUTCFullYear() + '-' + f(this.getUTCMonth() + 1) + '-' + f(this.getUTCDate()) + 'T' + f(this.getUTCHours()) + ':' + f(this.getUTCMinutes()) + ':' + f(this.getUTCSeconds()) + 'Z'; }; You can provide an optional replacer method. It will be passed the key and value of each member, with this bound to the containing object. The value that is returned from your method will be serialized. If your method returns undefined, then the member will be excluded from the serialization. If the replacer parameter is an array of strings, then it will be used to select the members to be serialized. It filters the results such that only members with keys listed in the replacer array are stringified. Values that do not have JSON representations, such as undefined or functions, will not be serialized. Such values in objects will be dropped; in arrays they will be replaced with null. You can use a replacer function to replace those with JSON values. JSON.stringify(undefined) returns undefined. The optional space parameter produces a stringification of the value that is filled with line breaks and indentation to make it easier to read. If the space parameter is a non-empty string, then that string will be used for indentation. If the space parameter is a number, then the indentation will be that many spaces. Example: text = JSON.stringify(['e', {pluribus: 'unum'}]); // text is '["e",{"pluribus":"unum"}]' text = JSON.stringify(['e', {pluribus: 'unum'}], null, '\t'); // text is '[\n\t"e",\n\t{\n\t\t"pluribus": "unum"\n\t}\n]' text = JSON.stringify([new Date()], function (key, value) { return this[key] instanceof Date ? 'Date(' + this[key] + ')' : value; }); // text is '["Date(---current time---)"]' JSON.parse(text, reviver) This method parses a JSON text to produce an object or array. It can throw a SyntaxError exception. The optional reviver parameter is a function that can filter and transform the results. It receives each of the keys and values, and its return value is used instead of the original value. If it returns what it received, then the structure is not modified. If it returns undefined then the member is deleted. Example: // Parse the text. Values that look like ISO date strings will // be converted to Date objects. myData = JSON.parse(text, function (key, value) { var a; if (typeof value === 'string') { a = /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)Z$/.exec(value); if (a) { return new Date(Date.UTC(+a[1], +a[2] - 1, +a[3], +a[4], +a[5], +a[6])); } } return value; }); myData = JSON.parse('["Date(09/09/2001)"]', function (key, value) { var d; if (typeof value === 'string' && value.slice(0, 5) === 'Date(' && value.slice(-1) === ')') { d = new Date(value.slice(5, -1)); if (d) { return d; } } return value; }); This is a reference implementation. You are free to copy, modify, or redistribute. */ /*jslint evil: true, regexp: true */ /*members "", "\b", "\t", "\n", "\f", "\r", "\"", JSON, "\\", apply, call, charCodeAt, getUTCDate, getUTCFullYear, getUTCHours, getUTCMinutes, getUTCMonth, getUTCSeconds, hasOwnProperty, join, lastIndex, length, parse, prototype, push, replace, slice, stringify, test, toJSON, toString, valueOf */ // Create a JSON object only if one does not already exist. We create the // methods in a closure to avoid creating global variables. if (typeof JSON !== 'object') { JSON = {}; } (function () { 'use strict'; function f(n) { // Format integers to have at least two digits. return n < 10 ? '0' + n : n; } if (typeof Date.prototype.toJSON !== 'function') { Date.prototype.toJSON = function () { return isFinite(this.valueOf()) ? this.getUTCFullYear() + '-' + f(this.getUTCMonth() + 1) + '-' + f(this.getUTCDate()) + 'T' + f(this.getUTCHours()) + ':' + f(this.getUTCMinutes()) + ':' + f(this.getUTCSeconds()) + 'Z' : null; }; String.prototype.toJSON = Number.prototype.toJSON = Boolean.prototype.toJSON = function () { return this.valueOf(); }; } var cx, escapable, gap, indent, meta, rep; function quote(string) { // If the string contains no control characters, no quote characters, and no // backslash characters, then we can safely slap some quotes around it. // Otherwise we must also replace the offending characters with safe escape // sequences. escapable.lastIndex = 0; return escapable.test(string) ? '"' + string.replace(escapable, function (a) { var c = meta[a]; return typeof c === 'string' ? c : '\\u' + ('0000' + a.charCodeAt(0).toString(16)).slice(-4); }) + '"' : '"' + string + '"'; } function str(key, holder) { // Produce a string from holder[key]. var i, // The loop counter. k, // The member key. v, // The member value. length, mind = gap, partial, value = holder[key]; // If the value has a toJSON method, call it to obtain a replacement value. if (value && typeof value === 'object' && typeof value.toJSON === 'function') { value = value.toJSON(key); } // If we were called with a replacer function, then call the replacer to // obtain a replacement value. if (typeof rep === 'function') { value = rep.call(holder, key, value); } // What happens next depends on the value's type. switch (typeof value) { case 'string': return quote(value); case 'number': // JSON numbers must be finite. Encode non-finite numbers as null. return isFinite(value) ? String(value) : 'null'; case 'boolean': case 'null': // If the value is a boolean or null, convert it to a string. Note: // typeof null does not produce 'null'. The case is included here in // the remote chance that this gets fixed someday. return String(value); // If the type is 'object', we might be dealing with an object or an array or // null. case 'object': // Due to a specification blunder in ECMAScript, typeof null is 'object', // so watch out for that case. if (!value) { return 'null'; } // Make an array to hold the partial results of stringifying this object value. gap += indent; partial = []; // Is the value an array? if (Object.prototype.toString.apply(value) === '[object Array]') { // The value is an array. Stringify every element. Use null as a placeholder // for non-JSON values. length = value.length; for (i = 0; i < length; i += 1) { partial[i] = str(i, value) || 'null'; } // Join all of the elements together, separated with commas, and wrap them in // brackets. v = partial.length === 0 ? '[]' : gap ? '[\n' + gap + partial.join(',\n' + gap) + '\n' + mind + ']' : '[' + partial.join(',') + ']'; gap = mind; return v; } // If the replacer is an array, use it to select the members to be stringified. if (rep && typeof rep === 'object') { length = rep.length; for (i = 0; i < length; i += 1) { if (typeof rep[i] === 'string') { k = rep[i]; v = str(k, value); if (v) { partial.push(quote(k) + (gap ? ': ' : ':') + v); } } } } else { // Otherwise, iterate through all of the keys in the object. for (k in value) { if (Object.prototype.hasOwnProperty.call(value, k)) { v = str(k, value); if (v) { partial.push(quote(k) + (gap ? ': ' : ':') + v); } } } } // Join all of the member texts together, separated with commas, // and wrap them in braces. v = partial.length === 0 ? '{}' : gap ? '{\n' + gap + partial.join(',\n' + gap) + '\n' + mind + '}' : '{' + partial.join(',') + '}'; gap = mind; return v; } } // If the JSON object does not yet have a stringify method, give it one. if (typeof JSON.stringify !== 'function') { escapable = /[\\\"\x00-\x1f\x7f-\x9f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g; meta = { // table of character substitutions '\b': '\\b', '\t': '\\t', '\n': '\\n', '\f': '\\f', '\r': '\\r', '"' : '\\"', '\\': '\\\\' }; JSON.stringify = function (value, replacer, space) { // The stringify method takes a value and an optional replacer, and an optional // space parameter, and returns a JSON text. The replacer can be a function // that can replace values, or an array of strings that will select the keys. // A default replacer method can be provided. Use of the space parameter can // produce text that is more easily readable. var i; gap = ''; indent = ''; // If the space parameter is a number, make an indent string containing that // many spaces. if (typeof space === 'number') { for (i = 0; i < space; i += 1) { indent += ' '; } // If the space parameter is a string, it will be used as the indent string. } else if (typeof space === 'string') { indent = space; } // If there is a replacer, it must be a function or an array. // Otherwise, throw an error. rep = replacer; if (replacer && typeof replacer !== 'function' && (typeof replacer !== 'object' || typeof replacer.length !== 'number')) { throw new Error('JSON.stringify'); } // Make a fake root object containing our value under the key of ''. // Return the result of stringifying the value. return str('', {'': value}); }; } // If the JSON object does not yet have a parse method, give it one. if (typeof JSON.parse !== 'function') { cx = /[\u0000\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g; JSON.parse = function (text, reviver) { // The parse method takes a text and an optional reviver function, and returns // a JavaScript value if the text is a valid JSON text. var j; function walk(holder, key) { // The walk method is used to recursively walk the resulting structure so // that modifications can be made. var k, v, value = holder[key]; if (value && typeof value === 'object') { for (k in value) { if (Object.prototype.hasOwnProperty.call(value, k)) { v = walk(value, k); if (v !== undefined) { value[k] = v; } else { delete value[k]; } } } } return reviver.call(holder, key, value); } // Parsing happens in four stages. In the first stage, we replace certain // Unicode characters with escape sequences. JavaScript handles many characters // incorrectly, either silently deleting them, or treating them as line endings. text = String(text); cx.lastIndex = 0; if (cx.test(text)) { text = text.replace(cx, function (a) { return '\\u' + ('0000' + a.charCodeAt(0).toString(16)).slice(-4); }); } // In the second stage, we run the text against regular expressions that look // for non-JSON patterns. We are especially concerned with '()' and 'new' // because they can cause invocation, and '=' because it can cause mutation. // But just to be safe, we want to reject all unexpected forms. // We split the second stage into 4 regexp operations in order to work around // crippling inefficiencies in IE's and Safari's regexp engines. First we // replace the JSON backslash pairs with '@' (a non-JSON character). Second, we // replace all simple value tokens with ']' characters. Third, we delete all // open brackets that follow a colon or comma or that begin the text. Finally, // we look to see that the remaining characters are only whitespace or ']' or // ',' or ':' or '{' or '}'. If that is so, then the text is safe for eval. if (/^[\],:{}\s]*$/ .test(text.replace(/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g, '@') .replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, ']') .replace(/(?:^|:|,)(?:\s*\[)+/g, ''))) { // In the third stage we use the eval function to compile the text into a // JavaScript structure. The '{' operator is subject to a syntactic ambiguity // in JavaScript: it can begin a block or an object literal. We wrap the text // in parens to eliminate the ambiguity. j = eval('(' + text + ')'); // In the optional fourth stage, we recursively walk the new structure, passing // each name/value pair to a reviver function for possible transformation. return typeof reviver === 'function' ? walk({'': j}, '') : j; } // If the text is not JSON parseable, then a SyntaxError is thrown. throw new SyntaxError('JSON.parse'); }; } }()); function readFile(fname){ var fso = new ActiveXObject("Scripting.FileSystemObject"); var ForReading = 1; //WScript.Echo(fname); var file = fso.GetFile(fname); var stream = file.OpenAsTextStream(ForReading,0); var text = stream.ReadAll(); //WScript.Echo(text); stream.close(); return text; } function writeFile(fname, text){ var fso = new ActiveXObject("Scripting.FileSystemObject"); var Overwrite = 1; //WScript.Echo(fname); var stream = fso.CreateTextFile(fname,Overwrite); //WScript.Echo(text); stream.Write(text); stream.close(); } var ancestor, conflicts, fs, make_conflict_node, merge, ours, theirs; //fs = require('fs'); fso = new ActiveXObject("Scripting.FileSystemObject"); var Args = WScript.Arguments; //ancestor = JSON.parse(fs.readFileSync(process.argv[2])); /* WScript.Echo(Args(0)); WScript.Echo(Args(1)); WScript.Echo(Args(2)); */ try { ancestor = JSON.parse(readFile(Args(0))); } catch(e) { WScript.Echo('Incorrect JSON in ancestor file '+Args(0)+ ' '+e.message); WScript.quit(1); } try { ours = JSON.parse(readFile(Args(1))); } catch(e) { WScript.Echo('Incorrect JSON in ours file '+Args(1)+ ' '+e.message); WScript.quit(1); } try { theirs = JSON.parse(readFile(Args(2))); } catch(e) { WScript.Echo('Incorrect JSON in theirs file '+Args(2)+ ' '+e.message); WScript.quit(1); } conflicts = false; make_conflict_node = function(ancestor_value, our_value, their_value, path) { var res; res = {}; res['CONFLICT'] = '<<<<<<<<>>>>>>>>'; res['OURS'] = our_value != null ? our_value : null; res['THEIRS'] = their_value != null ? their_value : null; res['ANCESTOR'] = ancestor_value != null ? ancestor_value : null; res['PATH'] = path.join('.'); return res; }; merge = function(ancestor_node, our_node, their_node, path) { var ancestor_value, key, keys, our_value, sub_path, their_value, _, _results; if (path == null) { path = []; } keys = {}; for (key in our_node) { _ = our_node[key]; keys[key] = true; } for (key in their_node) { _ = their_node[key]; keys[key] = true; } _results = []; for (key in keys) { _ = keys[key]; ancestor_value = ancestor_node != null ? ancestor_node[key] : void 0; our_value = our_node != null ? our_node[key] : void 0; their_value = their_node != null ? their_node[key] : void 0; sub_path = path.concat(key); if (our_value !== their_value) { if (JSON.stringify(their_value) === JSON.stringify(ancestor_value)) { continue; } else if (JSON.stringify(our_value) === JSON.stringify(ancestor_value)) { _results.push(our_node[key] = their_value); } else if (our_value && their_value && typeof our_value === 'object' && typeof their_value === 'object') { _results.push(merge(ancestor_value, our_value, their_value, sub_path)); } else { conflicts = true; _results.push(our_node[key] = make_conflict_node(ancestor_value, our_value, their_value, sub_path)); } } else { _results.push(void 0); } } return _results; }; merge(ancestor, ours, theirs); //fs.writeFileSync(process.argv[3], JSON.stringify(ours, null, 4)); writeFile(Args(1), JSON.stringify(ours, null, 4)); //process.exit(conflicts ? 1 : 0); WScript.quit(conflicts ? 1 : 0);
      
      








All Articles