UMD for unix_formatting #418

jcubic · Aug 16, 2018 · 84b6081 · 84b6081
1 parent 9955b57
commit 84b6081
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 ### Features
 * linksNoFollow option (default false)
+* add UMD for utility files [#418](https://github.com/jcubic/jquery.terminal/issues/418)
 
 ### Bug Fixes
 * handling backspaces in unix formatting [#409](https://github.com/jcubic/jquery.terminal/issues/409)

diff --git a/js/jquery.terminal.d.ts b/js/jquery.terminal.d.ts
@@ -392,6 +392,7 @@ type TerminalOptions = {
     processRPCResponse?: null | JQueryTerminal.processRPCResponseFunction;
     completionEscape?: boolean;
     convertLinks?: boolean;
+    unixFormattingEscapeBrackets?: boolean; // provided by unix_formatting
     extra?: any;
     tabs?: number;
     historySize?: number;

diff --git a/js/unix_formatting.js b/js/unix_formatting.js
@@ -13,12 +13,43 @@
  * Released under the MIT license
  *
  */
-/* global jQuery */
-(function($) {
-    if (!$.terminal) {
-        throw new Error('$.terminal is not defined');
+/* global jQuery, define, global, require, module */
+(function(factory) {
+    var root = typeof window !== 'undefined' ? window : global;
+    if (typeof define === 'function' && define.amd) {
+        // AMD. Register as an anonymous module.
+        // istanbul ignore next
+        define(['jquery', 'jquery.terminal'], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        // Node/CommonJS
+        module.exports = function(root, jQuery) {
+            if (jQuery === undefined) {
+                // require('jQuery') returns a factory that requires window to
+                // build a jQuery instance, we normalize how we use modules
+                // that require this pattern but the window provided is a noop
+                // if it's defined (how jquery works)
+                if (typeof window !== 'undefined') {
+                    jQuery = require('jquery');
+                } else {
+                    jQuery = require('jquery')(root);
+                }
+            }
+            if (!jQuery.fn.terminal) {
+                if (typeof window !== 'undefined') {
+                    require('jquery.terminal');
+                } else {
+                    require('jquery.terminal')(jQuery);
+                }
+            }
+            factory(jQuery);
+            return jQuery;
+        };
+    } else {
+        // Browser
+        // istanbul ignore next
+        factory(root.jQuery);
     }
-
+})(function($) {
     $.terminal.defaults.unixFormattingEscapeBrackets = false;
     // we match characters and html entities because command line escape brackets
     // echo don't, when writing formatter always process html entitites so it work
@@ -515,4 +546,4 @@
 
     $.terminal.defaults.formatters.unshift($.terminal.overtyping);
     $.terminal.defaults.formatters.unshift($.terminal.from_ansi);
-})(jQuery);
+});