prebid.js 6.8.0 → 6.12.0

package/plugins/eslint/node_modules/istanbul/lib/command/common/run-with-cover.js

@@ -0,0 +1,261 @@
+/*
+ Copyright (c) 2012, Yahoo! Inc.  All rights reserved.
+ Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
+ */
+var Module = require('module'),
+    path = require('path'),
+    fs = require('fs'),
+    nopt = require('nopt'),
+    which = require('which'),
+    mkdirp = require('mkdirp'),
+    existsSync = fs.existsSync || path.existsSync,
+    inputError = require('../../util/input-error'),
+    matcherFor = require('../../util/file-matcher').matcherFor,
+    Instrumenter = require('../../instrumenter'),
+    Collector = require('../../collector'),
+    formatOption = require('../../util/help-formatter').formatOption,
+    hook = require('../../hook'),
+    Reporter = require('../../reporter'),
+    resolve = require('resolve'),
+    configuration = require('../../config');
+
+function usage(arg0, command) {
+
+    console.error('\nUsage: ' + arg0 + ' ' + command + ' [<options>] <executable-js-file-or-command> [-- <arguments-to-jsfile>]\n\nOptions are:\n\n'
+        + [
+            formatOption('--config <path-to-config>', 'the configuration file to use, defaults to .istanbul.yml'),
+            formatOption('--root <path> ', 'the root path to look for files to instrument, defaults to .'),
+            formatOption('-x <exclude-pattern> [-x <exclude-pattern>]', 'one or more fileset patterns e.g. "**/vendor/**"'),
+            formatOption('-i <include-pattern> [-i <include-pattern>]', 'one or more fileset patterns e.g. "**/*.js"'),
+            formatOption('--[no-]default-excludes', 'apply default excludes [ **/node_modules/**, **/test/**, **/tests/** ], defaults to true'),
+            formatOption('--hook-run-in-context', 'hook vm.runInThisContext in addition to require (supports RequireJS), defaults to false'),
+            formatOption('--post-require-hook <file> | <module>', 'JS module that exports a function for post-require processing'),
+            formatOption('--report <format> [--report <format>] ', 'report format, defaults to lcov (= lcov.info + HTML)'),
+            formatOption('--dir <report-dir>', 'report directory, defaults to ./coverage'),
+            formatOption('--print <type>', 'type of report to print to console, one of summary (default), detail, both or none'),
+            formatOption('--verbose, -v', 'verbose mode'),
+            formatOption('--[no-]preserve-comments', 'remove / preserve comments in the output, defaults to false'),
+            formatOption('--include-all-sources', 'instrument all unused sources after running tests, defaults to false'),
+            formatOption('--[no-]include-pid', 'include PID in output coverage filename')
+        ].join('\n\n') + '\n');
+    console.error('\n');
+}
+
+function run(args, commandName, enableHooks, callback) {
+
+    var template = {
+            config: path,
+            root: path,
+            x: [ Array, String ],
+            report: [Array, String ],
+            dir: path,
+            verbose: Boolean,
+            yui: Boolean,
+            'default-excludes': Boolean,
+            print: String,
+            'self-test': Boolean,
+            'hook-run-in-context': Boolean,
+            'post-require-hook': String,
+            'preserve-comments': Boolean,
+            'include-all-sources': Boolean,
+            'preload-sources': Boolean,
+            i: [ Array, String ],
+            'include-pid': Boolean
+        },
+        opts = nopt(template, { v : '--verbose' }, args, 0),
+        overrides = {
+            verbose: opts.verbose,
+            instrumentation: {
+                root: opts.root,
+                'default-excludes': opts['default-excludes'],
+                excludes: opts.x,
+                'include-all-sources': opts['include-all-sources'],
+                'preload-sources': opts['preload-sources'],
+                'include-pid': opts['include-pid']
+            },
+            reporting: {
+                reports: opts.report,
+                print: opts.print,
+                dir: opts.dir
+            },
+            hooks: {
+                'hook-run-in-context': opts['hook-run-in-context'],
+                'post-require-hook': opts['post-require-hook'],
+                'handle-sigint': opts['handle-sigint']
+            }
+        },
+        config = configuration.loadFile(opts.config, overrides),
+        verbose = config.verbose,
+        cmdAndArgs = opts.argv.remain,
+        preserveComments = opts['preserve-comments'],
+        includePid = opts['include-pid'],
+        cmd,
+        cmdArgs,
+        reportingDir,
+        reporter = new Reporter(config),
+        runFn,
+        excludes;
+
+    if (cmdAndArgs.length === 0) {
+        return callback(inputError.create('Need a filename argument for the ' + commandName + ' command!'));
+    }
+
+    cmd = cmdAndArgs.shift();
+    cmdArgs = cmdAndArgs;
+
+    if (!existsSync(cmd)) {
+        try {
+            cmd = which.sync(cmd);
+        } catch (ex) {
+            return callback(inputError.create('Unable to resolve file [' + cmd + ']'));
+        }
+    } else {
+        cmd = path.resolve(cmd);
+    }
+
+    runFn = function () {
+        process.argv = ["node", cmd].concat(cmdArgs);
+        if (verbose) {
+            console.log('Running: ' + process.argv.join(' '));
+        }
+        process.env.running_under_istanbul=1;
+        Module.runMain(cmd, null, true);
+    };
+
+    excludes = config.instrumentation.excludes(true);
+
+    if (enableHooks) {
+        reportingDir = path.resolve(config.reporting.dir());
+        mkdirp.sync(reportingDir); //ensure we fail early if we cannot do this
+        reporter.dir = reportingDir;
+        reporter.addAll(config.reporting.reports());
+        if (config.reporting.print() !== 'none') {
+            switch (config.reporting.print()) {
+            case 'detail':
+                reporter.add('text');
+                break;
+            case 'both':
+                reporter.add('text');
+                reporter.add('text-summary');
+                break;
+            default:
+                reporter.add('text-summary');
+                break;
+            }
+        }
+
+        excludes.push(path.relative(process.cwd(), path.join(reportingDir, '**', '*')));
+        matcherFor({
+            root: config.instrumentation.root() || process.cwd(),
+            includes: opts.i || config.instrumentation.extensions().map(function (ext) {
+                return '**/*' + ext;
+            }),
+            excludes: excludes
+        },
+            function (err, matchFn) {
+                if (err) { return callback(err); }
+
+                var coverageVar = '$$cov_' + new Date().getTime() + '$$',
+                    instrumenter = new Instrumenter({ coverageVariable: coverageVar , preserveComments: preserveComments}),
+                    transformer = instrumenter.instrumentSync.bind(instrumenter),
+                    hookOpts = { verbose: verbose, extensions: config.instrumentation.extensions() },
+                    postRequireHook = config.hooks.postRequireHook(),
+                    postLoadHookFile;
+
+                if (postRequireHook) {
+                    postLoadHookFile = path.resolve(postRequireHook);
+                } else if (opts.yui) { //EXPERIMENTAL code: do not rely on this in anyway until the docs say it is allowed
+                    postLoadHookFile = path.resolve(__dirname, '../../util/yui-load-hook');
+                }
+
+                if (postRequireHook) {
+                    if (!existsSync(postLoadHookFile)) { //assume it is a module name and resolve it
+                        try {
+                            postLoadHookFile = resolve.sync(postRequireHook, { basedir: process.cwd() });
+                        } catch (ex) {
+                            if (verbose) { console.error('Unable to resolve [' + postRequireHook + '] as a node module'); }
+                            callback(ex);
+                            return;
+                        }
+                    }
+                }
+                if (postLoadHookFile) {
+                    if (verbose) { console.error('Use post-load-hook: ' + postLoadHookFile); }
+                    hookOpts.postLoadHook = require(postLoadHookFile)(matchFn, transformer, verbose);
+                }
+
+                if (opts['self-test']) {
+                    hook.unloadRequireCache(matchFn);
+                }
+                // runInThisContext is used by RequireJS [issue #23]
+                if (config.hooks.hookRunInContext()) {
+                    hook.hookRunInThisContext(matchFn, transformer, hookOpts);
+                }
+                hook.hookRequire(matchFn, transformer, hookOpts);
+
+                //initialize the global variable to stop mocha from complaining about leaks
+                global[coverageVar] = {};
+
+                // enable passing --handle-sigint to write reports on SIGINT.
+                // This allows a user to manually kill a process while
+                // still getting the istanbul report.
+                if (config.hooks.handleSigint()) {
+                    process.once('SIGINT', process.exit);
+                }
+
+                process.once('exit', function () {
+                    var pidExt = includePid ? ('-' + process.pid) : '',
+                        file = path.resolve(reportingDir, 'coverage' + pidExt + '.json'),
+                        collector,
+                        cov;
+                    if (typeof global[coverageVar] === 'undefined' || Object.keys(global[coverageVar]).length === 0) {
+                        console.error('No coverage information was collected, exit without writing coverage information');
+                        return;
+                    } else {
+                        cov = global[coverageVar];
+                    }
+                    //important: there is no event loop at this point
+                    //everything that happens in this exit handler MUST be synchronous
+                    if (config.instrumentation.includeAllSources()) {
+                        // Files that are not touched by code ran by the test runner is manually instrumented, to
+                        // illustrate the missing coverage.
+                        matchFn.files.forEach(function (file) {
+                            if (!cov[file]) {
+                                transformer(fs.readFileSync(file, 'utf-8'), file);
+
+                                // When instrumenting the code, istanbul will give each FunctionDeclaration a value of 1 in coverState.s,
+                                // presumably to compensate for function hoisting. We need to reset this, as the function was not hoisted,
+                                // as it was never loaded.
+                                Object.keys(instrumenter.coverState.s).forEach(function (key) {
+                                    instrumenter.coverState.s[key] = 0;
+                                });
+
+                                cov[file] = instrumenter.coverState;
+                            }
+                        });
+                    }
+                    mkdirp.sync(reportingDir); //yes, do this again since some test runners could clean the dir initially created
+                    if (config.reporting.print() !== 'none') {
+                        console.error('=============================================================================');
+                        console.error('Writing coverage object [' + file + ']');
+                    }
+                    fs.writeFileSync(file, JSON.stringify(cov), 'utf8');
+                    collector = new Collector();
+                    collector.add(cov);
+                    if (config.reporting.print() !== 'none') {
+                        console.error('Writing coverage reports at [' + reportingDir + ']');
+                        console.error('=============================================================================');
+                    }
+                    reporter.write(collector, true, callback);
+                });
+                runFn();
+            });
+    } else {
+        runFn();
+    }
+}
+
+module.exports = {
+    run: run,
+    usage: usage
+};

package/plugins/eslint/node_modules/istanbul/lib/command/cover.js

@@ -0,0 +1,33 @@
+/*
+ Copyright (c) 2012, Yahoo! Inc.  All rights reserved.
+ Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
+ */
+
+var runWithCover = require('./common/run-with-cover'),
+    util = require('util'),
+    Command = require('./index');
+
+function CoverCommand() {
+    Command.call(this);
+}
+
+CoverCommand.TYPE = 'cover';
+util.inherits(CoverCommand, Command);
+
+Command.mix(CoverCommand, {
+    synopsis: function () {
+        return "transparently adds coverage information to a node command. Saves coverage.json and reports at the end of execution";
+    },
+
+    usage: function () {
+        runWithCover.usage(this.toolName(), this.type());
+    },
+
+    run: function (args, callback) {
+        runWithCover.run(args, this.type(), true, callback);
+    }
+});
+
+
+module.exports = CoverCommand;
+

package/plugins/eslint/node_modules/istanbul/lib/command/help.js

@@ -0,0 +1,102 @@
+/*
+ Copyright (c) 2012, Yahoo! Inc.  All rights reserved.
+ Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
+ */
+
+var Command = require('./index.js'),
+    util = require('util'),
+    formatOption = require('../util/help-formatter').formatOption,
+    VERSION = require('../../index').VERSION,
+    configuration = require('../config'),
+    yaml = require('js-yaml'),
+    formatPara = require('../util/help-formatter').formatPara;
+
+function showConfigHelp(toolName) {
+
+    console.error('\nConfiguring ' + toolName);
+    console.error('====================');
+    console.error('\n' +
+        formatPara(toolName + ' can be configured globally using a .istanbul.yml YAML file ' +
+            'at the root of your source tree. Every command also accepts a --config=<config-file> argument to ' +
+            'customize its location per command. The alternate config file can be in YAML, JSON or node.js ' +
+            '(exporting the config object).'));
+    console.error('\n' +
+        formatPara('The config file currently has four sections for instrumentation, reporting, hooks, ' +
+            'and checking. Note that certain commands (like `cover`) use information from multiple sections.'));
+    console.error('\n' +
+        formatPara('Keys in the config file usually correspond to command line parameters with the same name. ' +
+            'The verbose option for every command shows you the exact configuration used. See the api ' +
+            'docs for an explanation of each key.'));
+
+    console.error('\n' +
+        formatPara('You only need to specify the keys that you want to override. Your overrides will be merged ' +
+            'with the default config.'));
+    console.error('\nThe default configuration is as follows:\n');
+    console.error(yaml.safeDump(configuration.defaultConfig(), { indent: 4, flowLevel: 3 }));
+    console.error('\n' +
+        formatPara('The `watermarks` section does not have a command line equivalent. It allows you to set up ' +
+            'low and high watermark percentages for reporting. These are honored by all reporters that colorize ' +
+            'their output based on low/ medium/ high coverage.'));
+    console.error('\n' +
+        formatPara('The `reportConfig` section allows you to configure each report format independently ' +
+            'and has no command-line equivalent either.'));
+    console.error('\n' +
+        formatPara('The `check` section configures minimum threshold enforcement for coverage results. ' +
+            '`global` applies to all files together and `each` on a per-file basis. A list of files can ' +
+            'be excluded from enforcement relative to root via the `exclude` property.'));
+    console.error('');
+}
+
+function HelpCommand() {
+    Command.call(this);
+}
+
+HelpCommand.TYPE = 'help';
+util.inherits(HelpCommand, Command);
+
+Command.mix(HelpCommand, {
+    synopsis: function () {
+        return "shows help";
+    },
+
+    usage: function () {
+
+        console.error('\nUsage: ' + this.toolName() + ' ' + this.type() + ' config | <command>\n');
+        console.error('`config` provides help with istanbul configuration\n');
+        console.error('Available commands are:\n');
+
+        var commandObj;
+        Command.getCommandList().forEach(function (cmd) {
+            commandObj = Command.create(cmd);
+            console.error(formatOption(cmd, commandObj.synopsis()));
+            console.error("\n");
+        });
+        console.error("Command names can be abbreviated as long as the abbreviation is unambiguous");
+        console.error(this.toolName() + ' version:' + VERSION);
+        console.error("\n");
+    },
+    run: function (args, callback) {
+        var command;
+        if (args.length === 0) {
+            this.usage();
+        } else {
+            if (args[0] === 'config') {
+                showConfigHelp(this.toolName());
+            } else {
+                try {
+                    command = Command.create(args[0]);
+                    command.usage('istanbul', Command.resolveCommandName(args[0]));
+                } catch (ex) {
+                    console.error('Invalid command: ' + args[0]);
+                    this.usage();
+                }
+            }
+        }
+        return callback();
+    }
+});
+
+
+module.exports = HelpCommand;
+
+

package/plugins/eslint/node_modules/istanbul/lib/command/index.js

@@ -0,0 +1,33 @@
+/*
+ Copyright (c) 2012, Yahoo! Inc.  All rights reserved.
+ Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
+ */
+
+var Factory = require('../util/factory'),
+    factory = new Factory('command', __dirname, true);
+
+function Command() {}
+// add register, create, mix, loadAll, getCommandList, resolveCommandName to the Command object
+factory.bindClassMethods(Command);
+
+Command.prototype = {
+    toolName: function () {
+        return require('../util/meta').NAME;
+    },
+
+    type: function () {
+        return this.constructor.TYPE;
+    },
+    synopsis: /* istanbul ignore next: base method */ function () {
+        return "the developer has not written a one-line summary of the " + this.type() + " command";
+    },
+    usage: /* istanbul ignore next: base method */ function () {
+        console.error("the developer has not provided a usage for the " + this.type() + " command");
+    },
+    run: /* istanbul ignore next: abstract method */ function (args, callback) {
+        return callback(new Error("run: must be overridden for the " + this.type() + " command"));
+    }
+};
+
+module.exports = Command;
+