requirable/README.md

# requireable

> Enables a module to require itself by name in tests

[![Build Status](https://travis-ci.org/lukechilds/requireable.svg?branch=master)](https://travis-ci.org/lukechilds/requireable)
[![Coverage Status](https://coveralls.io/repos/github/lukechilds/requireable/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/requireable?branch=master)
[![npm](https://img.shields.io/npm/v/requireable.svg)](https://www.npmjs.com/package/requireable)

Mocks the require command to include the current package when the `name` from the current `package.json` is required.

Uses `process.cwd()` to find the current `package.json` so this is only meant to be used as a dev dependency for testing. This will not work on a published package!

## Install

```shell
npm install --save-dev requireable
```

## Usage

```js
require('requirable');
```

That's it! `require` has now been patched and you can now do `require('package-name')`.

## AVA Usage

Some tests runners such as AVA can require packages automatically for you. If you're using AVA add the following to your package.json:

```json
"ava": {
  "require": [
    "requireable"
  ]
},
 ```

 You can now `require` your package in your AVA tests.

## License

MIT © Luke Childs