@@ -51,26 +51,23 @@ const Commands = {
5151
5252 // Parses the text supplied by the user in their "keyMappings" setting.
5353 // - shouldLogWarnings: if true, logs to the console when part of the user's config is invalid.
54- // Returns { keyToRegistryEntry, keyToMappedKey }.
54+ // Returns { keyToRegistryEntry, keyToMappedKey, validationErrors }.
5555 parseKeyMappingsConfig ( configText , shouldLogWarnings ) {
5656 let keyToRegistryEntry = { } ;
5757 let mapKeyRegistry = { } ;
58+ const errors = [ ] ;
5859
5960 const configLines = Utils . parseLines ( configText ) ;
60- const logWarning = ( ...args ) => {
61- if ( ! shouldLogWarnings ) return ;
62- console . warn . apply ( console , args ) ;
63- } ;
6461
6562 for ( const line of configLines ) {
6663 const tokens = line . split ( / \s + / ) ;
67- const command = tokens [ 0 ] . toLowerCase ( ) ;
68- switch ( command ) {
64+ const action = tokens [ 0 ] . toLowerCase ( ) ;
65+ switch ( action ) {
6966 case "map" :
7067 if ( tokens . length >= 3 ) {
7168 const [ _ , key , command , ...optionList ] = tokens ;
7269 if ( ! this . availableCommands [ command ] ) {
73- logWarning ( `"${ command } ` , line ) ;
70+ errors . push ( `"${ command } ${ line } ` ) ;
7471 continue ;
7572 }
7673 const keySequence = this . parseKeySequence ( key ) ;
@@ -87,7 +84,7 @@ const Commands = {
8784 break ;
8885 case "unmap" :
8986 if ( tokens . length != 2 ) {
90- logWarning ( " Incorrect usage for unmap in the line:" , line ) ;
87+ errors . push ( ` Incorrect usage for unmap in the line: ${ line } ` ) ;
9188 continue ;
9289 }
9390 const key = tokens [ 1 ] ;
@@ -100,7 +97,7 @@ const Commands = {
10097 break ;
10198 case "mapkey" :
10299 if ( tokens . length != 3 ) {
103- logWarning ( " Incorrect usage for mapkey in the line:" , line ) ;
100+ errors . push ( ` Incorrect usage for mapKey in the line: ${ line } ` ) ;
104101 continue ;
105102 }
106103 const fromChar = this . parseKeySequence ( tokens [ 1 ] ) ;
@@ -111,20 +108,20 @@ const Commands = {
111108 if ( isValid ) {
112109 mapKeyRegistry [ fromChar [ 0 ] ] = toChar [ 0 ] ;
113110 } else {
114- logWarning (
115- "mapkey only supports mapping keys which are single characters. Line:" ,
116- line ,
111+ errors . push (
112+ `mapkey only supports mapping keys which are single characters. Line: ${ line } ,
117113 ) ;
118114 }
119115 break ;
120116 default :
121- logWarning ( `"${ command } ` , line ) ;
117+ errors . push ( `"${ action } ${ line } ` ) ;
122118 }
123119 }
124120
125121 return {
126122 keyToRegistryEntry,
127123 keyToMappedKey : mapKeyRegistry ,
124+ validationErrors : errors ,
128125 } ;
129126 } ,
130127
@@ -257,24 +254,46 @@ const Commands = {
257254 // Build the "helpPageData" data structure which the help page needs and place it in Chrome
258255 // storage.
259256 prepareHelpPageData ( ) {
260- const commandToKey = { } ;
257+ /*
258+ Map of commands to option sets to keys to trigger that command option set.
259+ Commands with no options will have the empty string options set.
260+ Example:
261+ {
262+ "zoomReset": {
263+ "": ["z0", "zz"] // No options, with two key maps, ie: `map zz zoomReset`
264+ },
265+ "setZoom": {
266+ "1.1": ["z1"], // `map z1 setZoom 1.1`
267+ "1.2": ["z2"], // `map z2 setZoom 1.2`
268+ }
269+ }
270+ */
271+ const commandToOptionsToKeys = { } ;
261272 for ( const key of Object . keys ( this . keyToRegistryEntry || { } ) ) {
262273 const registryEntry = this . keyToRegistryEntry [ key ] ;
263- ( commandToKey [ registryEntry . command ] != null
264- ? commandToKey [ registryEntry . command ]
265- : ( commandToKey [ registryEntry . command ] = [ ] ) ) . push ( key ) ;
274+ const optionString = registryEntry . optionList ?. join ( " " ) || "" ;
275+ commandToOptionsToKeys [ registryEntry . command ] ||= { } ;
276+ commandToOptionsToKeys [ registryEntry . command ] [ optionString ] ||= [ ] ;
277+ commandToOptionsToKeys [ registryEntry . command ] [ optionString ] . push ( key ) ;
266278 }
267279 const commandGroups = { } ;
268280 for ( const group of Object . keys ( this . commandGroups || { } ) ) {
269281 const commands = this . commandGroups [ group ] ;
270282 commandGroups [ group ] = [ ] ;
271283 for ( const command of commands ) {
272- commandGroups [ group ] . push ( {
273- command,
274- description : this . availableCommands [ command ] . description ,
275- keys : commandToKey [ command ] != null ? commandToKey [ command ] : [ ] ,
276- advanced : this . advancedCommands . includes ( command ) ,
277- } ) ;
284+ // Default to base command has no keys for "show available commands" menu.
285+ const optionsToKeys = commandToOptionsToKeys [ command ] ?? { "" : [ ] } ;
286+ for ( const [ options , keys ] of Object . entries ( optionsToKeys ) ) {
287+ const advanced = this . advancedCommands . includes ( command ) ||
288+ this . advancedCommands . includes ( `${ command } ${ options } ) ;
289+ commandGroups [ group ] . push ( {
290+ command,
291+ description : this . availableCommands [ command ] . description ,
292+ keys,
293+ advanced,
294+ options,
295+ } ) ;
296+ }
278297 }
279298 }
280299 chrome . storage . session . set ( { helpPageData : commandGroups } ) ;
@@ -297,7 +316,6 @@ const Commands = {
297316 "scrollToLeft" ,
298317 "scrollToRight" ,
299318 "reload" ,
300- "hardReload" ,
301319 "copyCurrentUrl" ,
302320 "openCopiedUrlInCurrentTab" ,
303321 "openCopiedUrlInNewTab" ,
@@ -331,7 +349,13 @@ const Commands = {
331349 "Vomnibar.activateEditUrl" ,
332350 "Vomnibar.activateEditUrlInNewTab" ,
333351 ] ,
334- findCommands : [ "enterFindMode" , "performFind" , "performBackwardsFind" ] ,
352+ findCommands : [
353+ "enterFindMode" ,
354+ "performFind" ,
355+ "performBackwardsFind" ,
356+ "findSelected" ,
357+ "findSelectedBackwards" ,
358+ ] ,
335359 historyNavigation : [ "goBack" , "goForward" ] ,
336360 tabManipulation : [
337361 "createTab" ,
@@ -374,6 +398,8 @@ const Commands = {
374398 "mergeTabToExistingWindowOnRight" ,
375399 "mergeTabToExistingWindowAbove" ,
376400 "mergeTabToExistingWindowBelow" ,
401+ "findSelected" ,
402+ "findSelectedBackwards" ,
377403 "goUp" ,
378404 "goToRoot" ,
379405 "LinkHints.activateModeWithQueue" ,
@@ -394,11 +420,11 @@ const Commands = {
394420 "enterVisualLineMode" ,
395421 "toggleViewSource" ,
396422 "passNextKey" ,
397- "hardReload" ,
398423 "setZoom" ,
399424 "zoomIn" ,
400425 "zoomOut" ,
401426 "zoomReset" ,
427+ "reload hard" ,
402428 ] ,
403429} ;
404430
@@ -417,7 +443,7 @@ const defaultKeyMappings = {
417443 "d" : "scrollPageDown" ,
418444 "u" : "scrollPageUp" ,
419445 "r" : "reload" ,
420- "R" : "hardReload " ,
446+ "R" : "reload hard " ,
421447 "yy" : "copyCurrentUrl" ,
422448 "p" : "openCopiedUrlInCurrentTab" ,
423449 "P" : "openCopiedUrlInNewTab" ,
@@ -442,6 +468,8 @@ const defaultKeyMappings = {
442468 "/" : "enterFindMode" ,
443469 "n" : "performFind" ,
444470 "N" : "performBackwardsFind" ,
471+ "*" : "findSelected" ,
472+ "#" : "findSelectedBackwards" ,
445473
446474 // Vomnibar
447475 "o" : "Vomnibar.activate" ,
@@ -511,7 +539,6 @@ const commandDescriptions = {
511539 scrollFullPageUp : [ "Scroll a full page up" ] ,
512540
513541 reload : [ "Reload the page" , { background : true } ] ,
514- hardReload : [ "Hard reload the page" , { background : true } ] ,
515542 toggleViewSource : [ "View page source" , { noRepeat : true } ] ,
516543
517544 copyCurrentUrl : [ "Copy the current URL to the clipboard" , { noRepeat : true } ] ,
@@ -536,6 +563,8 @@ const commandDescriptions = {
536563 enterFindMode : [ "Enter find mode" , { noRepeat : true } ] ,
537564 performFind : [ "Cycle forward to the next find match" ] ,
538565 performBackwardsFind : [ "Cycle backward to the previous find match" ] ,
566+ findSelected : [ "Find the selected text" ] ,
567+ findSelectedBackwards : [ "Find the selected text, searching backwards" ] ,
539568
540569 goPrevious : [ "Follow the link labeled previous or <" , { noRepeat : true } ] ,
541570 goNext : [ "Follow the link labeled next or >" , { noRepeat : true } ] ,
@@ -580,9 +609,9 @@ const commandDescriptions = {
580609 moveTabLeft : [ "Move tab to the left" , { background : true } ] ,
581610 moveTabRight : [ "Move tab to the right" , { background : true } ] ,
582611
583- setZoom : [ "Set zoom level to a given value. E.g. map zz setZoom 1.5 " , { background : true } ] ,
584- zoomIn : [ "Increase zoom " , { background : true } ] ,
585- zoomOut : [ "Decrease zoom " , { background : true } ] ,
612+ setZoom : [ "Set zoom" , { background : true } ] ,
613+ zoomIn : [ "Zoom in " , { background : true } ] ,
614+ zoomOut : [ "Zoom out " , { background : true } ] ,
586615 zoomReset : [ "Reset zoom" , { background : true } ] ,
587616
588617 "Vomnibar.activate" : [ "Open URL, bookmark or history entry" , { topFrame : true } ] ,
0 commit comments