Nautilus: Pelagic Mollusc

    @webex/jsdoctrinetest

    1.161.0 • Public • Published

    @webex/jsdoctrinetest

    standard-readme compliant

    Mocha plugin which parses source code for doc blocks containing assertions and runs them as mocha specs.

    Install

    npm install --save @webex/jsdoctrinetest

    Usage

    Assuming your source code is in ./src and you've got code like

    /**
     * @example
     * fn();
     * //=> true
     * @returns {boolean}
     */
    exports.fn = function fn() {
      return true
    }

    The following command will create a run a mocha spec asserting the result of fn() is true.

    mocha -r @webex/jsdoctrinetest ./src

    Maintainers

    This package is maintained by Cisco Webex for Developers.

    Contribute

    Pull requests welcome. Please see CONTRIBUTING.md for more details.

    License

    © 2016-2020 Cisco and/or its affiliates. All Rights Reserved.

    Install

    npm i @webex/jsdoctrinetest

    DownloadsWeekly Downloads

    2,406

    Version

    1.161.0

    License

    MIT

    Unpacked Size

    40.3 kB

    Total Files

    21

    Last publish

    Collaborators

    • webex-jenkins
    • adamweeks
    • mattnorris