All files / repl/lib validate_keybindings.js

52.1% Statements 62/119
100% Branches 1/1
0% Functions 0/2
52.1% Lines 62/119

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 12011x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x                                       11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x                                                                             11x 11x 11x 11x 11x  
/**
* @license Apache-2.0
*
* Copyright (c) 2024 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isArray = require( '@stdlib/assert/is-array' );
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var format = require( '@stdlib/string/format' );
var ACTIONS = require( './actions.js' );
 
 
// VARIABLES //
 
var KEY_BOOLEAN_PROPS = [ 'ctrl', 'shift', 'meta' ];
 
 
// FUNCTIONS //
 
/**
* Validates a key object.
*
* @private
* @param {Object} obj - key object
* @returns {(Error|null)} error or null
*/
function validateKey( obj ) {
	var prop;
	var i;
	if ( !hasOwnProp( obj, 'name' ) ) {
		return new TypeError( format( 'invalid option. Each key object must have a `name` property. Value: `%s`.', obj ) );
	}
	if ( !isString( obj[ 'name' ] ) ) {
		return new TypeError( format( 'invalid option. Each key object\'s `name` property must be a string. Value: `%s`.', obj ) );
	}
	for ( i = 0; i < KEY_BOOLEAN_PROPS.length; i++ ) {
		prop = KEY_BOOLEAN_PROPS[ i ];
		if ( hasOwnProp( obj, prop ) ) {
			if ( !isBoolean( obj[ prop ] ) ) {
				return new TypeError( format( 'invalid option. Each key object\'s `%s` property must be a boolean. Value: `%s`.', prop, obj ) );
			}
		}
	}
	return null;
}
 
 
// MAIN //
 
/**
* Validates keybindings.
*
* @private
* @param {Object} opts - destination object
* @param {Object} options - settings options
* @returns {(Error|null)} error or null
*/
function validate( opts, options ) {
	var list;
	var out;
	var err;
	var i;
	var j;
	var o;
	if ( !isPlainObject( options ) ) {
		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
	}
	for ( i = 0; i < ACTIONS.length; i++ ) {
		if ( hasOwnProp( options, ACTIONS[ i ] ) ) {
			list = options[ ACTIONS[ i ] ];
			if ( !isArray( list ) ) {
				return new TypeError( format( 'invalid option. Each action must be an array of objects. Value: `%s`.', list ) );
			}
			out = [];
			for ( j = 0; j < list.length; j++ ) {
				o = list[ j ];
				if ( !isPlainObject( o ) ) {
					return new TypeError( format( 'invalid option. Each action must be an array of objects. Value: `%s`.', list ) );
				}
				err = validateKey( o );
				if ( err ) {
					return err;
				}
				out.push({
					'name': o.name,
					'ctrl': o.ctrl || false,
					'shift': o.shift || false,
					'meta': o.meta || false
				});
			}
			opts[ ACTIONS[ i ] ] = out;
		}
	}
	return null;
}
 
 
// EXPORTS //
 
module.exports = validate;