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 | 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 127x 127x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 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 isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var format = require( '@stdlib/string/format' );
// VARIABLES //
var debug = logger( 'repl:command:userdoc' );
// MAIN //
/**
* Returns a callback to be invoked upon calling the `userDoc` command.
*
* @private
* @param {REPL} repl - REPL instance
* @returns {Function} callback
*/
function command( repl ) {
return onCommand;
/**
* Adds user-defined documentation.
*
* ## Notes
*
* - If user-defined documentation already exists for a provided alias, the current documentation is overwritten.
*
* @private
* @param {string} alias - alias
* @param {*} [ref] - object reference
* @param {string} doc - documentation
* @returns {void}
*/
function onCommand( alias, ref, doc ) {
var buf;
var err;
var d;
var r;
var i;
if ( !isString( alias ) ) {
err = new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', alias ) );
debug( 'Error: %s', err.message );
repl._ostream.write( 'Error: '+err.message+'\n' );
return;
}
if ( arguments.length < 3 ) {
d = ref;
} else {
r = ref;
d = doc;
}
if ( !isString( d ) ) {
err = new TypeError( format( 'invalid argument. Documentation argument must be a string. Value: `%s`.', d ) );
debug( 'Error: %s', err.message );
repl._ostream.write( 'Error: '+err.message+'\n' );
return;
}
buf = repl._userdocs;
// TODO: extract `info`, examples, etc
// Search for existing documentation to overwrite...
for ( i = 0; i < buf.length; i += 3 ) {
if ( buf[ i ] === alias ) {
buf[ i+1 ] = r;
buf[ i+2 ] = {
'text': d
};
return;
}
}
// Append new documentation:
buf.push( alias, r, {
'text': d
});
}
}
// EXPORTS //
module.exports = command;
|