brut-js 0.15.0 → 0.16.0-pre

package/docs/node_modules/jsdoc/lib/jsdoc/opts/argparser.js

@@ -1,306 +0,0 @@
-/**
- * Parse the command line arguments.
- * @module jsdoc/opts/argparser
- */
-const _ = require('underscore');
-const util = require('util');
-
-const hasOwnProp = Object.prototype.hasOwnProperty;
-
-function padding(length) {
-    return new Array(length + 1).join(' ');
-}
-
-function padLeft(str, length) {
-    return padding(length) + str;
-}
-
-function padRight(str, length) {
-    return str + padding(length);
-}
-
-function findMaxLength(arr) {
-    let max = 0;
-
-    arr.forEach(({length}) => {
-        if (length > max) {
-            max = length;
-        }
-    });
-
-    return max;
-}
-
-function concatWithMaxLength(items, maxLength) {
-    let result = '';
-
-    // to prevent endless loops, always use the first item, regardless of length
-    result += items.shift();
-
-    while ( items.length && (result.length + items[0].length < maxLength) ) {
-        result += ` ${items.shift()}`;
-    }
-
-    return result;
-}
-
-// we want to format names and descriptions like this:
-// |    -f, --foo    Very long description very long description very long    |
-// |                 description very long description.                       |
-function formatHelpInfo({names, descriptions}) {
-    const MARGIN_LENGTH = 4;
-    const results = [];
-
-    const maxLength = process.stdout.columns;
-    const maxNameLength = findMaxLength(names);
-    const wrapDescriptionAt = maxLength - (MARGIN_LENGTH * 3) - maxNameLength;
-
-    // build the string for each option
-    names.forEach((name, i) => {
-        let result;
-        let partialDescription;
-        let words;
-
-        // add a left margin to the name
-        result = padLeft(names[i], MARGIN_LENGTH);
-        // and a right margin, with extra padding so the descriptions line up with one another
-        result = padRight(result, maxNameLength - names[i].length + MARGIN_LENGTH);
-
-        // split the description on spaces
-        words = descriptions[i].split(' ');
-        // add as much of the description as we can fit on the first line
-        result += concatWithMaxLength(words, wrapDescriptionAt);
-        // if there's anything left, keep going until we've consumed the description
-        while (words.length) {
-            partialDescription = padding( maxNameLength + (MARGIN_LENGTH * 2) );
-            partialDescription += concatWithMaxLength(words, wrapDescriptionAt);
-            result += `\n${partialDescription}`;
-        }
-
-        results.push(result);
-    });
-
-    return results;
-}
-
-/**
- * A parser to interpret the key-value pairs entered on the command line.
- *
- * @alias module:jsdoc/opts/argparser
- */
-class ArgParser {
-    /**
-     * Create an instance of the parser.
-     */
-    constructor() {
-        this._options = [];
-        this._shortNameIndex = {};
-        this._longNameIndex = {};
-    }
-
-    _getOptionByShortName(name) {
-        if (hasOwnProp.call(this._shortNameIndex, name)) {
-            return this._options[this._shortNameIndex[name]];
-        }
-
-        return null;
-    }
-
-    _getOptionByLongName(name) {
-        if (hasOwnProp.call(this._longNameIndex, name)) {
-            return this._options[this._longNameIndex[name]];
-        }
-
-        return null;
-    }
-
-    _addOption(option) {
-        let currentIndex;
-
-        const longName = option.longName;
-        const shortName = option.shortName;
-
-        this._options.push(option);
-        currentIndex = this._options.length - 1;
-
-        if (shortName) {
-            this._shortNameIndex[shortName] = currentIndex;
-        }
-        if (longName) {
-            this._longNameIndex[longName] = currentIndex;
-        }
-
-        return this;
-    }
-
-    /**
-     * Provide information about a legal option.
-     *
-     * @param {character} shortName - The short name of the option, entered like: -T.
-     * @param {string} longName - The equivalent long name of the option, entered like: --test.
-     * @param {boolean} hasValue - Does this option require a value? Like: -t templatename
-     * @param {string} helpText - A brief description of the option.
-     * @param {boolean} [canHaveMultiple=false] - Set to `true` if the option can be provided more
-     * than once.
-     * @param {function} [coercer] - A function to coerce the given value to a specific type.
-     * @return {this}
-     * @example
-     * myParser.addOption('t', 'template', true, 'The path to the template.');
-     * myParser.addOption('h', 'help', false, 'Show the help message.');
-     */
-    addOption(shortName, longName, hasValue, helpText, canHaveMultiple = false, coercer) {
-        return this._addOption({
-            shortName: shortName,
-            longName: longName,
-            hasValue: hasValue,
-            helpText: helpText,
-            canHaveMultiple: canHaveMultiple,
-            coercer: coercer
-        });
-    }
-
-    // TODO: refactor addOption to accept objects, then get rid of this method
-    /**
-     * Provide information about an option that should not cause an error if present, but that is always
-     * ignored (for example, an option that was used in previous versions but is no longer supported).
-     *
-     * @private
-     * @param {string} shortName - The short name of the option with a leading hyphen (for example,
-     * `-v`).
-     * @param {string} longName - The long name of the option with two leading hyphens (for example,
-     * `--version`).
-     */
-    addIgnoredOption(shortName, longName) {
-        return this._addOption({
-            shortName: shortName,
-            longName: longName,
-            ignore: true
-        });
-    }
-
-    /**
-     * Generate a summary of all the options with corresponding help text.
-     * @returns {string}
-     */
-    help() {
-        const options = {
-            names: [],
-            descriptions: []
-        };
-
-        this._options.forEach(option => {
-            let name = '';
-
-            // don't show ignored options
-            if (option.ignore) {
-                return;
-            }
-
-            if (option.shortName) {
-                name += `-${option.shortName}${option.longName ? ', ' : ''}`;
-            }
-
-            if (option.longName) {
-                name += `--${option.longName}`;
-            }
-
-            if (option.hasValue) {
-                name += ' <value>';
-            }
-
-            options.names.push(name);
-            options.descriptions.push(option.helpText);
-        });
-
-        return `Options:\n${formatHelpInfo(options).join('\n')}`;
-    }
-
-    /**
-     * Get the options.
-     * @param {Array.<string>} args An array, like ['-x', 'hello']
-     * @param {Object} [defaults={}] An optional collection of default values.
-     * @returns {Object} The keys will be the longNames, or the shortName if no longName is defined for
-     * that option. The values will be the values provided, or `true` if the option accepts no value.
-     */
-    parse(args, defaults) {
-        let arg;
-        let next;
-        let option;
-        const result = ( defaults && _.defaults({}, defaults) ) || {};
-        let shortName;
-        let longName;
-        let name;
-        let value;
-
-        result._ = [];
-        for (let i = 0, l = args.length; i < l; i++) {
-            arg = String(args[i]);
-            next = (i < l - 1) ? String(args[i + 1]) : null;
-            shortName = null;
-            value = null;
-
-            // like -t
-            if (arg.charAt(0) === '-') {
-                // like --template
-                if (arg.charAt(1) === '-') {
-                    name = longName = arg.slice(2);
-                    option = this._getOptionByLongName(longName);
-                }
-                else {
-                    name = shortName = arg.slice(1);
-                    option = this._getOptionByShortName(shortName);
-                }
-
-                if (option === null) {
-                    throw new Error( util.format('Unknown command-line option "%s".', name) );
-                }
-
-                if (option.hasValue) {
-                    value = next;
-                    i++;
-
-                    if (value === null || value.charAt(0) === '-') {
-                        throw new Error( util.format('The command-line option "%s" requires a value.', name) );
-                    }
-                }
-                else {
-                    value = true;
-                }
-
-                // skip ignored options now that we've consumed the option text
-                if (option.ignore) {
-                    continue;
-                }
-
-                if (option.longName && shortName) {
-                    name = option.longName;
-                }
-
-                if (typeof option.coercer === 'function') {
-                    value = option.coercer(value);
-                }
-
-                // Allow for multiple options of the same type to be present
-                if (option.canHaveMultiple && hasOwnProp.call(result, name)) {
-                    const val = result[name];
-
-                    if (val instanceof Array) {
-                        val.push(value);
-                    } else {
-                        result[name] = [val, value];
-                    }
-                }
-                else {
-                    result[name] = value;
-                }
-            }
-            else {
-                result._.push(arg);
-            }
-        }
-
-        return result;
-    }
-}
-
-module.exports = ArgParser;

package/docs/node_modules/jsdoc/lib/jsdoc/opts/args.js

@@ -1,82 +0,0 @@
-/**
- * @module jsdoc/opts/args
- * @requires jsdoc/opts/argparser
- */
-const ArgParser = require('jsdoc/opts/argparser');
-const cast = require('jsdoc/util/cast').cast;
-const querystring = require('querystring');
-
-let ourOptions;
-
-const argParser = new ArgParser();
-const hasOwnProp = Object.prototype.hasOwnProperty;
-
-function parseQuery(str) {
-    return cast( querystring.parse(str) );
-}
-
-/* eslint-disable no-multi-spaces */
-argParser.addOption('a', 'access',      true,  'Only display symbols with the given access: "package", public", "protected", "private" or "undefined", or "all" for all access levels. Default: all except "private"', true);
-argParser.addOption('c', 'configure',   true,  'The path to the configuration file. Default: path/to/jsdoc/conf.json');
-argParser.addOption('d', 'destination', true,  'The path to the output folder. Default: ./out/');
-argParser.addOption('',  'debug',       false, 'Log information for debugging JSDoc.');
-argParser.addOption('e', 'encoding',    true,  'Assume this encoding when reading all source files. Default: utf8');
-argParser.addOption('h', 'help',        false, 'Print this message and quit.');
-argParser.addOption('',  'match',       true,  'When running tests, only use specs whose names contain <value>.', true);
-argParser.addOption('',  'nocolor',     false, 'When running tests, do not use color in console output.');
-argParser.addOption('p', 'private',     false, 'Display symbols marked with the @private tag. Equivalent to "--access all". Default: false');
-argParser.addOption('P', 'package',     true,  'The path to the project\'s package file. Default: path/to/sourcefiles/package.json');
-argParser.addOption('',  'pedantic',    false, 'Treat errors as fatal errors, and treat warnings as errors. Default: false');
-argParser.addOption('q', 'query',       true,  'A query string to parse and store in jsdoc.env.opts.query. Example: foo=bar&baz=true', false, parseQuery);
-argParser.addOption('r', 'recurse',     false, 'Recurse into subdirectories when scanning for source files and tutorials.');
-argParser.addOption('R', 'readme',      true,  'The path to the project\'s README file. Default: path/to/sourcefiles/README.md');
-argParser.addOption('t', 'template',    true,  'The path to the template to use. Default: path/to/jsdoc/templates/default');
-argParser.addOption('T', 'test',        false, 'Run all tests and quit.');
-argParser.addOption('u', 'tutorials',   true,  'Directory in which JSDoc should search for tutorials.');
-argParser.addOption('v', 'version',     false, 'Display the version number and quit.');
-argParser.addOption('',  'verbose',     false, 'Log detailed information to the console as JSDoc runs.');
-argParser.addOption('X', 'explain',     false, 'Dump all found doclet internals to console and quit.');
-/* eslint-enable no-multi-spaces */
-
-// Options that are no longer supported and should be ignored
-argParser.addIgnoredOption('l', 'lenient'); // removed in JSDoc 3.3.0
-
-/**
- * Set the options for this app.
- * @throws {Error} Illegal arguments will throw errors.
- * @param {string|String[]} args The command line arguments for this app.
- */
-exports.parse = (args = []) => {
-    if (typeof args === 'string' || args.constructor === String) {
-        args = String(args).split(/\s+/g);
-    }
-
-    ourOptions = argParser.parse(args);
-
-    return ourOptions;
-};
-
-/**
- * Retrieve help message for options.
- */
-exports.help = () => argParser.help();
-
-/**
- * Get a named option.
- * @variation name
- * @param {string} name The name of the option.
- * @return {string} The value associated with the given name.
- *//**
-* Get all the options for this app.
-* @return {Object} A collection of key/values representing all the options.
-*/
-exports.get = name => {
-    if (typeof name === 'undefined') {
-        return ourOptions;
-    }
-    else if ( hasOwnProp.call(ourOptions, name) ) {
-        return ourOptions[name];
-    }
-
-    return undefined;
-};

package/docs/node_modules/jsdoc/lib/jsdoc/package.js

@@ -1,257 +0,0 @@
-const logger = require('jsdoc/util/logger');
-const stripBom = require('jsdoc/util/stripbom');
-
-/**
- * Provides access to information about a JavaScript package.
- *
- * @module jsdoc/package
- * @see https://www.npmjs.org/doc/files/package.json.html
- */
-
-// Collect all of the license information from a `package.json` file.
-function getLicenses(packageInfo) {
-    const licenses = packageInfo.licenses ? packageInfo.licenses.slice(0) : [];
-
-    if (packageInfo.license) {
-        licenses.push({ type: packageInfo.license });
-    }
-
-    return licenses;
-}
-
-/**
- * Information about where to report bugs in the package.
- *
- * @typedef {Object} module:jsdoc/package.Package~BugInfo
- * @property {string} email - The email address for reporting bugs.
- * @property {string} url - The URL for reporting bugs.
- */
-
-/**
- * Information about a package's software license.
- *
- * @typedef {Object} module:jsdoc/package.Package~LicenseInfo
- * @property {string} type - An identifier for the type of license.
- * @property {string} url - The URL for the complete text of the license.
- */
-
-/**
- * Information about a package author or contributor.
- *
- * @typedef {Object} module:jsdoc/package.Package~PersonInfo
- * @property {string} name - The person's full name.
- * @property {string} email - The person's email address.
- * @property {string} url - The URL of the person's website.
- */
-
-/**
- * Information about a package's version-control repository.
- *
- * @typedef {Object} module:jsdoc/package.Package~RepositoryInfo
- * @property {string} type - The type of version-control system that the repository uses (for
- * example, `git` or `svn`).
- * @property {string} url - The URL for the repository.
- */
-
-/**
- * Information about a JavaScript package. JSDoc can extract package information from
- * `package.json` files that follow the
- * [npm specification](https://www.npmjs.org/doc/files/package.json.html).
- *
- * **Note**: JSDoc does not validate or normalize the contents of `package.json` files. If your
- * `package.json` file does not follow the npm specification, some properties of the `Package`
- * object may not use the format documented here.
- */
-class Package {
-    /**
-     * @param {string} json - The contents of the `package.json` file.
-     */
-    constructor(json) {
-        let packageInfo;
-
-        /**
-         * The string identifier that is shared by all `Package` objects.
-         *
-         * @readonly
-         * @default
-         * @type {string}
-         */
-        this.kind = 'package';
-
-        try {
-            packageInfo = JSON.parse(stripBom.strip(json) || '{}');
-        }
-        catch (e) {
-            logger.error('Unable to parse the package file: %s', e.message);
-            packageInfo = {};
-        }
-
-        if (packageInfo.name) {
-            /**
-             * The package name.
-             *
-             * @type {string}
-             */
-            this.name = packageInfo.name;
-        }
-
-        /**
-         * The unique longname for this `Package` object.
-         *
-         * @type {string}
-         */
-        this.longname = `${this.kind}:${this.name}`;
-
-        if (packageInfo.author) {
-            /**
-             * The author of this package. Contains either a
-             * {@link module:jsdoc/package.Package~PersonInfo PersonInfo} object or a string with
-             * information about the author.
-             *
-             * @type {(module:jsdoc/package.Package~PersonInfo|string)}
-             * @since 3.3.0
-             */
-            this.author = packageInfo.author;
-        }
-
-        if (packageInfo.bugs) {
-            /**
-             * Information about where to report bugs in the project. May contain a URL, a string, or an
-             * object with more detailed information.
-             *
-             * @type {(string|module:jsdoc/package.Package~BugInfo)}
-             * @since 3.3.0
-             */
-            this.bugs = packageInfo.bugs;
-        }
-
-        if (packageInfo.contributors) {
-            /**
-             * The contributors to this package.
-             *
-             * @type {Array.<(module:jsdoc/package.Package~PersonInfo|string)>}
-             * @since 3.3.0
-             */
-            this.contributors = packageInfo.contributors;
-        }
-
-        if (packageInfo.dependencies) {
-            /**
-             * The dependencies for this package.
-             *
-             * @type {Object}
-             * @since 3.3.0
-             */
-            this.dependencies = packageInfo.dependencies;
-        }
-
-        if (packageInfo.description) {
-            /**
-             * A brief description of the package.
-             *
-             * @type {string}
-             */
-            this.description = packageInfo.description;
-        }
-
-        if (packageInfo.devDependencies) {
-            /**
-             * The development dependencies for this package.
-             *
-             * @type {Object}
-             * @since 3.3.0
-             */
-            this.devDependencies = packageInfo.devDependencies;
-        }
-
-        if (packageInfo.engines) {
-            /**
-             * The JavaScript engines that this package supports. Each key is a string that identifies
-             * the engine (for example, `node`). Each value is a
-             * [semver](https://www.npmjs.org/doc/misc/semver.html)-compliant version number for the
-             * engine.
-             *
-             * @type {Object}
-             * @since 3.3.0
-             */
-            this.engines = packageInfo.engines;
-        }
-
-        /**
-         * The source files associated with the package.
-         *
-         * New `Package` objects always contain an empty array, regardless of whether the `package.json`
-         * file includes a `files` property.
-         *
-         * After JSDoc parses your input files, it sets this property to a list of paths to your input
-         * files.
-         *
-         * @type {Array.<string>}
-         */
-        this.files = [];
-
-        if (packageInfo.homepage) {
-            /**
-             * The URL for the package's homepage.
-             *
-             * @type {string}
-             * @since 3.3.0
-             */
-            this.homepage = packageInfo.homepage;
-        }
-
-        if (packageInfo.keywords) {
-            /**
-             * Keywords to help users find the package.
-             *
-             * @type {Array.<string>}
-             * @since 3.3.0
-             */
-            this.keywords = packageInfo.keywords;
-        }
-
-        if (packageInfo.license || packageInfo.licenses) {
-            /**
-             * The licenses used by this package. Combines information from the `package.json` file's
-             * `license` property and the deprecated `licenses` property.
-             *
-             * @type {Array.<module:jsdoc/package.Package~LicenseInfo>}
-             */
-            this.licenses = getLicenses(packageInfo);
-        }
-
-        if (packageInfo.main) {
-            /**
-             * The module ID that provides the primary entry point to the package. For example, if your
-             * package is a CommonJS module, and the value of this property is `foo`, users should be
-             * able to load your module with `require('foo')`.
-             *
-             * @type {string}
-             * @since 3.3.0
-             */
-            this.main = packageInfo.main;
-        }
-
-        if (packageInfo.repository) {
-            /**
-             * The version-control repository for the package.
-             *
-             * @type {module:jsdoc/package.Package~RepositoryInfo}
-             * @since 3.3.0
-             */
-            this.repository = packageInfo.repository;
-        }
-
-        if (packageInfo.version) {
-            /**
-             * The [semver](https://www.npmjs.org/doc/misc/semver.html)-compliant version number of the
-             * package.
-             *
-             * @type {string}
-             * @since 3.2.0
-             */
-            this.version = packageInfo.version;
-        }
-    }
-}
-exports.Package = Package;