chore(release): 5.2.0 [skip ci]

# [5.2.0](https://github.com/wickedest/Mergely/compare/v5.1.4...v5.2.0) (2024-06-09)

### Features

* Allows height to be not explicit height, e.g. 'inherit' or '100%' ([#196](https://github.com/wickedest/Mergely/issues/196)) ([b9e3641](b9e3641c85))

CHANGELOG.md

@@ -1,3 +1,31 @@
+# [5.2.0](https://github.com/wickedest/Mergely/compare/v5.1.4...v5.2.0) (2024-06-09)
+
+
+### Features
+
+* Allows height to be not explicit height, e.g. 'inherit' or '100%' ([#196](https://github.com/wickedest/Mergely/issues/196)) ([b9e3641](https://github.com/wickedest/Mergely/commit/b9e3641c852a8926db5efdf33e65a607d5f2df5e))
+
+## [5.1.4](https://github.com/wickedest/Mergely/compare/v5.1.3...v5.1.4) (2024-05-17)
+
+
+### Bug Fixes
+
+* removed accidental change that enabled code display modes (e.g. javascript, python, html) ([692d01f](https://github.com/wickedest/Mergely/commit/692d01f1653ae8f1163a2c6228f457549086b75d))
+
+## [5.1.3](https://github.com/wickedest/Mergely/compare/v5.1.2...v5.1.3) (2024-05-06)
+
+
+### Bug Fixes
+
+* **chore:** updated deps ([#195](https://github.com/wickedest/Mergely/issues/195)) ([c4c6e8a](https://github.com/wickedest/Mergely/commit/c4c6e8abd8f02762d5803774789673f76a95e932))
+
+## [5.1.2](https://github.com/wickedest/Mergely/compare/v5.1.1...v5.1.2) (2024-05-06)
+
+
+### Bug Fixes
+
+* trace only when debug enabled ([#194](https://github.com/wickedest/Mergely/issues/194)) ([60d18f8](https://github.com/wickedest/Mergely/commit/60d18f8d5c0df349b4806b2e8a6c0f79d9f8074e))
+
 ## [5.1.1](https://github.com/wickedest/Mergely/compare/v5.1.0...v5.1.1) (2024-03-11)
 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mergely",
-  "version": "5.1.1",
+  "version": "5.2.0",
   "description": "A javascript UI for diff/merge",
   "license": "(GPL-3.0 OR LGPL-3.0 OR MPL-1.1 OR SEE LICENSE IN LICENSE)",
   "author": {
@@ -57,7 +57,7 @@
     "karma-sourcemap-loader": "^0.4.0",
     "karma-webpack": "^5.0.0",
     "mocha": "^9.1.4",
-    "semantic-release": "^21.0.1",
+    "semantic-release": "^21.1.2",
     "simple-mock": "^0.8.0",
     "standard-version": "^9.3.2",
     "style-loader": "^3.3.1",

src/diff-view.js

@@ -2,11 +2,6 @@ const CodeMirror = require('codemirror');
 require('codemirror/addon/search/searchcursor.js');
 require('codemirror/addon/selection/mark-selection.js');
 require('codemirror/lib/codemirror.css');
-require('codemirror/mode/go/go.js');
-require('codemirror/mode/javascript/javascript.js');
-require('codemirror/mode/htmlmixed/htmlmixed.js');
-require('codemirror/mode/markdown/markdown.js');
-require('codemirror/mode/python/python.js');
 
 const dom = require('./dom.js');
 const VDoc = require('./vdoc');
@@ -58,9 +53,7 @@ CodeMirrorDiffView.prototype.unbind = function() {
 	if (this._unbound) {
 		return;
 	}
-	if (this.settings._debug) {
-		trace('api#unbind');
-	}
+	this.trace('api#unbind');
 	if (this._changedTimeout != null) {
 		clearTimeout(this._changedTimeout);
 	}
@@ -72,7 +65,6 @@ CodeMirrorDiffView.prototype.unbind = function() {
 		this.el.removeChild(this.el.lastChild);
 	}
 	if (this._origEl) {
-		this.el.style = this._origEl.style;
 		this.el.className = this._origEl.className;
 	}
 	this._unbound = true;
@@ -89,9 +81,7 @@ CodeMirrorDiffView.prototype.readOnly = function(side) {
 }
 
 CodeMirrorDiffView.prototype.lhs = function(text) {
-	if (this.settings._debug) {
-		trace('api#lhs', text && text.length);
-	}
+	this.trace('api#lhs', text && text.length);
 	// invalidate existing changes and current position
 	this.changes = [];
 	this._current_diff = -1;
@@ -100,33 +90,25 @@ CodeMirrorDiffView.prototype.lhs = function(text) {
 
 CodeMirrorDiffView.prototype.rhs = function(text) {
 	// invalidate existing changes and current position
-	if (this.settings._debug) {
-		trace('api#rhs', text && text.length);
-	}
+	this.trace('api#rhs', text && text.length);
 	this.changes = [];
 	this._current_diff = -1;
 	this.editor.rhs.setValue(text);
 };
 
 CodeMirrorDiffView.prototype.update = function() {
-	if (this.settings._debug) {
-		trace('api#update');
-	}
+	this.trace('api#update');
 	this.el.dispatchEvent(new Event('changed'));
 };
 
 CodeMirrorDiffView.prototype.unmarkup = function() {
-	if (this.settings._debug) {
-		trace('api#unmarkup');
-	}
+	this.trace('api#unmarkup');
 	this._clear();
 	this.el.dispatchEvent(new Event('updated'));
 };
 
 CodeMirrorDiffView.prototype.scrollToDiff = function(direction) {
-	if (this.settings._debug) {
-		trace('api#scrollToDiff', direction);
-	}
+	this.trace('api#scrollToDiff', direction);
 	if (!this.changes.length) return;
 	if (direction === 'next') {
 		if (this._current_diff === this.changes.length - 1
@@ -143,18 +125,14 @@ CodeMirrorDiffView.prototype.scrollToDiff = function(direction) {
 			this._current_diff = Math.max(--this._current_diff, 0);
 		}
 	}
-	if (this.settings._debug) {
-		trace('change', 'current-diff', this._current_diff);
-	}
+	this.trace('change', 'current-diff', this._current_diff);
 	// _current_diff changed, refresh the view
 	this._scroll_to_change(this.changes[this._current_diff]);
 	this.setChanges(this.changes);
 };
 
 CodeMirrorDiffView.prototype.mergeCurrentChange = function(side) {
-	if (this.settings._debug) {
-		trace('api#mergeCurrentChange', side);
-	}
+	this.trace('api#mergeCurrentChange', side);
 	if (!this.changes.length) return;
 	if (side == 'lhs' && !this.lhs_cmsettings.readOnly) {
 		this._merge_change(this.changes[this._current_diff], 'rhs', 'lhs');
@@ -165,9 +143,7 @@ CodeMirrorDiffView.prototype.mergeCurrentChange = function(side) {
 };
 
 CodeMirrorDiffView.prototype.scrollTo = function(side, num) {
-	if (this.settings._debug) {
-		trace('api#scrollTo', side, num);
-	}
+	this.trace('api#scrollTo', side, num);
 	const ed = this.editor[side];
 	ed.setCursor(num);
 	ed.centerOnCursor();
@@ -181,9 +157,7 @@ CodeMirrorDiffView.prototype.setOptions = function(opts) {
 		...this.settings,
 		...opts
 	};
-	if (this.settings._debug) {
-		trace('api#setOptions', opts);
-	}
+	this.trace('api#setOptions', opts);
 
 	// if options set after init
 	if (this.editor) {
@@ -216,9 +190,7 @@ CodeMirrorDiffView.prototype.setOptions = function(opts) {
 };
 
 CodeMirrorDiffView.prototype.get = function(side) {
-	if (this.settings._debug) {
-		trace('api#get', side);
-	}
+	this.trace('api#get', side);
 	const ed = this.editor[side];
 	const value = ed.getValue();
 	if (value === undefined) {
@@ -228,16 +200,12 @@ CodeMirrorDiffView.prototype.get = function(side) {
 };
 
 CodeMirrorDiffView.prototype.cm = function(side) {
-	if (this.settings._debug) {
-		trace('api#cm', 'side');
-	}
+	this.trace('api#cm', 'side');
 	return this.editor[side];
 };
 
 CodeMirrorDiffView.prototype.search = function(side, query, direction) {
-	if (this.settings._debug) {
-		trace('api#search', side, query, direction);
-	}
+	this.trace('api#search', side, query, direction);
 	const editor = this.editor[side];
 	if (!editor.getSearchCursor) {
 		throw new Error('install CodeMirror search addon');
@@ -264,9 +232,7 @@ CodeMirrorDiffView.prototype.search = function(side, query, direction) {
 };
 
 CodeMirrorDiffView.prototype.resize = function() {
-	if (this.settings._debug) {
-		trace('api#resize');
-	}
+	this.trace('api#resize');
 	const parent = this.el;
 	const contentHeight = parent.offsetHeight - 2;
 
@@ -289,19 +255,18 @@ CodeMirrorDiffView.prototype.resize = function() {
 };
 
 CodeMirrorDiffView.prototype.bind = function(container) {
-	if (this.settings._debug) {
-		trace('api#bind', container);
-	}
-	this._origEl = {
-		style: container.style,
-		className: container.className
-	};
+	this.trace('api#bind', container);
 	const el = dom.getMergelyContainer({ clazz: container.className });
 	const computedStyle = window.getComputedStyle(container);
-	if (!computedStyle.height || computedStyle.height === '0px') {
+	if (!el.style.height
+		&& (!computedStyle.height || computedStyle.height === '0px')
+	) {
 		throw new Error(
 			`The element "${container.id}" requires an explicit height`);
 	}
+	this._origEl = {
+		className: container.className
+	};
 	this.id = `${container.id}`;
 	this.lhsId = `${container.id}-lhs`;
 	this.rhsId = `${container.id}-rhs`;
@@ -413,9 +378,7 @@ CodeMirrorDiffView.prototype.bind = function(container) {
 		}
 	});
 	this.editor.rhs.on('beforeChange', (cm, ev) => {
-		if (this.settings._debug) {
-			trace('event#rhs-beforeChange', ev);
-		}
+		this.trace('event#rhs-beforeChange', ev);
 		if (ev.text.length > 1
 			|| ((ev.from.line - ev.to.line) && ev.origin === '+delete')) {
 			this._clear();
@@ -423,24 +386,16 @@ CodeMirrorDiffView.prototype.bind = function(container) {
 	});
 
 	this.editor.lhs.on('change', (instance, ev) => {
-		if (this.settings._debug) {
-			trace('event#lhs-change');
-		}
+		this.trace('event#lhs-change');
 		this._changing();
-		if (this.settings._debug) {
-			trace('event#lhs-change [emitted]');
-		}
+		this.trace('event#lhs-change [emitted]');
 	});
 	this.editor.lhs.on('scroll', () => {
 		if (this._skipscroll.lhs) {
-			if (this.settings._debug) {
-				trace('event#lhs-scroll (skipped)');
-			}
+			this.trace('event#lhs-scroll (skipped)');
 			return;
 		} else {
-			if (this.settings._debug) {
-				trace('event#lhs-scroll');
-			}
+			this.trace('event#lhs-scroll');
 		}
 		// firefox scroll-linked effect render issue
 		setTimeout(() => {
@@ -448,21 +403,15 @@ CodeMirrorDiffView.prototype.bind = function(container) {
 		}, 1);
 	});
 	this.editor.rhs.on('change', (instance, ev) => {
-		if (this.settings._debug) {
-			trace('event#rhs-change', ev);
-		}
+		this.trace('event#rhs-change', ev);
 		this._changing();
 	});
 	this.editor.rhs.on('scroll', () => {
 		if (this._skipscroll.rhs) {
-			if (this.settings._debug) {
-				trace('event#rhs-scroll (skipped)');
-			}
+			this.trace('event#rhs-scroll (skipped)');
 			return;
 		} else {
-			if (this.settings._debug) {
-				trace('event#rhs-scroll');
-			}
+			this.trace('event#rhs-scroll');
 		}
 		// firefox scroll-linked effect render issue
 		setTimeout(() => {
@@ -475,7 +424,7 @@ CodeMirrorDiffView.prototype.bind = function(container) {
 	const resize = () => {
 		if (this.settings._debug) {
 			traceTimeStart('event#resize');
-			trace('event#resize [start]');
+			this.trace('event#resize [start]');
 		}
 		this.resize();
 		if (this.settings._debug) {
@@ -532,16 +481,12 @@ CodeMirrorDiffView.prototype.bind = function(container) {
 	}
 
 	this.editor.lhs.on('gutterClick', (cm, n, gutterClass, ev) => {
-		if (this.settings._debug) {
-			trace('event#gutterClick', 'lhs', n, ev);
-		}
+		this.trace('event#gutterClick', 'lhs', n, ev);
 		gutterClicked.call(this, 'lhs', n, ev);
 	});
 
 	this.editor.rhs.on('gutterClick', (cm, n, gutterClass, ev) => {
-		if (this.settings._debug) {
-			trace('event#gutterClick', 'rhs', n, ev);
-		}
+		this.trace('event#gutterClick', 'rhs', n, ev);
 		gutterClicked.call(this, 'rhs', n, ev);
 	});
 
@@ -689,18 +634,14 @@ CodeMirrorDiffView.prototype._scrolling = function({ side }) {
 	const vp = this.editor[oside].getViewport();
 	let scroll = true;
 	if (last_change) {
-		if (this.settings._debug) {
-			trace('scroll#_scrolling', 'last change before midline', last_change);
-		}
+		this.trace('scroll#_scrolling', 'last change before midline', last_change);
 		if (midline.line >= vp.from && midline <= vp.to) {
 			scroll = false;
 		}
 	}
 	if (scroll || force_scroll) {
 		// scroll the other side
-		if (this.settings._debug) {
-			trace('scroll#_scrolling', 'other side', oside, 'pos:', top_to - top_adjust);
-		}
+		this.trace('scroll#_scrolling', 'other side', oside, 'pos:', top_to - top_adjust);
 
 		// disable linked scroll events for the opposite editor because this
 		// triggers the next one explicitly, and we don't want to link the
@@ -708,21 +649,21 @@ CodeMirrorDiffView.prototype._scrolling = function({ side }) {
 		// coming in 2s, so this will "link" scrolling the other editor to
 		// this editor until this editor stops scrolling and times out.
 		this._skipscroll[oside] = true;
-		trace('scroll#set oside skip set:', oside, this._skipscroll);
+		this.trace('scroll#set oside skip set:', oside, this._skipscroll);
 		if (this._linkedScrollTimeout[oside]) {
 			clearTimeout(this._linkedScrollTimeout[oside]);
-			trace('scroll#clearing timeout:', this._skipscroll);
+			this.trace('scroll#clearing timeout:', this._skipscroll);
 		}
 		this._linkedScrollTimeout[oside] = setTimeout(() => {
 			this._skipscroll[oside] = false;
-			trace('scroll#set oside skip unset:', oside, this._skipscroll);
+			this.trace('scroll#set oside skip unset:', oside, this._skipscroll);
 		}, 100);
 
 		const top = top_to - top_adjust;
 		// scroll the opposite editor
 		this.editor[oside].scrollTo(left_to, top);
-	} else if (this.settings._debug) {
-		trace('scroll#_scrolling', 'not scrolling other side');
+	} else {
+		this.trace('scroll#_scrolling', 'not scrolling other side');
 	}
 	this._renderChanges();
 
@@ -733,23 +674,19 @@ CodeMirrorDiffView.prototype._scrolling = function({ side }) {
 
 CodeMirrorDiffView.prototype._changing = function() {
 	if (!this.settings.autoupdate) {
-		if (this.settings._debug) {
-			trace('change#_changing autoupdate is disabled');
-		}
+		this.trace('change#_changing autoupdate is disabled');
 		return;
 	}
 	if (this.settings._debug) {
 		traceTimeStart('change#_changing');
-		trace('change#_changing [start]');
+		this.trace('change#_changing [start]');
 	}
 	const handleChange = () => {
 		this._changedTimeout = null;
 		this.el.dispatchEvent(new Event('changed'));
 	};
 	if (this.settings.change_timeout > 0) {
-		if (this.settings._debug) {
-			trace('change#setting timeout', this.settings.change_timeout)
-		}
+		this.trace('change#setting timeout', this.settings.change_timeout)
 		if (this._changedTimeout != null) {
 			clearTimeout(this._changedTimeout);
 		}
@@ -763,9 +700,7 @@ CodeMirrorDiffView.prototype._changing = function() {
 };
 
 CodeMirrorDiffView.prototype.setChanges = function(changes) {
-	if (this.settings._debug) {
-		trace('change#setChanges');
-	}
+	this.trace('change#setChanges');
 	this._clear();
 	// after clear, set the new changes
 	this.changes = changes;
@@ -775,7 +710,7 @@ CodeMirrorDiffView.prototype.setChanges = function(changes) {
 CodeMirrorDiffView.prototype._renderChanges = function() {
 	if (this.settings._debug) {
 		traceTimeStart('draw#_renderChanges');
-		trace('draw#_renderChanges [start]', this.changes.length, 'changes');
+		this.trace('draw#_renderChanges [start]', this.changes.length, 'changes');
 	}
 	this._clearCanvases();
 	this._calculateOffsets(this.changes);
@@ -818,6 +753,9 @@ CodeMirrorDiffView.prototype._set_top_offset = function (side) {
 	// this is the distance from the top of the screen to the top of the
 	// content of the first codemirror editor
 	const topnode = this._queryElement('.CodeMirror-measure');
+	if (!topnode.offsetParent) {
+		return false;
+	}
 	const top_offset = topnode.offsetParent.offsetTop + 4;
 
 	// restore editor's scroll position
@@ -1103,12 +1041,9 @@ CodeMirrorDiffView.prototype._renderDiff = function(changes) {
 	const ctx_lhs = mcanvas_lhs.getContext('2d');
 	const ctx_rhs = mcanvas_rhs.getContext('2d');
 
-	if (this.settings._debug
-		&& this.settings._debug) {
-		trace('draw#_renderDiff', 'visible page height', ex.visible_page_height);
-		trace('draw#_renderDiff', 'scroller-top lhs', ex.lhs_scroller.scrollTop);
-		trace('draw#_renderDiff', 'scroller-top rhs', ex.rhs_scroller.scrollTop);
-	}
+	this.trace('draw#_renderDiff', 'visible page height', ex.visible_page_height);
+	this.trace('draw#_renderDiff', 'scroller-top lhs', ex.lhs_scroller.scrollTop);
+	this.trace('draw#_renderDiff', 'scroller-top rhs', ex.rhs_scroller.scrollTop);
 
 	ex.lhs_margin.removeEventListener('click', this._handleLhsMarginClick);
 	ex.rhs_margin.removeEventListener('click', this._handleRhsMarginClick);
@@ -1133,17 +1068,16 @@ CodeMirrorDiffView.prototype._renderDiff = function(changes) {
 		const rhs_y_end = change['rhs-y-end'] - rhsScrollTop;
 
 		if (Number.isNaN(lhs_y_start)) {
-			trace('draw#_renderDiff', 'unexpected NaN',
-				change['lhs-y-start'], change['lhs-y-end']);
+			this.trace(
+				'draw#_renderDiff unexpected NaN',
+				change['lhs-y-start'], change['lhs-y-end']
+			);
 			continue;
 		}
 
 		// draw margin indicators
-		if (this.settings._debug
-			&& this.settings._debug) {
-			trace('draw#_renderDiff', 'draw1', 'marker',
-				lhs_y_start, lhs_y_end, rhs_y_start, rhs_y_end);
-		}
+		this.trace('draw#_renderDiff', 'draw1', 'marker',
+			lhs_y_start, lhs_y_end, rhs_y_start, rhs_y_end);
 
 		const mkr_lhs_y_start = change['lhs-y-start'] * lratio;
 		const mkr_lhs_y_end = Math.max(change['lhs-y-end'] * lratio, 5);
@@ -1272,4 +1206,10 @@ CodeMirrorDiffView.prototype._queryElement = function(selector) {
 	return this[cacheName];
 }
 
+CodeMirrorDiffView.prototype.trace = function(...args) {
+	if (this.settings._debug) {
+		console.log(...args);
+	}
+}
+
 module.exports = CodeMirrorDiffView;

src/mergely.js

@@ -46,7 +46,9 @@ class Mergely {
 		}
 
 		const computedStyle = window.getComputedStyle(element);
-		if (!computedStyle.height || computedStyle.height === '0px') {
+		if (!element.style.height
+			&& (!computedStyle.height || computedStyle.height === '0px')
+		) {
 			throw new Error(
 				`The element "${selector}" requires an explicit height`);
 		}

webpack.prod.js

@@ -15,6 +15,10 @@ module.exports = (mode) => {
 			...webpackDevConfig.output,
 			path: path.join(__dirname, 'lib'),
 			filename: './[name].js',
+			library: {
+				name: 'mergely',
+				type: 'umd',
+			}
 		},
 		optimization: {
 			minimize: true,