Nougat Predominant Middleware

    This package has been deprecated

    Author message:

    This package is no longer maintained. If you would like to use the functionality offered by this package, please consider publishing a fork of this package under your own npm scope.

    @hutson/nyc-config

    2.0.2 • Public • Published

    @hutson/nyc-config

    Standard nyc configuration as used by projects maintained by Hutson Betts (@hutson).

    Configuration package for the nyc code instrumentation tool using its support for loading configuration from an npm package.

    Table of Contents

    Features

    • [x] Instrument only files in the src/ directory ending in .js, except src/cli.js, or those ending in .spec.js or .mocks.js.
    • [x] For those files that can be instrumented, instrument all of them for code coverage even if they haven't been required in a test.
    • [x] Cache instrumented files for better test performance.
    • [x] Write an lcov formatted report to disk, and print a text summary to the console.

    Installation

    To install the @hutson/nyc-config configuration package for use in your project please run the following command:

    yarn add --dev @hutson/nyc-config

    Usage

    There are two ways to use this configuration package in your project.

    The first way to use this package is to include a top-level nyc property in your project's package.json file that extends this package:

    {
      "nyc": {
        "extends": "@hutson/nyc-config"
      }
    }

    Another way is to extend this package in a top-level .nycrc file:

    {
      "extends": "@hutson/nyc-config"
    }

    Node Support Policy

    We only support Long-Term Support versions of Node.

    We specifically limit our support to LTS versions of Node, not because this package won't work on other versions, but because we have a limited amount of time, and supporting LTS offers the greatest return on that investment.

    It's possible this package will work correctly on newer versions of Node. It may even be possible to use this package on older versions of Node, though that's more unlikely as we'll make every effort to take advantage of features available in the oldest LTS version we support.

    As each Node LTS version reaches its end-of-life we will remove that version from the node engines property of our package's package.json file. Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package. We will not accept any requests to support an end-of-life version of Node. Any merge requests or issues supporting an end-of-life version of Node will be closed.

    We will accept code that allows this package to run on newer, non-LTS, versions of Node. Furthermore, we will attempt to ensure our own changes work on the latest version of Node. To help in that commitment, our continuous integration setup runs against all LTS versions of Node in addition the most recent Node release; called current.

    JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our node engines property. If you encounter issues installing this package, please report the issue to your package manager.

    Contributing

    Please read our contributing guide to see how you may contribute to this project.

    Install

    npm i @hutson/nyc-config

    DownloadsWeekly Downloads

    10

    Version

    2.0.2

    License

    Apache-2.0

    Unpacked Size

    16.7 kB

    Total Files

    4

    Last publish

    Collaborators

    • hutson