All files / lib/commands workspaces.js

54.91% Statements 67/122
100% Branches 2/2
50% Functions 1/2
54.91% Lines 67/122

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 120 121 122 12311x 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 127x 127x 127x 127x 127x 127x 127x 127x 127x 127x 127x 127x 127x 127x                                                                                                               127x 11x 11x 11x 11x 11x  
/**
* @license Apache-2.0
*
* Copyright (c) 2019 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.
*/
 
/* eslint-disable no-underscore-dangle */
 
'use strict';
 
// MODULES //
 
var logger = require( 'debug' );
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isRegExp = require( '@stdlib/assert/is-regexp' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var objectKeys = require( '@stdlib/utils/keys' );
var format = require( '@stdlib/string/format' );
 
 
// VARIABLES //
 
var debug = logger( 'repl:command:workspaces' );
 
 
// MAIN //
 
/**
* Returns a callback to be invoked upon calling the `workspaces` command.
*
* @private
* @param {REPL} repl - REPL instance
* @returns {Function} callback
*/
function command( repl ) {
	return onCommand;
 
	/**
	* Returns a list of workspaces.
	*
	* @private
	* @param {Options} [options] - function options
	* @param {RegExp} [options.include] - name inclusion filter
	* @param {RegExp} [options.exclude] - name exclusion filter
	* @param {boolean} [options.details] - boolean indicating whether to include additional workspace details, such as variable names, types, contents, etc
	* @returns {Array} workspace names
	*/
	function onCommand( options ) {
		var err;
		var tmp;
		var out;
		var w;
		var i;
		if ( arguments.length === 0 ) {
			return objectKeys( repl._workspaces );
		}
		if ( !isPlainObject( options ) ) {
			err = new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', name ) );
			debug( 'Error: %s', err.message );
			repl._ostream.write( 'Error: '+err.message+'\n' );
			return;
		}
		if ( hasOwnProp( options, 'include' ) && !isRegExp( options.include ) ) {
			err = new TypeError( format( 'invalid option. `%s` option must be a regular expression. Option: `%s`.', 'include', options.include ) );
			debug( 'Error: %s', err.message );
			repl._ostream.write( 'Error: '+err.message+'\n' );
			return;
		}
		if ( hasOwnProp( options, 'exclude' ) && !isRegExp( options.exclude ) ) {
			err = new TypeError( format( 'invalid option. `%s` option must be a regular expression. Option: `%s`.', 'exclude', options.include ) );
			debug( 'Error: %s', err.message );
			repl._ostream.write( 'Error: '+err.message+'\n' );
			return;
		}
		if ( hasOwnProp( options, 'details' ) && !isBoolean( options.details ) ) {
			err = new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'details', options.details ) );
			debug( 'Error: %s', err.message );
			repl._ostream.write( 'Error: '+err.message+'\n' );
			return;
		}
		tmp = objectKeys( repl._workspaces );
		out = [];
		for ( i = 0; i < tmp.length; i++ ) {
			w = tmp[ i ];
			if ( options.include && !options.include.test( w ) ) {
				continue;
			}
			if ( options.exclude && options.exclude.test( w ) ) {
				continue;
			}
			// If we've made it this far, the variable should have passed all filters...
			out.push( w );
			if ( options.details ) {
				out[ out.length-1 ] = {
					'name': w,
					'variables': repl._context.varsWorkspace( w, {
						'details': true
					})
				};
			}
		}
		return out;
	}
}
 
 
// EXPORTS //
 
module.exports = command;