Have ideas to improve npm?Join in the discussion! »

babel-rewire-wrapper

1.0.3 • Public • Published

Wrapper of babel-plugin-rewire

Build Status Dependency Status devDependency Status

This is a wrapper to use babel-plugin-rewire more easily.

Usage

For example, let's rewire the dependencies of this sample module.

/* loggingReader.js */
 
import fs from 'fs';
import logger from './logger';
 
export default {
  readFile(filePath) {
    logger.log(`Read ${filePath}`);
    return fs.readFileSync(filePath);
  }
}

Without babel-rewire-wrapper

import reader from './loggingReader';
 
reader.__Rewire__('fs', {
  readFileSync: filePath => `Content of ${filePath}.`
});
reader.__Rewire__('logger', {
  log: () => {}
});
 
assert.equal(reader.readFile(filePath), `Content of ${filePath}.`);
 
reader.__ResetDependency__('fs');
reader.__ResetDependency__('logger');

With babel-rewire-wrapper

import reader from './loggingReader';
import rewire from 'babel-rewire-wrapper';
 
rewire()
  .use(reader, {
    fs: {
      readFileSync: filePath => `Content of ${filePath}.`
    },
    logger: {
      log: () => {}
    }
  })
  .run(() => {
    // While running this callback, all dependencies are rewired.
    assert.equal(reader.readFile(filePath), `Content of ${filePath}.`)
  });
 
  // After the running, all dependencies are reset.

When you pass a callback to run() method, rewire() injects mocks and run the callback. All dependencies will be reset automatically after the running (even if some error occurred).

Rewire several modules

You can chain use() methods.

rewire()
  .use(reader, {
    fs: {
      readFileSync: filePath => `Content of ${filePath}.`
    },
    logger: {
      log: () => {}
    }
  })
  .use(greeter, {
    greet: () => 'Hi'
  })
  .run(() => {
    assert.equal(reader.readFile(filePath), `Content of ${filePath}.`);
    assert.equal(greeter.greet(), 'Hi');
  });

Run async function

When running an async function, you have to return Promise so that the dependencies will be reset correctly after running.

import reader from './loggingReader';
import rewire from 'babel-rewire-wrapper';
 
rewire()
  .use(reader, {
    fs: {
      readFileSync: filePath => `Content of ${filePath}.`
    },
    logger: {
      log: () => {}
    }
  })
  .run(() => {
    return fetchFilePath()
      .then(filePath => {
        assert.equal(reader.readFile(filePath), `Content of ${filePath}.`)
      });
  })
  .then(...);

Call rewiring methods separately

You can also inject mocks and reset dependencies explicitly. Following is an example used with mocha.

...
 
context('with mocha test', () => {
  let rewirer;
 
  before(() => {
    const fs = createMockFs();
    const logger = createMockLogger();
    rewirer = rewire().use(reader, { fs, logger });
    rewirer.rewire();
  });
 
  after(() => {
    rewirer.resetDependencies();
  });
 
  it('can inject mocks', () => {
    assert.equal(reader.readFile('some.file'), 'Expected value');
  });
});

Install

npm i babel-rewire-wrapper

DownloadsWeekly Downloads

311

Version

1.0.3

License

MIT

Last publish

Collaborators

  • avatar