diff --git a/CHANGELOG.md b/CHANGELOG.md index d85c353b..625bc32a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 2.30.3 +### Bugfix +* fix prompt that return string or promise (in animation and set_prompt) [#724](https://github.com/jcubic/jquery.terminal/issues/724) + ## 2.30.2 ### Bugfix * fix animated exec array with sync commands [#722](https://github.com/jcubic/jquery.terminal/issues/722) diff --git a/README.md b/README.md index 363fad36..fbcda6e0 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ [![npm](https://img.shields.io/badge/npm-2.30.2-blue.svg)](https://www.npmjs.com/package/jquery.terminal) ![bower](https://img.shields.io/badge/bower-2.30.2-yellow.svg) [![Build and test](https://github.com/jcubic/jquery.terminal/actions/workflows/build.yaml/badge.svg?branch=master&event=push)](https://github.com/jcubic/jquery.terminal/actions/workflows/build.yaml) -[![Coverage Status](https://coveralls.io/repos/github/jcubic/jquery.terminal/badge.svg?branch=master&a3d8f5c3567979aca210315cafaca955)](https://coveralls.io/github/jcubic/jquery.terminal?branch=master) +[![Coverage Status](https://coveralls.io/repos/github/jcubic/jquery.terminal/badge.svg?branch=master&f89d5d7e8a915c7f958e2407b66acf15)](https://coveralls.io/github/jcubic/jquery.terminal?branch=master) ![downloads](https://img.shields.io/npm/dm/jquery.terminal.svg?style=flat) [![Paid Support](https://data.jsdelivr.com/v1/package/npm/jquery.terminal/badge?style=rounded)](https://www.jsdelivr.com/package/npm/jquery.terminal) [![](https://img.shields.io/badge/paid-support-354465.svg)](https://support.jcubic.pl/) diff --git a/__tests__/terminal.spec.js b/__tests__/terminal.spec.js index 17ee269d..dc49cc8a 100644 --- a/__tests__/terminal.spec.js +++ b/__tests__/terminal.spec.js @@ -2995,6 +2995,10 @@ describe('sub plugins', function() { describe('Terminal plugin', function() { describe('jQuery Terminal options', function() { describe('prompt', function() { + it('should have default prompt', function() { + var term = $('
').terminal($.noop); + expect(term.get_prompt()).toEqual('> '); + }); it('should set prompt', function() { var prompt = '>>> '; var term = $('
').terminal($.noop, { @@ -3002,9 +3006,30 @@ describe('Terminal plugin', function() { }); expect(term.get_prompt()).toEqual(prompt); }); - it('should have default prompt', function() { - var term = $('
').terminal($.noop); - expect(term.get_prompt()).toEqual('> '); + it('should render function that return string', () => { + var term = $('
').terminal($.noop, { + prompt: function() { + return '>>>' + } + }); + expect(term.find('.cmd-prompt').text()).toEqual('>>>'); + }); + it('should render funtion that return promise', async () => { + var term = $('
').terminal($.noop, { + prompt: function() { + return Promise.resolve('>>>'); + } + }); + await delay(10); + expect(term.find('.cmd-prompt').text()).toEqual('>>>'); + }); + it('should render funtion that call callback', () => { + var term = $('
').terminal($.noop, { + prompt: function(fn) { + fn('>>>'); + } + }); + expect(term.find('.cmd-prompt').text()).toEqual('>>>'); }); }); describe('history', function() { @@ -4971,7 +4996,8 @@ describe('Terminal plugin', function() { }); it('should animate exec array with sync commands #722', async function() { await term.exec(['echo HELLO', 'echo WORLD', 'echo !'], { - typing: 10 + typing: true, + delay: 0 }); expect(term.get_output().split('\n')).toEqual([ '> echo HELLO', @@ -4982,6 +5008,37 @@ describe('Terminal plugin', function() { '!' ]); }); + it('should handle exec animation when using prompt that return string #724', async () => { + var term = $('
').terminal({ + echo: function(arg) { + this.echo(arg); + } + }, { + greetings: false, + prompt: function() { + return '>>> ' + } + }); + async function test() { + await term.exec(['echo HELLO', 'echo WORLD', 'echo !'], { + typing: true, + delay: 0 + }); + expect(term.get_output().split('\n')).toEqual([ + '>>> echo HELLO', + 'HELLO', + '>>> echo WORLD', + 'WORLD', + '>>> echo !', + '!' + ]); + } + await test(); + term.clear().set_prompt(function() { + return Promise.resolve('>>> '); + }); + await test(); + }); }); describe('exec', function() { @@ -5733,6 +5790,34 @@ describe('Terminal plugin', function() { expect(last_line.text()).toEqual('Lorem'); }); }); + describe('set_prompt', function() { + var term; + beforeEach(() => { + term = $('
').terminal(); + }); + function get_prompt() { + return term.find('.cmd-prompt').text(); + } + it('should render prompt when using function that returns promise', async function() { + term.set_prompt(function() { + return Promise.resolve('>>>'); + }); + await delay(10); + expect(get_prompt()).toEqual('>>>'); + }); + it('should render prompt when using function that return string', function() { + term.set_prompt(function() { + return '>>>'; + }); + expect(get_prompt()).toEqual('>>>'); + }); + it('should render prompt when using function that use callback', function() { + term.set_prompt(function(fn) { + fn('>>>'); + }); + expect(get_prompt()).toEqual('>>>'); + }); + }); describe('echo', function() { var numChars = 100; var numRows = 25; diff --git a/js/jquery.terminal-2.30.2.js b/js/jquery.terminal-2.30.2.js index 2919d5f1..d6a01117 100644 --- a/js/jquery.terminal-2.30.2.js +++ b/js/jquery.terminal-2.30.2.js @@ -41,7 +41,7 @@ * * broken image by Sophia Bai from the Noun Project (CC-BY) * - * Date: Thu, 23 Dec 2021 14:52:26 +0000 + * Date: Thu, 23 Dec 2021 18:40:32 +0000 */ /* global define, Map */ /* eslint-disable */ @@ -1901,6 +1901,37 @@ this.clear(); }; // ------------------------------------------------------------------------- + // :: function that handle all cases of prompt and call the function set + // :: with a string + // ------------------------------------------------------------------------- + function with_prompt(prompt, set, context) { + function error(e) { + var prompt = $.terminal.escape_brackets('[ERR]> '); + set('[[;red;]' + prompt + ']'); + alert_exception('Prompt', e); + } + switch (typeof prompt) { + case 'string': + set(prompt); + break; + case 'function': + try { + var ret = prompt.call(context, function(string) { + set(string); + }); + if (typeof ret === 'string') { + set(ret); + } + if (ret && ret.then) { + ret.then(set).catch(error); + } + } catch(e) { + error(e); + } + break; + } + } + // ------------------------------------------------------------------------- // :: COMMAND LINE PLUGIN // ------------------------------------------------------------------------- var cmd_index = 0; @@ -3454,29 +3485,10 @@ // remove reference for garbage collector prev_prompt_data = null; } - switch (typeof prompt) { - case 'string': - set(prompt); - break; - case 'function': - var data = prev_prompt_data = { - set: set - }; - var ret = prompt.call(self, function(string) { - data.set(string); - }); - if (typeof ret === 'string') { - data.set(ret); - } - if (ret && ret.then) { - ret.then(data.set).catch(function(e) { - var prompt = $.terminal.escape_brackets('[ERR]> '); - data.set('[[;red;]' + prompt + ']'); - alert_exception('Prompt', e); - }); - } - break; - } + var data = prev_prompt_data = { + set: set + }; + with_prompt(prompt, set, self); }; })(); // --------------------------------------------------------------------- @@ -5116,7 +5128,7 @@ // ------------------------------------------------------------------------- $.terminal = { version: '2.30.2', - date: 'Thu, 23 Dec 2021 14:52:26 +0000', + date: 'Thu, 23 Dec 2021 18:40:32 +0000', // colors from https://www.w3.org/wiki/CSS/Properties/color/keywords color_names: [ 'transparent', 'currentcolor', 'black', 'silver', 'gray', 'white', @@ -8830,7 +8842,9 @@ var typed_enter = (function() { var helper = typed(function(message, prompt, options) { self.set_prompt(prompt); - self.echo(prompt + message, $.extend({}, options, {typing: false})); + with_prompt(prompt, function(prompt) { + self.echo(prompt + message, $.extend({}, options, {typing: false})); + }, self); }); return function(prompt, message, options) { return helper(message, $.extend({}, options, {prompt: prompt})); @@ -9787,7 +9801,7 @@ }); } else if (is_function(prompt)) { command_line.prompt(function(callback) { - prompt.call(self, callback, self); + return prompt.call(self, callback, self); }); } else { command_line.prompt(prompt); @@ -10312,14 +10326,9 @@ } else if (type === 'echo') { typed_message(string, settings); } else if (type === 'enter') { - var prompt = self.get_prompt(); - if (typeof prompt === 'function') { - prompt(function(prompt) { - typed_enter(prompt, string, settings); - }); - } else { + with_prompt(self.get_prompt(), function(prompt) { typed_enter(prompt, string, settings); - } + }, self); } } else { d.reject('Invalid type only `echo` and `prompt` are supported'); diff --git a/js/jquery.terminal-2.30.2.min.js b/js/jquery.terminal-2.30.2.min.js index 55d2e5bd..11aceea3 100644 --- a/js/jquery.terminal-2.30.2.min.js +++ b/js/jquery.terminal-2.30.2.min.js @@ -41,7 +41,7 @@ * * broken image by Sophia Bai from the Noun Project (CC-BY) * - * Date: Thu, 23 Dec 2021 14:52:26 +0000 + * Date: Thu, 23 Dec 2021 18:40:32 +0000 */ -(function(e){var D=function(){if(!D.cache.hasOwnProperty(arguments[0])){D.cache[arguments[0]]=D.parse(arguments[0])}return D.format.call(null,D.cache[arguments[0]],arguments)};D.format=function(e,t){var n=1,r=e.length,i="",u,a=[],o,s,l,f,c,p;for(o=0;o>>0;break;case"x":u=u.toString(16);break;case"X":u=u.toString(16).toUpperCase();break}u=/[def]/.test(l[8])&&l[3]&&u>=0?" +"+u:u;c=l[4]?l[4]==="0"?"0":l[4].charAt(1):" ";p=l[6]-String(u).length;f=l[6]?d(c,p):"";a.push(l[5]?u+f:f+u)}}return a.join("")};D.cache={};D.parse=function(e){var t=e,n=[],r=[],i=0;while(t){if((n=/^[^\x25]+/.exec(t))!==null){r.push(n[0])}else if((n=/^\x25{2}/.exec(t))!==null){r.push("%")}else if((n=/^\x25(?:([1-9]\d*)\$|\(([^\)]+)\))?(\+)?(0|'[^$])?(-)?(\d+)?(?:\.(\d+))?([b-fosuxX])/.exec(t))!==null){if(n[2]){i|=1;var u=[],a=n[2],o=[];if((o=/^([a-z_][a-z_\d]*)/i.exec(a))!==null){u.push(o[1]);while((a=a.slice(o[0].length))!==""){if((o=/^\.([a-z_][a-z_\d]*)/i.exec(a))!==null){u.push(o[1])}else if((o=/^\[(\d+)\]/.exec(a))!==null){u.push(o[1])}else{throw"[sprintf] huh?"}}}else{throw"[sprintf] huh?"}n[2]=u}else{i|=2}if(i===3){throw"[sprintf] mixing positional and named placeholders is not (yet) supported"}r.push(n)}else{throw"[sprintf] huh?"}t=t.slice(n[0].length)}return r};var t=function(e,t,n){n=t.slice(0);n.splice(0,0,e);return D.apply(null,n)};function m(e){return Object.prototype.toString.call(e).slice(8,-1).toLowerCase()}function d(e,t){for(var n=[];t>0;n[--t]=e){}return n.join("")}e.sprintf=D;e.vsprintf=t})(typeof global!=="undefined"?global:self||window);(function(r,i){var n;if(typeof window!=="undefined"){n=window}else if(typeof self!=="undefined"){n=self}else if(typeof global!=="undefined"){n=global}else{throw new Error("Unknow context")}if(typeof define==="function"&&define.amd){define(["jquery","wcwidth"],function(e,t){r(e,t,n);return e})}else if(typeof module==="object"&&module.exports){module.exports=function(e,t,n){if(t===i){if(typeof window!=="undefined"){t=require("jquery")}else{t=require("jquery")(e)}}if(n===i){n=require("wcwidth")}r(t,n,e);return t}}else{r(n.jQuery,n.wcwidth,n)}})(function($,wcwidth,root,undefined){"use strict";function debug(e){if(false){console.log(e)}}function DelayQueue(){var t=$.Callbacks();var n=false;this.resolve=function(){t.fire();n=true};this.add=function(e){if(n){e()}else{t.add(e)}}}$.omap=function(n,r){var i={};$.each(n,function(e,t){i[e]=r.call(n,e,t)});return i};$.fn.text_length=function(){return this.map(function(){return $(this).text().length}).get().reduce(function(e,t){return e+t},0)};var Clone={clone_object:function(e){var t={};if(typeof e==="object"){if($.isArray(e)){return this.clone_array(e)}else if(e===null){return e}else{for(var n in e){if($.isArray(e[n])){t[n]=this.clone_array(e[n])}else if(typeof e[n]==="object"){t[n]=this.clone_object(e[n])}else{t[n]=e[n]}}}}return t},clone_array:function(e){if(!is_function(Array.prototype.map)){throw new Error("Your browser don't support ES5 array map "+"use es5-shim")}return e.slice(0).map(function(e){if(typeof e==="object"){return this.clone_object(e)}else{return e}}.bind(this))}};var clone=function(e){return Clone.clone_object(e)};if("Map"in root&&!("clear"in Map.prototype)){Map.prototype.clear=function(){this.forEach(function(e,t,n){n.delete(t)})}}var localStorage;(function(){var e=function(){try{var e="test",t=window.localStorage;t.setItem(e,"1");t.removeItem(e);return true}catch(e){return false}};var t=function(){try{document.cookie.split(";");return true}catch(e){return false}};var n=e();function r(e,t){var n;if(typeof e==="string"&&typeof t==="string"){localStorage[e]=t;return true}else if(typeof e==="object"&&typeof t==="undefined"){for(n in e){if(e.hasOwnProperty(n)){localStorage[n]=e[n]}}return true}return false}function i(e,t){var n,r,i;n=new Date;n.setTime(n.getTime()+31536e6);r="; expires="+n.toGMTString();if(typeof e==="string"&&typeof t==="string"){document.cookie=e+"="+t+r+"; path=/";return true}else if(typeof e==="object"&&typeof t==="undefined"){for(i in e){if(e.hasOwnProperty(i)){document.cookie=i+"="+e[i]+r+"; path=/"}}return true}return false}function u(e){return localStorage[e]}function a(e){var t,n,r,i;t=e+"=";n=document.cookie.split(";");for(r=0;r=i||t<0||m&&n>=s}function y(){var e=$();if(_(e)){return b(e)}f=setTimeout(y,g(e))}function b(e){f=undefined;if(d&&a){return h(e)}a=o=undefined;return l}function C(){if(f!==undefined){clearTimeout(f)}p=0;a=c=o=f=undefined}function F(){return f===undefined?l:b($())}function w(){var e=$(),t=_(e);a=arguments;o=this;c=e;if(t){if(f===undefined){return v(c)}if(m){f=setTimeout(y,i);return h(c)}}if(f===undefined){f=setTimeout(y,i)}return l}w.cancel=C;w.flush=F;return w}}();var jQuery=$;(function(e){jQuery.fn.extend({everyTime:function(e,t,n,r,i){return this.each(function(){jQuery.timer.add(this,e,t,n,r,i)})},oneTime:function(e,t,n){return this.each(function(){jQuery.timer.add(this,e,t,n,1)})},stopTime:function(e,t){return this.each(function(){jQuery.timer.remove(this,e,t)})}});jQuery.extend({timer:{guid:1,global:{},regex:/^([0-9]+)\s*(.*s)?$/,powers:{ms:1,cs:10,ds:100,s:1e3,das:1e4,hs:1e5,ks:1e6},timeParse:function(e){if(e===undefined||e===null){return null}var t=this.regex.exec(jQuery.trim(e.toString()));if(t[2]){var n=parseInt(t[1],10);var r=this.powers[t[2]]||1;return n*r}else{return e}},add:function(e,t,n,r,i,u){var a=0;if(jQuery.isFunction(n)){if(!i){i=r}r=n;n=t}t=jQuery.timer.timeParse(t);if(typeof t!=="number"||isNaN(t)||t<=0){return}if(i&&i.constructor!==Number){u=!!i;i=0}i=i||0;u=u||false;if(!e.$timers){e.$timers={}}if(!e.$timers[n]){e.$timers[n]={}}r.$timerID=r.$timerID||this.guid++;var o=function(){if(u&&o.inProgress){return}o.inProgress=true;if(++a>i&&i!==0||r.call(e,a)===false){jQuery.timer.remove(e,n,r)}o.inProgress=false};o.$timerID=r.$timerID;if(!e.$timers[n][r.$timerID]){e.$timers[n][r.$timerID]=setInterval(o,t)}if(!this.global[n]){this.global[n]=[]}this.global[n].push(e)},remove:function(e,t,n){var r=e.$timers,i;if(r){if(!t){for(var u in r){if(r.hasOwnProperty(u)){this.remove(e,u,n)}}}else if(r[t]){if(n){if(n.$timerID){clearInterval(r[t][n.$timerID]);delete r[t][n.$timerID]}}else{for(var a in r[t]){if(r[t].hasOwnProperty(a)){clearInterval(r[t][a]);delete r[t][a]}}}for(i in r[t]){if(r[t].hasOwnProperty(i)){break}}if(!i){i=null;delete r[t]}}for(i in r){if(r.hasOwnProperty(i)){break}}if(!i){e.$timers=null}}}}});if(/(msie) ([\w.]+)/.exec(navigator.userAgent.toLowerCase())){e(window).one("unload",function(){var e=jQuery.timer.global;for(var t in e){if(e.hasOwnProperty(t)){var n=e[t],r=n.length;while(--r){jQuery.timer.remove(n[r],t)}}}})}})(jQuery);(function(f){if(!String.prototype.split.toString().match(/\[native/)){return}var c=String.prototype.split,p=/()??/.exec("")[1]===f,n;n=function(e,t,n){if(Object.prototype.toString.call(t)!=="[object RegExp]"){return c.call(e,t,n)}var r=[],i=(t.ignoreCase?"i":"")+(t.multiline?"m":"")+(t.extended?"x":"")+(t.sticky?"y":""),u=0,a,o,s,l;t=new RegExp(t.source,i+"g");e+="";if(!p){a=new RegExp("^"+t.source+"$(?!\\s)",i)}n=n===f?-1>>>0:n>>>0;while(o=t.exec(e)){s=o.index+o[0].length;if(s>u){r.push(e.slice(u,o.index));if(!p&&o.length>1){o[0].replace(a,function(){for(var e=1;e1&&o.index=n){break}}if(t.lastIndex===o.index){t.lastIndex++}}if(u===e.length){if(l||!t.test("")){r.push("")}}else{r.push(e.slice(u))}return r.length>n?r.slice(0,n):r};String.prototype.split=function(e,t){return n(this,e,t)};return n})();$.fn.caret=function(e){var t=this[0];var n=t.contentEditable==="true";if(arguments.length===0){if(window.getSelection){if(n){if(!this.is(":focus")){t.focus()}var r=window.getSelection().getRangeAt(0),i=r.cloneRange();i.selectNodeContents(t);i.setEnd(r.endContainer,r.endOffset);return i.toString().length}return t.selectionStart}if(document.selection){t.focus();if(n){var r=document.selection.createRange(),i=document.body.createTextRange();i.moveToElementText(t);i.setEndPoint("EndToEnd",r);return i.text.length}var e=0,u=t.createTextRange(),i=document.selection.createRange().duplicate(),a=i.getBookmark();u.moveToBookmark(a);while(u.moveStart("character",-1)!==0)e++;return e}return 0}if(e===-1)e=this[n?"text":"val"]().length;if(window.getSelection){if(n){if(!this.is(":focus")){t.focus()}var o=window.getSelection();o.collapse(o.focusNode,e)}else t.setSelectionRange(e,e)}else if(document.body.createTextRange){var u=document.body.createTextRange();u.moveToElementText(t);u.moveStart("character",e);u.collapse(true);u.select()}if(!n&&!this.is(":focus")){t.focus()}return e};function make_callback_plugin(e){var s=$.extend({init:$.noop,destroy:$.noop,name:"event"},e);return function(r,i){var u=arguments.length===0;var a=arguments[0]==="unbind";if(!u&&!a&&!is_function(r)){throw new Error("Invalid argument, it need to a function or string "+'"unbind" or no arguments.')}if(a){r=is_function(arguments[1])?arguments[1]:null}var o="callbacks_"+s.name;return this.each(function(){var t=$(this);var n;function e(e){n.fireWith(t,[e])}if(u||a){n=t.data(o);if(u){n&&n.fire()}else{if(r&&n){n.remove(r);if(!n.has()){n=null}}else{n=null}if(!n){t.removeData(o);s.destroy.call(this,e,i)}}}else if(t.data(o)){$(this).data(o).add(r)}else{n=$.Callbacks();n.add(r);t.data(o,n);s.init.call(this,e,i)}})}}$.fn.resizer=make_callback_plugin({name:"resize",init:function(e,t){var n=$.extend({prefix:""},t);var r=$(this);var i;var u=true;if(r.is("body")){$(window).on("resize.resizer",e)}else if(window.ResizeObserver){i=new ResizeObserver(function(){if(!u){e()}u=false});i.observe(this);r.data("observer",i)}else{var a=$("