Mirror/betaflight-configurator
1
0
Fork 0
mirror of https://github.com/betaflight/betaflight-configurator.git synced 2025-07-15 12:25:15 +03:00
Code Issues Wiki Activity

Fix Sonar issues Cli and CliAutoComplete

Browse source
This commit is contained in:
Miguel Angel Mulero Martinez 2020-10-16 14:31:45 +02:00
parent f87c0f5461
commit a0f1cadb32
6 changed files with 206 additions and 169 deletions
Download patch file Download diff file Expand all files Collapse all files

1
package.json
View file

@ -98,6 +98,7 @@
"karma-mocha": "^1.3.0", "karma-mocha": "^1.3.0",
"karma-sinon": "^1.0.5", "karma-sinon": "^1.0.5",
"karma-sinon-chai": "^2.0.2", "karma-sinon-chai": "^2.0.2",
"karma-spec-reporter": "^0.0.32",
"karma-tfs-reporter": "^1.0.2", "karma-tfs-reporter": "^1.0.2",
"mocha": "^7.0.1", "mocha": "^7.0.1",
"nw-builder": "^3.5.7", "nw-builder": "^3.5.7",

204
src/js/CliAutoComplete.js
View file

@ -6,17 +6,17 @@
* Uses: https://github.com/yuku/jquery-textcomplete * Uses: https://github.com/yuku/jquery-textcomplete
* Check out the docs at https://github.com/yuku/jquery-textcomplete/tree/v1/doc * Check out the docs at https://github.com/yuku/jquery-textcomplete/tree/v1/doc
*/ */
var CliAutoComplete = { const CliAutoComplete = {
configEnabled: false, configEnabled: false,
builder: { state: 'reset', numFails: 0 }, builder: { state: 'reset', numFails: 0 },
}; };
CliAutoComplete.isEnabled = function() { CliAutoComplete.isEnabled = function() {
return this.isBuilding() || (this.configEnabled && FC.CONFIG.flightControllerIdentifier == "BTFL" && this.builder.state != 'fail'); return this.isBuilding() || (this.configEnabled && FC.CONFIG.flightControllerIdentifier === "BTFL" && this.builder.state !== 'fail');
}; };
CliAutoComplete.isBuilding = function() { CliAutoComplete.isBuilding = function() {
return this.builder.state != 'reset' && this.builder.state != 'done' && this.builder.state != 'fail'; return this.builder.state !== 'reset' && this.builder.state !== 'done' && this.builder.state !== 'fail';
}; };
CliAutoComplete.isOpen = function() { CliAutoComplete.isOpen = function() {
@ -27,7 +27,7 @@ CliAutoComplete.isOpen = function() {
* @param {boolean} force - Forces AutoComplete to be shown even if the matching strategy has less that minChars input * @param {boolean} force - Forces AutoComplete to be shown even if the matching strategy has less that minChars input
*/ */
CliAutoComplete.openLater = function(force) { CliAutoComplete.openLater = function(force) {
var self = this; const self = this;
setTimeout(function() { setTimeout(function() {
self.forceOpen = !!force; self.forceOpen = !!force;
self.$textarea.textcomplete('trigger'); self.$textarea.textcomplete('trigger');
@ -36,7 +36,7 @@ CliAutoComplete.openLater = function(force) {
}; };
CliAutoComplete.setEnabled = function(enable) { CliAutoComplete.setEnabled = function(enable) {
if (this.configEnabled != enable) { if (this.configEnabled !== enable) {
this.configEnabled = enable; this.configEnabled = enable;
if (CONFIGURATOR.cliActive && CONFIGURATOR.cliValid) { if (CONFIGURATOR.cliActive && CONFIGURATOR.cliValid) {
@ -67,12 +67,13 @@ CliAutoComplete.cleanup = function() {
}; };
CliAutoComplete._builderWatchdogTouch = function() { CliAutoComplete._builderWatchdogTouch = function() {
var self = this; const self = this;
this._builderWatchdogStop(); this._builderWatchdogStop();
GUI.timeout_add('autocomplete_builder_watchdog', function() { GUI.timeout_add('autocomplete_builder_watchdog', function() {
if (self.builder.numFails++) { if (self.builder.numFails) {
self.builder.numFails++;
self.builder.state = 'fail'; self.builder.state = 'fail';
self.writeToOutput('Failed!<br># '); self.writeToOutput('Failed!<br># ');
$(self).trigger('build:stop'); $(self).trigger('build:stop');
@ -89,7 +90,7 @@ CliAutoComplete._builderWatchdogStop = function() {
}; };
CliAutoComplete.builderStart = function() { CliAutoComplete.builderStart = function() {
if (this.builder.state == 'reset') { if (this.builder.state === 'reset') {
this.cache = { this.cache = {
commands: [], commands: [],
resources: [], resources: [],
@ -98,7 +99,7 @@ CliAutoComplete.builderStart = function() {
settingsAcceptedValues: {}, settingsAcceptedValues: {},
feature: [], feature: [],
beeper: ['ALL'], beeper: ['ALL'],
mixers: [] mixers: [],
}; };
this.builder.commandSequence = ['help', 'dump', 'get', 'mixer list']; this.builder.commandSequence = ['help', 'dump', 'get', 'mixer list'];
this.builder.currentSetting = null; this.builder.currentSetting = null;
@ -111,15 +112,14 @@ CliAutoComplete.builderStart = function() {
}; };
CliAutoComplete.builderParseLine = function(line) { CliAutoComplete.builderParseLine = function(line) {
var cache = this.cache; const cache = this.cache;
var builder = this.builder; const builder = this.builder;
var m;
this._builderWatchdogTouch(); this._builderWatchdogTouch();
if (line.indexOf(builder.sentinel) !== -1) { if (line.indexOf(builder.sentinel) !== -1) {
// got sentinel // got sentinel
var command = builder.commandSequence.shift(); const command = builder.commandSequence.shift();
if (command && this.configEnabled) { if (command && this.configEnabled) {
// next state // next state
@ -150,39 +150,49 @@ CliAutoComplete.builderParseLine = function(line) {
} else { } else {
switch (builder.state) { switch (builder.state) {
case 'parse-help': case 'parse-help':
if (m = line.match(/^(\w+)/)) { const matchHelp = line.match(/^(\w+)/);
cache.commands.push(m[1]); if (matchHelp) {
cache.commands.push(matchHelp[1]);
} }
break; break;
case 'parse-dump': case 'parse-dump':
if (m = line.match(/^resource\s+(\w+)/i)) { const matchDump = line.match(/^resource\s+(\w+)/i);
var r = m[1].toUpperCase(); // should alread be upper, but to be sure, since we depend on that later if (matchDump) {
const r = matchDump[1].toUpperCase(); // should alread be upper, but to be sure, since we depend on that later
cache.resourcesCount[r] = (cache.resourcesCount[r] || 0) + 1; cache.resourcesCount[r] = (cache.resourcesCount[r] || 0) + 1;
} else if (m = line.match(/^(feature|beeper)\s+-?(\w+)/i)) { } else {
cache[m[1].toLowerCase()].push(m[2]); const matchFeatBeep = line.match(/^(feature|beeper)\s+-?(\w+)/i);
if (matchFeatBeep) {
cache[matchFeatBeep[1].toLowerCase()].push(matchFeatBeep[2]);
}
} }
break; break;
case 'parse-get': case 'parse-get':
if (m = line.match(/^(\w+)\s*=/)) { const matchGet = line.match(/^(\w+)\s*=/);
if (matchGet) {
// setting name // setting name
cache.settings.push(m[1]); cache.settings.push(matchGet[1]);
builder.currentSetting = m[1].toLowerCase(); builder.currentSetting = matchGet[1].toLowerCase();
} else if (builder.currentSetting && (m = line.match(/^(.*): (.*)/))) { } else {
if (m[1].match(/values/i)) { const matchGetSettings = line.match(/^(.*): (.*)/);
// Allowed Values if (matchGetSettings !== null && builder.currentSetting) {
cache.settingsAcceptedValues[builder.currentSetting] = m[2].split(/\s*,\s*/).sort(); if (matchGetSettings[1].match(/values/i)) {
} else if (m[1].match(/range|length/i)){ // Allowed Values
// "Allowed range" or "Array length", store as string hint cache.settingsAcceptedValues[builder.currentSetting] = matchGetSettings[2].split(/\s*,\s*/).sort();
cache.settingsAcceptedValues[builder.currentSetting] = m[0]; } else if (matchGetSettings[1].match(/range|length/i)){
// "Allowed range" or "Array length", store as string hint
cache.settingsAcceptedValues[builder.currentSetting] = matchGetSettings[0];
}
} }
} }
break; break;
case 'parse-mixer list': case 'parse-mixer list':
if (m = line.match(/:(.+)/)) { const matchMixer = line.match(/:(.+)/);
cache.mixers = ['list'].concat(m[1].trim().split(/\s+/)); if (matchMixer) {
cache.mixers = ['list'].concat(matchMixer[1].trim().split(/\s+/));
} }
break; break;
} }
@ -193,29 +203,31 @@ CliAutoComplete.builderParseLine = function(line) {
* Initializes textcomplete with all the autocomplete strategies * Initializes textcomplete with all the autocomplete strategies
*/ */
CliAutoComplete._initTextcomplete = function() { CliAutoComplete._initTextcomplete = function() {
var sendOnEnter = false; let sendOnEnter = false;
var self = this; const self = this;
var $textarea = this.$textarea; const $textarea = this.$textarea;
var cache = self.cache; const cache = self.cache;
var savedMouseoverItemHandler = null; let savedMouseoverItemHandler = null;
// helper functions // helper functions
var highlighter = function(anywhere) { const highlighter = function(anywhere) {
return function(value, term) { return function(value, term) {
return term ? value.replace(new RegExp((anywhere?'':'^') + '('+term+')', 'gi'), '<b>$1</b>') : value; const anywherePrefix = anywhere ? '': '^';
const termValue = value.replace(new RegExp(`${anywherePrefix}(${term})`, 'gi'), '<b>$1</b>');
return term ? termValue : value;
}; };
}; };
var highlighterAnywhere = highlighter(true); const highlighterAnywhere = highlighter(true);
var highlighterPrefix = highlighter(false); const highlighterPrefix = highlighter(false);
var searcher = function(term, callback, array, minChars, matchPrefix) { const searcher = function(term, callback, array, minChars, matchPrefix) {
var res = []; const res = [];
if ((minChars !== false && term.length >= minChars) || self.forceOpen || self.isOpen()) { if ((minChars !== false && term.length >= minChars) || self.forceOpen || self.isOpen()) {
term = term.toLowerCase(); term = term.toLowerCase();
for (var i = 0; i < array.length; i++) { for (let i = 0; i < array.length; i++) {
var v = array[i].toLowerCase(); const v = array[i].toLowerCase();
if (matchPrefix && v.startsWith(term) || !matchPrefix && v.indexOf(term) !== -1) { if (matchPrefix && v.startsWith(term) || !matchPrefix && v.indexOf(term) !== -1) {
res.push(array[i]); res.push(array[i]);
} }
@ -224,24 +236,24 @@ CliAutoComplete._initTextcomplete = function() {
callback(res); callback(res);
if (self.forceOpen && res.length == 1) { if (self.forceOpen && res.length === 1) {
// hacky: if we came here because of Tab and there's only one match // hacky: if we came here because of Tab and there's only one match
// trigger Tab again, so that textcomplete should immediately select the only result // trigger Tab again, so that textcomplete should immediately select the only result
// instead of showing the menu // instead of showing the menu
$textarea.trigger($.Event('keydown', {keyCode:9})) $textarea.trigger($.Event('keydown', {keyCode:9}));
} }
}; };
var contexter = function(text) { const contexter = function(text) {
var val = $textarea.val(); const val = $textarea.val();
if (val.length == text.length || val[text.length].match(/\s/)) { if (val.length === text.length || val[text.length].match(/\s/)) {
return true; return true;
} }
return false; // do not show autocomplete if in the middle of a word return false; // do not show autocomplete if in the middle of a word
}; };
var basicReplacer = function(value) { const basicReplacer = function(value) {
return '$1' + value + ' '; return `$1${value} `;
}; };
// end helper functions // end helper functions
@ -255,18 +267,18 @@ CliAutoComplete._initTextcomplete = function() {
onKeydown: function(e) { onKeydown: function(e) {
// some strategies may set sendOnEnter only at the replace stage, thus we call with timeout // some strategies may set sendOnEnter only at the replace stage, thus we call with timeout
// since this handler [onKeydown] is triggered before replace() // since this handler [onKeydown] is triggered before replace()
if (e.which == 13) { if (e.which === 13) {
setTimeout(function() { setTimeout(function() {
if (sendOnEnter) { if (sendOnEnter) {
// fake "enter" to run the textarea's handler // fake "enter" to run the textarea's handler
$textarea.trigger($.Event('keypress', {which:13})) $textarea.trigger($.Event('keypress', {which:13}));
} }
}, 0); }, 0);
} }
} },
} }
) )
.on('textComplete:show', function(e) { .on('textComplete:show', function() {
/** /**
* The purpose of this code is to disable initially the `mouseover` menu item handler. * The purpose of this code is to disable initially the `mouseover` menu item handler.
* Normally, when the menu pops up, if the mouse cursor is in the same area, * Normally, when the menu pops up, if the mouse cursor is in the same area,
@ -299,12 +311,12 @@ CliAutoComplete._initTextcomplete = function() {
// textcomplete autocomplete strategies // textcomplete autocomplete strategies
// strategy builder helper // strategy builder helper
var strategy = function(s) { const strategy = function(s) {
return $.extend({ return $.extend({
template: highlighterAnywhere, template: highlighterAnywhere,
replace: basicReplacer, replace: basicReplacer,
context: contexter, context: contexter,
index: 2 index: 2,
}, s); }, s);
}; };
@ -329,7 +341,7 @@ CliAutoComplete._initTextcomplete = function() {
} }
callback(arr); callback(arr);
}, cache.settings, 3); }, cache.settings, 3);
} },
}), }),
strategy({ // "set" strategy({ // "set"
@ -337,7 +349,7 @@ CliAutoComplete._initTextcomplete = function() {
search: function(term, callback) { search: function(term, callback) {
sendOnEnter = false; sendOnEnter = false;
searcher(term, callback, cache.settings, 3); searcher(term, callback, cache.settings, 3);
} },
}), }),
strategy({ // "set =" strategy({ // "set ="
@ -349,24 +361,24 @@ CliAutoComplete._initTextcomplete = function() {
replace: function(value) { replace: function(value) {
self.openLater(); self.openLater();
return basicReplacer(value); return basicReplacer(value);
} },
}), }),
strategy({ // "set with value" strategy({ // "set with value"
match: /^(\s*set\s+(\w+))\s*=\s*(.*)$/i, match: /^(\s*set\s+(\w+))\s*=\s*(.*)$/i,
search: function(term, callback, match) { search: function(term, callback, match) {
var arr = []; const arr = [];
var settingName = match[2].toLowerCase(); const settingName = match[2].toLowerCase();
this.isSettingValueArray = false; this.isSettingValueArray = false;
this.value = match[3]; this.value = match[3];
sendOnEnter = !!term; sendOnEnter = !!term;
if (settingName in cache.settingsAcceptedValues) { if (settingName in cache.settingsAcceptedValues) {
var val = cache.settingsAcceptedValues[settingName]; const val = cache.settingsAcceptedValues[settingName];
if (Array.isArray(val)) { if (Array.isArray(val)) {
// setting uses lookup strings // setting uses lookup strings
this.isSettingValueArray = true this.isSettingValueArray = true;
sendOnEnter = true; sendOnEnter = true;
searcher(term, callback, val, 0); searcher(term, callback, val, 0);
return; return;
@ -389,14 +401,14 @@ CliAutoComplete._initTextcomplete = function() {
return '$1 = ' + value; // cosmetic - make sure we have spaces around the `=` return '$1 = ' + value; // cosmetic - make sure we have spaces around the `=`
}, },
index: 3, index: 3,
isSettingValueArray: false isSettingValueArray: false,
}), }),
strategy({ // "resource" strategy({ // "resource"
match: /^(\s*resource\s+)(\w*)$/i, match: /^(\s*resource\s+)(\w*)$/i,
search: function(term, callback, match) { search: function(term, callback) {
sendOnEnter = false; sendOnEnter = false;
var arr = cache.resources; let arr = cache.resources;
if (semver.gte(FC.CONFIG.flightControllerVersion, "4.0.0")) { if (semver.gte(FC.CONFIG.flightControllerVersion, "4.0.0")) {
arr = ['show'].concat(arr); arr = ['show'].concat(arr);
} else { } else {
@ -407,11 +419,11 @@ CliAutoComplete._initTextcomplete = function() {
replace: function(value) { replace: function(value) {
if (value in cache.resourcesCount) { if (value in cache.resourcesCount) {
self.openLater(); self.openLater();
} else if (value == 'list' || value == 'show') { } else if (value === 'list' || value === 'show') {
sendOnEnter = true; sendOnEnter = true;
} }
return basicReplacer(value); return basicReplacer(value);
} },
}), }),
strategy({ // "resource index" strategy({ // "resource index"
@ -419,29 +431,30 @@ CliAutoComplete._initTextcomplete = function() {
search: function(term, callback, match) { search: function(term, callback, match) {
sendOnEnter = false; sendOnEnter = false;
this.savedTerm = term; this.savedTerm = term;
callback(['&lt;1-' + cache.resourcesCount[match[2].toUpperCase()] + '&gt;']); callback([`&lt;1-${cache.resourcesCount[match[2].toUpperCase()]}&gt;`]);
}, },
replace: function(value) { replace: function() {
if (this.savedTerm) { if (this.savedTerm) {
self.openLater(); self.openLater();
return '$1$3 '; return '$1$3 ';
} }
return null;
}, },
context: function(text) { context: function(text) {
var m; const matchResource = text.match(/^\s*resource\s+(\w+)\s/i);
// use this strategy only for resources with more than one index // use this strategy only for resources with more than one index
if ((m = text.match(/^\s*resource\s+(\w+)\s/i)) && (cache.resourcesCount[m[1].toUpperCase()] || 0) > 1 ) { if (matchResource && (cache.resourcesCount[matchResource[1].toUpperCase()] || 0) > 1 ) {
return contexter(text); return contexter(text);
} }
return false; return false;
}, },
index: 3, index: 3,
savedTerm: null savedTerm: null,
}), }),
strategy({ // "resource pin" strategy({ // "resource pin"
match: /^(\s*resource\s+\w+\s+(\d*\s+)?)(\w*)$/i, match: /^(\s*resource\s+\w+\s+(\d*\s+)?)(\w*)$/i,
search: function(term, callback, match) { search: function(term, callback) {
sendOnEnter = !!term; sendOnEnter = !!term;
if (term) { if (term) {
if ('none'.startsWith(term)) { if ('none'.startsWith(term)) {
@ -454,78 +467,79 @@ CliAutoComplete._initTextcomplete = function() {
} }
}, },
template: function(value, term) { template: function(value, term) {
if (value == 'none') { if (value === 'none') {
return highlighterPrefix(value, term); return highlighterPrefix(value, term);
} }
return value; return value;
}, },
replace: function(value) { replace: function(value) {
if (value == 'none') { if (value === 'none') {
sendOnEnter = true; sendOnEnter = true;
return '$1none '; return '$1none ';
} }
return null;
}, },
context: function(text) { context: function(text) {
var m = text.match(/^\s*resource\s+(\w+)\s+(\d+\s)?/i); const m = text.match(/^\s*resource\s+(\w+)\s+(\d+\s)?/i);
if (m) { if (m) {
// show pin/none for resources having only one index (it's not needed at the commend line) // show pin/none for resources having only one index (it's not needed at the commend line)
// OR having more than one index and the index is supplied at the command line // OR having more than one index and the index is supplied at the command line
var count = cache.resourcesCount[m[1].toUpperCase()] || 0; const count = cache.resourcesCount[m[1].toUpperCase()] || 0;
if (count && (m[2] || count === 1)) { if (count && (m[2] || count === 1)) {
return contexter(text); return contexter(text);
} }
} }
return false; return false;
}, },
index: 3 index: 3,
}), }),
strategy({ // "feature" and "beeper" strategy({ // "feature" and "beeper"
match: /^(\s*(feature|beeper)\s+(-?))(\w*)$/i, match: /^(\s*(feature|beeper)\s+(-?))(\w*)$/i,
search: function(term, callback, match) { search: function(term, callback, match) {
sendOnEnter = !!term; sendOnEnter = !!term;
var arr = cache[match[2].toLowerCase()]; let arr = cache[match[2].toLowerCase()];
if (!match[3]) { if (!match[3]) {
arr = ['-', 'list'].concat(arr); arr = ['-', 'list'].concat(arr);
} }
searcher(term, callback, arr, 1); searcher(term, callback, arr, 1);
}, },
replace: function(value) { replace: function(value) {
if (value == '-') { if (value === '-') {
self.openLater(true); self.openLater(true);
return '$1-'; return '$1-';
} }
return basicReplacer(value); return basicReplacer(value);
}, },
index: 4 index: 4,
}), }),
strategy({ // "mixer" strategy({ // "mixer"
match: /^(\s*mixer\s+)(\w*)$/i, match: /^(\s*mixer\s+)(\w*)$/i,
search: function(term, callback, match) { search: function(term, callback) {
sendOnEnter = true; sendOnEnter = true;
searcher(term, callback, cache.mixers, 1); searcher(term, callback, cache.mixers, 1);
} },
}) }),
]); ]);
if (semver.gte(FC.CONFIG.flightControllerVersion, "4.0.0")) { if (semver.gte(FC.CONFIG.flightControllerVersion, "4.0.0")) {
$textarea.textcomplete('register', [ $textarea.textcomplete('register', [
strategy({ // "resource show all", from BF 4.0.0 onwards strategy({ // "resource show all", from BF 4.0.0 onwards
match: /^(\s*resource\s+show\s+)(\w*)$/i, match: /^(\s*resource\s+show\s+)(\w*)$/i,
search: function(term, callback, matches) { search: function(term, callback) {
sendOnEnter = true; sendOnEnter = true;
searcher(term, callback, ['all'], 1, true); searcher(term, callback, ['all'], 1, true);
}, },
template: highlighterPrefix template: highlighterPrefix,
}), }),
]); ]);
} }
// diff command // diff command
var diffArgs1 = ["master", "profile", "rates", "all"]; const diffArgs1 = ["master", "profile", "rates", "all"];
var diffArgs2 = []; const diffArgs2 = [];
if (semver.lt(FC.CONFIG.flightControllerVersion, "3.4.0")) { if (semver.lt(FC.CONFIG.flightControllerVersion, "3.4.0")) {
diffArgs2.push("showdefaults"); diffArgs2.push("showdefaults");
@ -544,20 +558,20 @@ CliAutoComplete._initTextcomplete = function() {
$textarea.textcomplete('register', [ $textarea.textcomplete('register', [
strategy({ // "diff arg1" strategy({ // "diff arg1"
match: /^(\s*diff\s+)(\w*)$/i, match: /^(\s*diff\s+)(\w*)$/i,
search: function(term, callback, match) { search: function(term, callback) {
sendOnEnter = true; sendOnEnter = true;
searcher(term, callback, diffArgs1, 1, true); searcher(term, callback, diffArgs1, 1, true);
}, },
template: highlighterPrefix template: highlighterPrefix,
}), }),
strategy({ // "diff arg1 arg2" strategy({ // "diff arg1 arg2"
match: /^(\s*diff\s+\w+\s+)(\w*)$/i, match: /^(\s*diff\s+\w+\s+)(\w*)$/i,
search: function(term, callback, match) { search: function(term, callback) {
sendOnEnter = true; sendOnEnter = true;
searcher(term, callback, diffArgs2, 1, true); searcher(term, callback, diffArgs2, 1, true);
}, },
template: highlighterPrefix template: highlighterPrefix,
}) }),
]); ]);
}; };

119
src/js/tabs/cli.js
View file

@ -7,6 +7,8 @@ TABS.cli = {
cliBuffer: "", cliBuffer: "",
GUI: { GUI: {
snippetPreviewWindow: null, snippetPreviewWindow: null,
copyButton: null,
windowWrapper: null,
}, },
}; };
@ -15,8 +17,8 @@ function removePromptHash(promptText) {
} }
function cliBufferCharsToDelete(command, buffer) { function cliBufferCharsToDelete(command, buffer) {
var commonChars = 0; let commonChars = 0;
for (var i = 0;i < buffer.length;i++) { for (let i = 0; i < buffer.length; i++) {
if (command[i] === buffer[i]) { if (command[i] === buffer[i]) {
commonChars++; commonChars++;
} else { } else {
@ -46,8 +48,9 @@ function getCliCommand(command, cliBuffer) {
function copyToClipboard(text) { function copyToClipboard(text) {
function onCopySuccessful() { function onCopySuccessful() {
analytics.sendEvent(analytics.EVENT_CATEGORIES.FLIGHT_CONTROLLER, 'CliCopyToClipboard', text.length); analytics.sendEvent(analytics.EVENT_CATEGORIES.FLIGHT_CONTROLLER, 'CliCopyToClipboard', text.length);
const button = $('.tab-cli .copy'); const button = self.GUI.copyButton;
const origText = button.text(); const origText = button.text();
const origWidth = button.css("width"); const origWidth = button.css("width");
button.text(i18n.getMessage("cliCopySuccessful")); button.text(i18n.getMessage("cliCopySuccessful"));
@ -72,25 +75,25 @@ function copyToClipboard(text) {
} }
TABS.cli.initialize = function (callback) { TABS.cli.initialize = function (callback) {
var self = this; const self = this;
if (GUI.active_tab != 'cli') { if (GUI.active_tab !== 'cli') {
GUI.active_tab = 'cli'; GUI.active_tab = 'cli';
} }
self.outputHistory = ""; self.outputHistory = "";
self.cliBuffer = ""; self.cliBuffer = "";
const enterKeyCode = 13; const enterKeyCode = 13;
function executeCommands(out_string) { function executeCommands(outString) {
self.history.add(out_string.trim()); self.history.add(outString.trim());
var outputArray = out_string.split("\n"); const outputArray = outString.split("\n");
Promise.reduce(outputArray, function(delay, line, index) { Promise.reduce(outputArray, function(delay, line, index) {
return new Promise(function (resolve) { return new Promise(function (resolve) {
GUI.timeout_add('CLI_send_slowly', function () { GUI.timeout_add('CLI_send_slowly', function () {
var processingDelay = self.lineDelayMs; let processingDelay = self.lineDelayMs;
line = line.trim(); line = line.trim();
if (line.toLowerCase().startsWith('profile')) { if (line.toLowerCase().startsWith('profile')) {
processingDelay = self.profileSwitchDelayMs; processingDelay = self.profileSwitchDelayMs;
@ -102,8 +105,8 @@ TABS.cli.initialize = function (callback) {
self.sendLine(line, function () { self.sendLine(line, function () {
resolve(processingDelay); resolve(processingDelay);
}); });
}, delay) }, delay);
}) });
}, 0); }, 0);
} }
@ -115,7 +118,10 @@ TABS.cli.initialize = function (callback) {
CONFIGURATOR.cliActive = true; CONFIGURATOR.cliActive = true;
var textarea = $('.tab-cli textarea[name="commands"]'); self.GUI.copyButton = $('.tab-cli .copy');
self.GUI.windowWrapper = $('.tab-cli .window .wrapper');
const textarea = $('.tab-cli textarea[name="commands"]');
CliAutoComplete.initialize(textarea, self.sendLine.bind(self), writeToOutput); CliAutoComplete.initialize(textarea, self.sendLine.bind(self), writeToOutput);
$(CliAutoComplete).on('build:start', function() { $(CliAutoComplete).on('build:start', function() {
@ -132,12 +138,12 @@ TABS.cli.initialize = function (callback) {
}); });
$('.tab-cli .save').click(function() { $('.tab-cli .save').click(function() {
var prefix = 'cli'; const prefix = 'cli';
var suffix = 'txt'; const suffix = 'txt';
var filename = generateFilename(prefix, suffix); const filename = generateFilename(prefix, suffix);
var accepts = [{ const accepts = [{
description: suffix.toUpperCase() + ' files', extensions: [suffix], description: suffix.toUpperCase() + ' files', extensions: [suffix],
}]; }];
@ -176,19 +182,19 @@ TABS.cli.initialize = function (callback) {
$('.tab-cli .clear').click(function() { $('.tab-cli .clear').click(function() {
self.outputHistory = ""; self.outputHistory = "";
$('.tab-cli .window .wrapper').empty(); self.GUI.windowWrapper.empty();
}); });
if (Clipboard.available) { if (Clipboard.available) {
$('.tab-cli .copy').click(function() { self.GUI.copyButton.click(function() {
copyToClipboard(self.outputHistory); copyToClipboard(self.outputHistory);
}); });
} else { } else {
$('.tab-cli .copy').hide(); self.GUI.copyButton.hide();
} }
$('.tab-cli .load').click(function() { $('.tab-cli .load').click(function() {
var accepts = [ const accepts = [
{ {
description: 'Config files', extensions: ["txt", "config"], description: 'Config files', extensions: ["txt", "config"],
}, },
@ -207,8 +213,8 @@ TABS.cli.initialize = function (callback) {
console.log('No file selected'); console.log('No file selected');
return; return;
} }
let previewArea = $("#snippetpreviewcontent textarea#preview"); const previewArea = $("#snippetpreviewcontent textarea#preview");
function executeSnippet(fileName) { function executeSnippet(fileName) {
const commands = previewArea.val(); const commands = previewArea.val();
@ -230,7 +236,7 @@ TABS.cli.initialize = function (callback) {
isolateScroll: false, isolateScroll: false,
title: i18n.getMessage("cliConfirmSnippetDialogTitle", { fileName: fileName }), title: i18n.getMessage("cliConfirmSnippetDialogTitle", { fileName: fileName }),
content: $('#snippetpreviewcontent'), content: $('#snippetpreviewcontent'),
onCreated: () => onCreated: () =>
$("#snippetpreviewcontent a.confirm").click(() => executeSnippet(fileName)) $("#snippetpreviewcontent a.confirm").click(() => executeSnippet(fileName))
, ,
}); });
@ -240,8 +246,8 @@ TABS.cli.initialize = function (callback) {
} }
entry.file((file) => { entry.file((file) => {
let reader = new FileReader(); const reader = new FileReader();
reader.onload = reader.onload =
() => previewCommands(reader.result, file.name); () => previewCommands(reader.result, file.name);
reader.onerror = () => console.error(reader.error); reader.onerror = () => console.error(reader.error);
reader.readAsText(file); reader.readAsText(file);
@ -253,7 +259,7 @@ TABS.cli.initialize = function (callback) {
// `keypress`/`keyup` happens too late, as `textarea` will have already lost focus. // `keypress`/`keyup` happens too late, as `textarea` will have already lost focus.
textarea.keydown(function (event) { textarea.keydown(function (event) {
const tabKeyCode = 9; const tabKeyCode = 9;
if (event.which == tabKeyCode) { if (event.which === tabKeyCode) {
// prevent default tabbing behaviour // prevent default tabbing behaviour
event.preventDefault(); event.preventDefault();
@ -275,22 +281,22 @@ TABS.cli.initialize = function (callback) {
}); });
textarea.keypress(function (event) { textarea.keypress(function (event) {
if (event.which == enterKeyCode) { if (event.which === enterKeyCode) {
event.preventDefault(); // prevent the adding of new line event.preventDefault(); // prevent the adding of new line
if (CliAutoComplete.isBuilding()) { if (CliAutoComplete.isBuilding()) {
return; // silently ignore commands if autocomplete is still building return; // silently ignore commands if autocomplete is still building
} }
var out_string = textarea.val(); const outString = textarea.val();
executeCommands(out_string); executeCommands(outString);
textarea.val(''); textarea.val('');
} }
}); });
textarea.keyup(function (event) { textarea.keyup(function (event) {
var keyUp = {38: true}, const keyUp = {38: true};
keyDown = {40: true}; const keyDown = {40: true};
if (CliAutoComplete.isOpen()) { if (CliAutoComplete.isOpen()) {
return; // disable history keys if autocomplete is open return; // disable history keys if autocomplete is open
@ -310,8 +316,8 @@ TABS.cli.initialize = function (callback) {
GUI.timeout_add('enter_cli', function enter_cli() { GUI.timeout_add('enter_cli', function enter_cli() {
// Enter CLI mode // Enter CLI mode
var bufferOut = new ArrayBuffer(1); const bufferOut = new ArrayBuffer(1);
var bufView = new Uint8Array(bufferOut); const bufView = new Uint8Array(bufferOut);
bufView[0] = 0x23; // # bufView[0] = 0x23; // #
@ -335,7 +341,7 @@ TABS.cli.adaptPhones = function() {
TABS.cli.history = { TABS.cli.history = {
history: [], history: [],
index: 0 index: 0,
}; };
TABS.cli.history.add = function (str) { TABS.cli.history.add = function (str) {
@ -344,12 +350,16 @@ TABS.cli.history.add = function (str) {
}; };
TABS.cli.history.prev = function () { TABS.cli.history.prev = function () {
if (this.index > 0) this.index -= 1; if (this.index > 0) {
this.index -= 1;
}
return this.history[this.index]; return this.history[this.index];
}; };
TABS.cli.history.next = function () { TABS.cli.history.next = function () {
if (this.index < this.history.length) this.index += 1; if (this.index < this.history.length) {
this.index += 1;
}
return this.history[this.index - 1]; return this.history[this.index - 1];
}; };
@ -358,8 +368,9 @@ const lineFeedCode = 10;
const carriageReturnCode = 13; const carriageReturnCode = 13;
function writeToOutput(text) { function writeToOutput(text) {
$('.tab-cli .window .wrapper').append(text); const windowWrapper = TABS.cli.GUI.windowWrapper;
$('.tab-cli .window').scrollTop($('.tab-cli .window .wrapper').height()); windowWrapper.append(text);
$('.tab-cli .window').scrollTop(windowWrapper.height());
} }
function writeLineToOutput(text) { function writeLineToOutput(text) {
@ -369,7 +380,7 @@ function writeLineToOutput(text) {
} }
if (text.startsWith("###ERROR")) { if (text.startsWith("###ERROR")) {
writeToOutput('<span class="error_message">' + text + '</span><br>'); writeToOutput(`<span class="error_message">${text}</span><br>`);
} else { } else {
writeToOutput(text + "<br>"); writeToOutput(text + "<br>");
} }
@ -390,11 +401,11 @@ TABS.cli.read = function (readInfo) {
Windows understands (both) CRLF Windows understands (both) CRLF
Chrome OS currently unknown Chrome OS currently unknown
*/ */
var data = new Uint8Array(readInfo.data), const data = new Uint8Array(readInfo.data);
validateText = "", let validateText = "";
sequenceCharsToSkip = 0; let sequenceCharsToSkip = 0;
for (var i = 0; i < data.length; i++) { for (let i = 0; i < data.length; i++) {
const currentChar = String.fromCharCode(data[i]); const currentChar = String.fromCharCode(data[i]);
if (!CONFIGURATOR.cliValid) { if (!CONFIGURATOR.cliValid) {
@ -406,7 +417,7 @@ TABS.cli.read = function (readInfo) {
const escapeSequenceCode = 27; const escapeSequenceCode = 27;
const escapeSequenceCharLength = 3; const escapeSequenceCharLength = 3;
if (data[i] == escapeSequenceCode && !sequenceCharsToSkip) { // ESC + other if (data[i] === escapeSequenceCode && !sequenceCharsToSkip) { // ESC + other
sequenceCharsToSkip = escapeSequenceCharLength; sequenceCharsToSkip = escapeSequenceCharLength;
} }
@ -448,7 +459,7 @@ TABS.cli.read = function (readInfo) {
this.outputHistory += currentChar; this.outputHistory += currentChar;
} }
if (this.cliBuffer == 'Rebooting') { if (this.cliBuffer === 'Rebooting') {
CONFIGURATOR.cliActive = false; CONFIGURATOR.cliActive = false;
CONFIGURATOR.cliValid = false; CONFIGURATOR.cliValid = false;
GUI.log(i18n.getMessage('cliReboot')); GUI.log(i18n.getMessage('cliReboot'));
@ -464,7 +475,6 @@ TABS.cli.read = function (readInfo) {
// this is to match the content of the history with what the user sees on this tab // this is to match the content of the history with what the user sees on this tab
const lastLine = validateText.split("\n").pop(); const lastLine = validateText.split("\n").pop();
this.outputHistory = lastLine; this.outputHistory = lastLine;
validateText = "";
if (CliAutoComplete.isEnabled() && !CliAutoComplete.isBuilding()) { if (CliAutoComplete.isEnabled() && !CliAutoComplete.isBuilding()) {
// start building autoComplete // start building autoComplete
@ -472,9 +482,10 @@ TABS.cli.read = function (readInfo) {
} }
} }
if (!CliAutoComplete.isEnabled()) // fallback to native autocomplete
// fallback to native autocomplete if (!CliAutoComplete.isEnabled()) {
setPrompt(removePromptHash(this.cliBuffer)); setPrompt(removePromptHash(this.cliBuffer));
}
}; };
TABS.cli.sendLine = function (line, callback) { TABS.cli.sendLine = function (line, callback) {
@ -486,11 +497,11 @@ TABS.cli.sendNativeAutoComplete = function (line, callback) {
}; };
TABS.cli.send = function (line, callback) { TABS.cli.send = function (line, callback) {
var bufferOut = new ArrayBuffer(line.length); const bufferOut = new ArrayBuffer(line.length);
var bufView = new Uint8Array(bufferOut); const bufView = new Uint8Array(bufferOut);
for (var c_key = 0; c_key < line.length; c_key++) { for (let cKey = 0; cKey < line.length; cKey++) {
bufView[c_key] = line.charCodeAt(c_key); bufView[cKey] = line.charCodeAt(cKey);
} }
serial.send(bufferOut, callback); serial.send(bufferOut, callback);
@ -508,7 +519,7 @@ TABS.cli.cleanup = function (callback) {
return; return;
} }
this.send(getCliCommand('exit\r', this.cliBuffer), function (writeInfo) { this.send(getCliCommand('exit\r', this.cliBuffer), function () {
// we could handle this "nicely", but this will do for now // we could handle this "nicely", but this will do for now
// (another approach is however much more complicated): // (another approach is however much more complicated):
// we can setup an interval asking for data lets say every 200ms, when data arrives, callback will be triggered and tab switched // we can setup an interval asking for data lets say every 200ms, when data arrives, callback will be triggered and tab switched

8
test/karma.conf.js
View file

@ -1,6 +1,6 @@
module.exports = function(config) { module.exports = function(config) {
config.set({ config.set({
reporters: ['tfs'], reporters: ['tfs', 'spec'],
basePath: '../', basePath: '../',
frameworks: ['mocha', 'chai', 'sinon-chai'], frameworks: ['mocha', 'chai', 'sinon-chai'],
files: [ files: [
@ -15,14 +15,14 @@ module.exports = function(config) {
'./src/js/CliAutoComplete.js', './src/js/CliAutoComplete.js',
'./src/js/tabs/cli.js', './src/js/tabs/cli.js',
'./src/js/phones_ui.js', './src/js/phones_ui.js',
'./test/**/*.js' './test/**/*.js',
], ],
browsers: ['ChromeHeadlessNoSandbox'], browsers: ['ChromeHeadlessNoSandbox'],
customLaunchers: { customLaunchers: {
ChromeHeadlessNoSandbox: { ChromeHeadlessNoSandbox: {
base: 'ChromeHeadless', base: 'ChromeHeadless',
flags: ['--no-sandbox'] flags: ['--no-sandbox'],
} },
}, },
tfsReporter: { tfsReporter: {
outputDir: 'testresults', outputDir: 'testresults',

34
test/tabs/cli.js
View file

@ -1,17 +1,21 @@
class MockAnalytics { class MockAnalytics {
EVENT_CATEGORIES = {}; EVENT_CATEGORIES = {};
sendEvent() {} sendEvent() {
// Empty
}
} }
var analytics; let analytics;
describe('TABS.cli', () => { describe('TABS.cli', () => {
function toArrayBuffer(string) {
var bufferOut = new ArrayBuffer(string.length);
var bufView = new Uint8Array(bufferOut);
for (var i = 0; i < string.length; i++) { function toArrayBuffer(string) {
const bufferOut = new ArrayBuffer(string.length);
const bufView = new Uint8Array(bufferOut);
for (let i = 0; i < string.length; i++) {
bufView[i] = string.charCodeAt(i); bufView[i] = string.charCodeAt(i);
} }
@ -20,7 +24,7 @@ describe('TABS.cli', () => {
describe('output', () => { describe('output', () => {
const cliTab = $('<div>').addClass('tab-cli'); const cliTab = $('<div>').addClass('tab-cli');
const cliOutput = $('<div>').addClass('wrapper') const cliOutput = $('<div>').addClass('wrapper');
const cliPrompt = $('<textarea name="commands">'); const cliPrompt = $('<textarea name="commands">');
cliTab.append($('<div>').addClass('window').append(cliOutput)); cliTab.append($('<div>').addClass('window').append(cliOutput));
@ -31,10 +35,10 @@ describe('TABS.cli', () => {
before(() => { before(() => {
analytics = new MockAnalytics(); analytics = new MockAnalytics();
$('body') $('body').append(cliTab);
.append(cliTab);
CONFIGURATOR.cliValid = true; CONFIGURATOR.cliValid = true;
TABS.cli.GUI.windowWrapper = cliOutput;
}); });
after(() => cliTab.remove()); after(() => cliTab.remove());
@ -49,7 +53,7 @@ describe('TABS.cli', () => {
TABS.cli.cliBuffer = 'se'; TABS.cli.cliBuffer = 'se';
TABS.cli.read({ TABS.cli.read({
data: toArrayBuffer('\r\033[Kserialpassthrough\tservo\r\n# ser') data: toArrayBuffer('\r\033[Kserialpassthrough\tservo\r\n# ser'),
}); });
// Ambigous auto-complete from firmware is preceded with an \r carriage return // Ambigous auto-complete from firmware is preceded with an \r carriage return
@ -63,7 +67,7 @@ describe('TABS.cli', () => {
it('unambiguous auto-complete result', () => { it('unambiguous auto-complete result', () => {
TABS.cli.read({ TABS.cli.read({
data: toArrayBuffer('serialpassthrough') data: toArrayBuffer('serialpassthrough'),
}); });
expect(cliOutput.html()).to.equal(''); expect(cliOutput.html()).to.equal('');
@ -74,7 +78,7 @@ describe('TABS.cli', () => {
TABS.cli.cliBuffer = 'serial'; TABS.cli.cliBuffer = 'serial';
TABS.cli.read({ TABS.cli.read({
data: toArrayBuffer('passthrough') data: toArrayBuffer('passthrough'),
}); });
expect(cliOutput.html()).to.equal(''); expect(cliOutput.html()).to.equal('');
@ -83,7 +87,7 @@ describe('TABS.cli', () => {
it("escape characters are skipped", () => { it("escape characters are skipped", () => {
TABS.cli.read({ TABS.cli.read({
data: toArrayBuffer('\033[K') data: toArrayBuffer('\033[K'),
}); });
expect(cliOutput.html()).to.equal(''); expect(cliOutput.html()).to.equal('');
@ -123,7 +127,7 @@ describe('TABS.cli', () => {
callback(); callback();
}); });
sinon.stub(TABS.cli, 'send'); sinon.stub(TABS.cli, 'send');
sinon.stub(Promise, 'reduce').callsFake((items, cb, initialValue) => { sinon.stub(Promise, 'reduce').callsFake((items, cb) => {
items.forEach((line, idx) => cb(0, line, idx)); items.forEach((line, idx) => cb(0, line, idx));
}); });
sinon.stub(window, 'Promise').callsFake(resolve => resolve(0)); sinon.stub(window, 'Promise').callsFake(resolve => resolve(0));
@ -157,7 +161,7 @@ describe('TABS.cli', () => {
expect(TABS.cli.send).to.have.been.calledOnce; expect(TABS.cli.send).to.have.been.calledOnce;
expect(TABS.cli.send).to.have.been.calledWith('serial\t'); expect(TABS.cli.send).to.have.been.calledWith('serial\t');
done() done();
}); });
}); });

9
yarn.lock
View file

@ -1305,7 +1305,7 @@ colorette@^1.2.1:
resolved "https://registry.yarnpkg.com/colorette/-/colorette-1.2.1.tgz#4d0b921325c14faf92633086a536db6e89564b1b" resolved "https://registry.yarnpkg.com/colorette/-/colorette-1.2.1.tgz#4d0b921325c14faf92633086a536db6e89564b1b"
integrity sha512-puCDz0CzydiSYOrnXpz/PKd69zRrribezjtE9yd4zvytoRc8+RY/KJPvtPFKZS3E3wP6neGyMe0vOTlHO5L3Pw== integrity sha512-puCDz0CzydiSYOrnXpz/PKd69zRrribezjtE9yd4zvytoRc8+RY/KJPvtPFKZS3E3wP6neGyMe0vOTlHO5L3Pw==
colors@^1.1.0: colors@^1.1.0, colors@^1.1.2:
version "1.4.0" version "1.4.0"
resolved "https://registry.yarnpkg.com/colors/-/colors-1.4.0.tgz#c50491479d4c1bdaed2c9ced32cf7c7dc2360f78" resolved "https://registry.yarnpkg.com/colors/-/colors-1.4.0.tgz#c50491479d4c1bdaed2c9ced32cf7c7dc2360f78"
integrity sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA== integrity sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==
@ -4068,6 +4068,13 @@ karma-sinon@^1.0.5:
resolved "https://registry.yarnpkg.com/karma-sinon/-/karma-sinon-1.0.5.tgz#4e3443f2830fdecff624d3747163f1217daa2a9a" resolved "https://registry.yarnpkg.com/karma-sinon/-/karma-sinon-1.0.5.tgz#4e3443f2830fdecff624d3747163f1217daa2a9a"
integrity sha1-TjRD8oMP3s/2JNN0cWPxIX2qKpo= integrity sha1-TjRD8oMP3s/2JNN0cWPxIX2qKpo=
karma-spec-reporter@^0.0.32:
version "0.0.32"
resolved "https://registry.yarnpkg.com/karma-spec-reporter/-/karma-spec-reporter-0.0.32.tgz#2e9c7207ea726771260259f82becb543209e440a"
integrity sha1-LpxyB+pyZ3EmAln4K+y1QyCeRAo=
dependencies:
colors "^1.1.2"
karma-tfs-reporter@^1.0.2: karma-tfs-reporter@^1.0.2:
version "1.0.2" version "1.0.2"
resolved "https://registry.yarnpkg.com/karma-tfs-reporter/-/karma-tfs-reporter-1.0.2.tgz#2e3c3e448fc71dd4bbdd0af8a7a1ba7b1043361f" resolved "https://registry.yarnpkg.com/karma-tfs-reporter/-/karma-tfs-reporter-1.0.2.tgz#2e3c3e448fc71dd4bbdd0af8a7a1ba7b1043361f"