All files / repl/lib complete_settings.js

60.43% Statements 55/91
100% Branches 1/1
0% Functions 0/1
60.43% Lines 55/91

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 9211x 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 logger = require( 'debug' );
var parse = require( 'acorn-loose' ).parse;
var startsWith = require( '@stdlib/string/starts-with' );
var settingsAliasArgs = require( './settings_alias_args.js' );
var SETTINGS_NAMES = require( './settings_names.js' );
 
 
// VARIABLES //
 
var debug = logger( 'repl:completer:settings' );
var AOPTS = {
	'ecmaVersion': 'latest'
};
 
 
// MAIN //
 
/**
* Completes a settings API expression.
*
* @private
* @param {Array} out - output array for storing completions
* @param {REPL} repl - REPL instance
* @param {string} expression - expression to complete
* @param {string} alias - settings API alias
* @param {string} value - value to complete
* @returns {string} value filter
*/
function complete( out, repl, expression, alias, value ) {
	var args;
	var ast;
	var arg;
	var v;
	var i;

	// Get the list of argument types for the desired API:
	debug( 'Settings API: %s', alias );
	args = settingsAliasArgs( alias );

	// Parse the expression into an AST:
	debug( 'Expression: %s', expression );
	ast = parse( expression, AOPTS );

	// Check whether the argument which triggered TAB completion has a corresponding argument type which is completable:
	debug( 'Checking if argument is completable...' );
	arg = args[ ast.body[ 0 ].expression.arguments.length-1 ];
	if ( !arg ) {
		debug( 'Argument which triggered TAB completion is not completable.' );
		return '';
	}
	debug( 'Argument is completable.' );

	debug( 'Searching for completion candidates...' );
	for ( i = 0; i < SETTINGS_NAMES.length; i++ ) {
		v = SETTINGS_NAMES[ i ];
		if ( startsWith( v, value ) ) {
			debug( 'Found a completion: %s', v );
			out.push( v );
		} else {
			debug( '%s does not match filter %s. Skipping...', v, value );
		}
	}
	return value;
}
 
 
// EXPORTS //
 
module.exports = complete;