This package has been deprecated

Author message:

No longer maintained

@jdes/env-cleaner

Environment Cleaner

Environment cleaner for Node.js and Mocha.
Can be used to clean process.env and require.cache between each tests.

Table of contents

• Setup
• Usage
• API
  • Methods
• Example

Setup

This module can then be installed with npm:

npm install @jdes/env-cleaner

Usage

Import module:

/**
 * @class {EnvCleaner}
 */
const EnvCleaner = require('@jdes/env-cleaner');

API

Methods

EnvCleaner.register(name: string): undefined

• name: Module's name or path

Register a module to clean.

Example:

const EnvCleaner = require('@jdes/env-cleaner');

EnvCleaner.register(require.resolve('../modules/module-one'));
EnvCleaner.register(require.resolve('../modules/module-two'));

EnvCleaner.clean(): undefined

Clean process.env and require.cache.

Example:

const EnvCleaner = require('@jdes/env-cleaner');

EnvCleaner.clean();

Example

This example comes from the index.js file of the @jdes/gpio module tests.
It cleans the cache before and after each Mocha test

// /test/index.js

const {before, beforeEach, afterEach} = require('mocha');
const EnvCleaner = require('@jdes/env-cleaner');

/* ********************************** */

before('Register modules to clean', () => {
  // Register the configuration file by default because it depends on process.env
  // which can be override by any test
  EnvCleaner.register(require.resolve('../lib/configuration/configuration'));
});

beforeEach('Clean require.cache', EnvCleaner.clean);
afterEach('Clean require.cache', EnvCleaner.clean);