Jest Helpers

These are files that are used to help with Jest tests.

jest.config.cjs

The jest config is the global jest config file, this file is imported into the jest.config.cjs in the root of the project repo and serves as the base for all jest configs.

This can be overwritten via putting a jest.config.cjs file in your current package. The most likely time that this will need to happen is for test coverage percentage changes, or for testing a server side only package etc where the config is expected to be different.

Coverage

By default the global coverage threshold has been set at 100%, this can be addressed on a case by case basis if it needs to be lowered because of untestable code, however the preferred method is to write testable code.

To overwrite coverage for a particular module or file, you should place a jest.config.cjs file in the modules root folder, add this package (@plug-and-play/base-component-jest-helpers) as a dev dependency, and then spread the config and update the specific file thresholds as needed.

E.g

const jestConfig = require('@plug-and-play/base-component-jest-helpers');

module.exports = {
    ...jestConfig,
    coverageThreshold: {
        './src': {
            branches: 0,
            functions: 0,
            lines: 0,
            statements: 0,
        },
    },
};