brut-js 0.14.0 → 0.16.0-pre

package/docs/node_modules/jsdoc/package.json

@@ -1,65 +0,0 @@
-{
-  "name": "jsdoc",
-  "version": "4.0.4",
-  "revision": "1729364734219",
-  "description": "An API documentation generator for JavaScript.",
-  "keywords": [
-    "documentation",
-    "javascript"
-  ],
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/jsdoc/jsdoc"
-  },
-  "dependencies": {
-    "@babel/parser": "^7.20.15",
-    "@jsdoc/salty": "^0.2.1",
-    "@types/markdown-it": "^14.1.1",
-    "bluebird": "^3.7.2",
-    "catharsis": "^0.9.0",
-    "escape-string-regexp": "^2.0.0",
-    "js2xmlparser": "^4.0.2",
-    "klaw": "^3.0.0",
-    "markdown-it": "^14.1.0",
-    "markdown-it-anchor": "^8.6.7",
-    "marked": "^4.0.10",
-    "mkdirp": "^1.0.4",
-    "requizzle": "^0.2.3",
-    "strip-json-comments": "^3.1.0",
-    "underscore": "~1.13.2"
-  },
-  "devDependencies": {
-    "ajv": "^6.12.0",
-    "gulp": "^5.0.0",
-    "gulp-eslint": "^6.0.0",
-    "gulp-json-editor": "^2.5.6",
-    "nyc": "^15.1.0"
-  },
-  "engines": {
-    "node": ">=12.0.0"
-  },
-  "scripts": {
-    "test": "gulp lint; gulp test"
-  },
-  "bin": {
-    "jsdoc": "./jsdoc.js"
-  },
-  "bugs": "https://github.com/jsdoc/jsdoc/issues",
-  "author": {
-    "name": "Michael Mathews",
-    "email": "micmath@gmail.com"
-  },
-  "contributors": [
-    {
-      "name": "The JSDoc Contributors",
-      "url": "https://github.com/jsdoc/jsdoc/graphs/contributors"
-    }
-  ],
-  "maintainers": [
-    {
-      "name": "Jeff Williams",
-      "email": "jeffrey.l.williams@gmail.com"
-    }
-  ]
-}

package/docs/node_modules/jsdoc/plugins/commentConvert.js

@@ -1,21 +0,0 @@
-/* eslint-disable spaced-comment */
-/**
- * Demonstrate how to modify the source code before the parser sees it.
- *
- * @module plugins/commentConvert
- */
-exports.handlers = {
-    ///
-    /// Convert ///-style comments into jsdoc comments.
-    /// @param e
-    /// @param e.filename
-    /// @param e.source
-    ///
-    beforeParse(e) {
-        e.source = e.source.replace(/(\n[ \t]*\/\/\/[^\n]*)+/g, $ => {
-            const replacement = `\n/**${$.replace(/^[ \t]*\/\/\//mg, '').replace(/(\n$|$)/, '*/$1')}`;
-
-            return replacement;
-        });
-    }
-};

package/docs/node_modules/jsdoc/plugins/commentsOnly.js

@@ -1,17 +0,0 @@
-/**
- * Remove everything in a file except JSDoc-style comments. By enabling this plugin, you can
- * document source files that are not valid JavaScript (including source files for other languages).
- * @module plugins/commentsOnly
- */
-exports.handlers = {
-    beforeParse(e) {
-        // a JSDoc comment looks like: /**[one or more chars]*/
-        const comments = e.source.match(/\/\*\*[\s\S]+?\*\//g);
-
-        if (comments) {
-            e.source = comments.join('\n\n');
-        } else {
-            e.source = ''; // If file has no comments, parser should still receive no code
-        }
-    }
-};

package/docs/node_modules/jsdoc/plugins/escapeHtml.js

@@ -1,18 +0,0 @@
-/**
- * Escape HTML tags in descriptions.
- *
- * @module plugins/escapeHtml
- */
-exports.handlers = {
-    /**
-     * Translate HTML tags in descriptions into safe entities. Replaces <, & and newlines
-     */
-    newDoclet({doclet}) {
-        if (doclet.description) {
-            doclet.description = doclet.description
-                .replace(/&/g, '&amp;')
-                .replace(/</g, '&lt;')
-                .replace(/\r\n|\n|\r/g, '<br>');
-        }
-    }
-};

package/docs/node_modules/jsdoc/plugins/eventDumper.js

@@ -1,97 +0,0 @@
-/**
- * Dump information about parser events to the console.
- *
- * @module plugins/eventDumper
- */
-const _ = require('underscore');
-const doop = require('jsdoc/util/doop');
-const dump = require('jsdoc/util/dumper').dump;
-const env = require('jsdoc/env');
-
-const conf = env.conf.eventDumper || {};
-
-// Dump the included parser events (defaults to all events)
-let events = conf.include || [
-    'parseBegin',
-    'fileBegin',
-    'beforeParse',
-    'jsdocCommentFound',
-    'symbolFound',
-    'newDoclet',
-    'fileComplete',
-    'parseComplete',
-    'processingComplete'
-];
-
-// Don't dump the excluded parser events
-if (conf.exclude) {
-    events = _.difference(events, conf.exclude);
-}
-
-/**
- * Replace AST node objects in events with a placeholder.
- *
- * @param {Object} o - An object whose properties may contain AST node objects.
- * @return {Object} The modified object.
- */
-function replaceNodeObjects(o) {
-    const OBJECT_PLACEHOLDER = '<Object>';
-
-    if (o.code && o.code.node) {
-        // don't break the original object!
-        o.code = doop(o.code);
-        o.code.node = OBJECT_PLACEHOLDER;
-    }
-
-    if (o.doclet && o.doclet.meta && o.doclet.meta.code && o.doclet.meta.code.node) {
-        // don't break the original object!
-        o.doclet.meta.code = doop(o.doclet.meta.code);
-        o.doclet.meta.code.node = OBJECT_PLACEHOLDER;
-    }
-
-    if (o.astnode) {
-        o.astnode = OBJECT_PLACEHOLDER;
-    }
-
-    return o;
-}
-
-/**
- * Get rid of unwanted crud in an event object.
- *
- * @param {object} e The event object.
- * @return {object} The fixed-up object.
- */
-function cleanse(e) {
-    let result = {};
-
-    Object.keys(e).forEach(prop => {
-        // by default, don't stringify properties that contain an array of functions
-        if (!conf.includeFunctions && _.isArray(e[prop]) && e[prop][0] &&
-            String(typeof e[prop][0]) === 'function') {
-            result[prop] = `function[${e[prop].length}]`;
-        }
-        // never include functions that belong to the object
-        else if (typeof e[prop] !== 'function') {
-            result[prop] = e[prop];
-        }
-    });
-
-    // allow users to omit node objects, which can be enormous
-    if (conf.omitNodes) {
-        result = replaceNodeObjects(result);
-    }
-
-    return result;
-}
-
-exports.handlers = {};
-
-events.forEach(eventType => {
-    exports.handlers[eventType] = e => {
-        console.log( dump({
-            type: eventType,
-            content: cleanse(e)
-        }) );
-    };
-});

package/docs/node_modules/jsdoc/plugins/markdown.js

@@ -1,88 +0,0 @@
-/**
- * Translate doclet descriptions from Markdown into HTML.
- *
- * @module plugins/markdown
- */
-const env = require('jsdoc/env');
-
-const config = env.conf.markdown || {};
-const defaultTags = [
-    'author',
-    'classdesc',
-    'description',
-    'exceptions',
-    'params',
-    'properties',
-    'returns',
-    'see',
-    'summary'
-];
-const hasOwnProp = Object.prototype.hasOwnProperty;
-const parse = require('jsdoc/util/markdown').getParser();
-let tags = [];
-let excludeTags = [];
-
-function shouldProcessString(tagName, text) {
-    let shouldProcess = true;
-
-    // we only want to process `@author` and `@see` tags that contain Markdown links
-    if ( (tagName === 'author' || tagName === 'see') && !text.includes('[') ) {
-        shouldProcess = false;
-    }
-
-    return shouldProcess;
-}
-
-/**
- * Process the markdown source in a doclet. The properties that should be processed are
- * configurable, but always include "author", "classdesc", "description", "exceptions", "params",
- * "properties",  "returns", and "see".  Handled properties can be bare strings, objects, or arrays
- * of objects.
- */
-function process(doclet) {
-    tags.forEach(tag => {
-        if ( !hasOwnProp.call(doclet, tag) ) {
-            return;
-        }
-
-        if (typeof doclet[tag] === 'string' && shouldProcessString(tag, doclet[tag]) ) {
-            doclet[tag] = parse(doclet[tag]);
-        }
-        else if ( Array.isArray(doclet[tag]) ) {
-            doclet[tag].forEach((value, index, original) => {
-                const inner = {};
-
-                inner[tag] = value;
-                process(inner);
-                original[index] = inner[tag];
-            });
-        }
-        else if (doclet[tag]) {
-            process(doclet[tag]);
-        }
-    });
-}
-
-// set up the list of "tags" (properties) to process
-if (config.tags) {
-    tags = config.tags.slice();
-}
-// set up the list of default tags to exclude from processing
-if (config.excludeTags) {
-    excludeTags = config.excludeTags.slice();
-}
-defaultTags.forEach(tag => {
-    if (!excludeTags.includes(tag) && !tags.includes(tag)) {
-        tags.push(tag);
-    }
-});
-
-exports.handlers = {
-    /**
-     * Translate Markdown syntax in a new doclet's description into HTML. Is run
-     * by JSDoc 3 whenever a "newDoclet" event fires.
-     */
-    newDoclet({doclet}) {
-        process(doclet);
-    }
-};

package/docs/node_modules/jsdoc/plugins/overloadHelper.js

@@ -1,181 +0,0 @@
-/**
- * The Overload Helper plugin automatically adds a signature-like string to the longnames of
- * overloaded functions and methods. In JSDoc, this string is known as a _variation_. (The longnames
- * of overloaded constructor functions are _not_ updated, so that JSDoc can identify the class'
- * members correctly.)
- *
- * Using this plugin allows you to link to overloaded functions without manually adding `@variation`
- * tags to your documentation.
- *
- * For example, suppose your code includes a function named `foo` that you can call in the
- * following ways:
- *
- * + `foo()`
- * + `foo(bar)`
- * + `foo(bar, baz)` (where `baz` is repeatable)
- *
- * This plugin assigns the following variations and longnames to each version of `foo`:
- *
- * + `foo()` gets the variation `()` and the longname `foo()`.
- * + `foo(bar)` gets the variation `(bar)` and the longname `foo(bar)`.
- * + `foo(bar, baz)` (where `baz` is repeatable) gets the variation `(bar, ...baz)` and the longname
- * `foo(bar, ...baz)`.
- *
- * You can then link to these functions with `{@link foo()}`, `{@link foo(bar)}`, and
- * `{@link foo(bar, ...baz)`. Note that the variation is based on the names of the function
- * parameters, _not_ their types.
- *
- * If you prefer to manually assign variations to certain functions, you can still do so with the
- * `@variation` tag. This plugin will not change these variations or add more variations for that
- * function, as long as the variations you've defined result in unique longnames.
- *
- * If an overloaded function includes multiple signatures with the same parameter names, the plugin
- * will assign numeric variations instead, starting at `(1)` and counting upwards.
- *
- * @module plugins/overloadHelper
- */
-// lookup table of function doclets by longname
-let functionDoclets;
-
-function hasUniqueValues(obj) {
-    let isUnique = true;
-    const seen = [];
-
-    Object.keys(obj).forEach(key => {
-        if (seen.includes(obj[key])) {
-            isUnique = false;
-        }
-
-        seen.push(obj[key]);
-    });
-
-    return isUnique;
-}
-
-function getParamNames(params) {
-    const names = [];
-
-    params.forEach(param => {
-        let name = param.name || '';
-
-        if (param.variable) {
-            name = `...${name}`;
-        }
-        if (name !== '') {
-            names.push(name);
-        }
-    });
-
-    return names.length ? names.join(', ') : '';
-}
-
-function getParamVariation({params}) {
-    return getParamNames(params || []);
-}
-
-function getUniqueVariations(doclets) {
-    let counter = 0;
-    const variations = {};
-    const docletKeys = Object.keys(doclets);
-
-    function getUniqueNumbers() {
-        docletKeys.forEach(doclet => {
-            let newLongname;
-
-            while (true) {
-                counter++;
-                variations[doclet] = String(counter);
-
-                // is this longname + variation unique?
-                newLongname = `${doclets[doclet].longname}(${variations[doclet]})`;
-                if ( !functionDoclets[newLongname] ) {
-                    break;
-                }
-            }
-        });
-    }
-
-    function getUniqueNames() {
-        // start by trying to preserve existing variations
-        docletKeys.forEach(doclet => {
-            variations[doclet] = doclets[doclet].variation || getParamVariation(doclets[doclet]);
-        });
-
-        // if they're identical, try again, without preserving existing variations
-        if ( !hasUniqueValues(variations) ) {
-            docletKeys.forEach(doclet => {
-                variations[doclet] = getParamVariation(doclets[doclet]);
-            });
-
-            // if they're STILL identical, switch to numeric variations
-            if ( !hasUniqueValues(variations) ) {
-                getUniqueNumbers();
-            }
-        }
-    }
-
-    // are we already using numeric variations? if so, keep doing that
-    if (functionDoclets[`${doclets.newDoclet.longname}(1)`]) {
-        getUniqueNumbers();
-    }
-    else {
-        getUniqueNames();
-    }
-
-    return variations;
-}
-
-function ensureUniqueLongname(newDoclet) {
-    const doclets = {
-        oldDoclet: functionDoclets[newDoclet.longname],
-        newDoclet: newDoclet
-    };
-    const docletKeys = Object.keys(doclets);
-    let oldDocletLongname;
-    let variations = {};
-
-    if (doclets.oldDoclet) {
-        oldDocletLongname = doclets.oldDoclet.longname;
-        // if the shared longname has a variation, like MyClass#myLongname(variation),
-        // remove the variation
-        if (doclets.oldDoclet.variation || doclets.oldDoclet.variation === '') {
-            docletKeys.forEach(doclet => {
-                doclets[doclet].longname = doclets[doclet].longname.replace(/\([\s\S]*\)$/, '');
-                doclets[doclet].variation = null;
-            });
-        }
-
-        variations = getUniqueVariations(doclets);
-
-        // update the longnames/variations
-        docletKeys.forEach(doclet => {
-            doclets[doclet].longname += `(${variations[doclet]})`;
-            doclets[doclet].variation = variations[doclet];
-        });
-
-        // update the old doclet in the lookup table
-        functionDoclets[oldDocletLongname] = null;
-        functionDoclets[doclets.oldDoclet.longname] = doclets.oldDoclet;
-    }
-
-    // always store the new doclet in the lookup table
-    functionDoclets[doclets.newDoclet.longname] = doclets.newDoclet;
-
-    return doclets.newDoclet;
-}
-
-exports.handlers = {
-    parseBegin() {
-        functionDoclets = {};
-    },
-
-    newDoclet(e) {
-        if (e.doclet.kind === 'function') {
-            e.doclet = ensureUniqueLongname(e.doclet);
-        }
-    },
-
-    parseComplete() {
-        functionDoclets = null;
-    }
-};

package/docs/node_modules/jsdoc/plugins/partial.js

@@ -1,30 +0,0 @@
-/**
- * Adds support for reusable partial jsdoc files.
- *
- * @module plugins/partial
- */
-const env = require('jsdoc/env');
-const fs = require('jsdoc/fs');
-const path = require('path');
-
-exports.handlers = {
-    /**
-     * Include a partial jsdoc
-     *
-     * @param e
-     * @param e.filename
-     * @param e.source
-     * @example
-     *     @partial "partial_doc.jsdoc"
-     */
-    beforeParse(e) {
-        e.source = e.source.replace(/(@partial ".*")+/g, $ => {
-            const pathArg = $.match(/".*"/)[0].replace(/"/g, '');
-            const fullPath = path.join(e.filename, '..', pathArg);
-
-            const partialData = fs.readFileSync(fullPath, env.opts.encoding);
-
-            return partialData;
-        });
-    }
-};

package/docs/node_modules/jsdoc/plugins/railsTemplate.js

@@ -1,19 +0,0 @@
-/**
- * Strips the rails template tags from a js.erb file
- *
- * @module plugins/railsTemplate
- */
-exports.handlers = {
-    /**
-     * Remove rails tags from the source input (e.g. <% foo bar %>)
-     *
-     * @param e
-     * @param e.filename
-     * @param e.source
-     */
-    beforeParse(e) {
-        if (e.filename.match(/\.erb$/)) {
-            e.source = e.source.replace(/<%.*%>/g, '');
-        }
-    }
-};

package/docs/node_modules/jsdoc/plugins/shout.js

@@ -1,15 +0,0 @@
-/**
- * This is just an example.
- *
- * @module plugins/shout
- */
-exports.handlers = {
-    /**
-     * Make your descriptions more shoutier.
-     */
-    newDoclet({doclet}) {
-        if (typeof doclet.description === 'string') {
-            doclet.description = doclet.description.toUpperCase();
-        }
-    }
-};

package/docs/node_modules/jsdoc/plugins/sourcetag.js

@@ -1,49 +0,0 @@
-/**
- * @module plugins/sourcetag
- */
-const logger = require('jsdoc/util/logger');
-
-exports.handlers = {
-    /**
-     * Support @source tag. Expected value like:
-     *
-     *     { "filename": "myfile.js", "lineno": 123 }
-     *
-     * Modifies the corresponding meta values on the given doclet.
-     *
-     * WARNING: If you are using a JSDoc template that generates pretty-printed source files,
-     * such as JSDoc's default template, this plugin can cause JSDoc to crash. To fix this issue,
-     * update your template settings to disable pretty-printed source files.
-     *
-     * @source { "filename": "sourcetag.js", "lineno": 9 }
-     */
-    newDoclet({doclet}) {
-        let tags = doclet.tags;
-        let tag;
-        let value;
-
-        // any user-defined tags in this doclet?
-        if (typeof tags !== 'undefined') {
-            // only interested in the @source tags
-            tags = tags.filter(({title}) => title === 'source');
-
-            if (tags.length) {
-                // take the first one
-                tag = tags[0];
-
-                try {
-                    value = JSON.parse(tag.value);
-                }
-                catch (ex) {
-                    logger.error('@source tag expects a valid JSON value, like { "filename": "myfile.js", "lineno": 123 }.');
-
-                    return;
-                }
-
-                doclet.meta = doclet.meta || {};
-                doclet.meta.filename = value.filename || '';
-                doclet.meta.lineno = value.lineno || '';
-            }
-        }
-    }
-};

package/docs/node_modules/jsdoc/plugins/summarize.js

@@ -1,58 +0,0 @@
-/**
- * This plugin creates a summary tag, if missing, from the first sentence in the description.
- *
- * @module plugins/summarize
- */
-exports.handlers = {
-    /**
-     * Autogenerate summaries, if missing, from the description, if present.
-     */
-    newDoclet({doclet}) {
-        let endTag;
-        let tags;
-        let stack;
-
-        // If the summary is missing, grab the first sentence from the description
-        // and use that.
-        if (doclet && !doclet.summary && doclet.description) {
-            // The summary may end with `.$`, `. `, or `.<` (a period followed by an HTML tag).
-            doclet.summary = doclet.description.split(/\.$|\.\s|\.</)[0];
-            // Append `.` as it was removed in both cases, or is possibly missing.
-            doclet.summary += '.';
-
-            // This is an excerpt of something that is possibly HTML.
-            // Balance it using a stack. Assume it was initially balanced.
-            tags = doclet.summary.match(/<[^>]+>/g) || [];
-            stack = [];
-
-            tags.forEach(tag => {
-                const idx = tag.indexOf('/');
-
-                if (idx === -1) {
-                    // start tag -- push onto the stack
-                    stack.push(tag);
-                } else if (idx === 1) {
-                    // end tag -- pop off of the stack
-                    stack.pop();
-                }
-
-                // otherwise, it's a self-closing tag; don't modify the stack
-            });
-
-            // stack should now contain only the start tags that lack end tags,
-            // with the most deeply nested start tag at the top
-            while (stack.length > 0) {
-                // pop the unmatched tag off the stack
-                endTag = stack.pop();
-                // get just the tag name
-                endTag = endTag.substring(1, endTag.search(/[ >]/));
-                // append the end tag
-                doclet.summary += `</${endTag}>`;
-            }
-
-            // and, finally, if the summary starts and ends with a <p> tag, remove it; let the
-            // template decide whether to wrap the summary in a <p> tag
-            doclet.summary = doclet.summary.replace(/^<p>(.*)<\/p>$/i, '$1');
-        }
-    }
-};