|
|
@ -1,10 +1,10 @@ |
|
|
|
# get-root-module |
|
|
|
# this |
|
|
|
|
|
|
|
> Traverses up the directory tree and returns the first module found |
|
|
|
|
|
|
|
[![Build Status](https://travis-ci.org/lukechilds/get-root-module.svg?branch=master)](https://travis-ci.org/lukechilds/get-root-module) |
|
|
|
[![Coverage Status](https://coveralls.io/repos/github/lukechilds/get-root-module/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/get-root-module?branch=master) |
|
|
|
[![npm](https://img.shields.io/npm/v/get-root-module.svg)](https://www.npmjs.com/package/get-root-module) |
|
|
|
[![Build Status](https://travis-ci.org/lukechilds/this.svg?branch=master)](https://travis-ci.org/lukechilds/this) |
|
|
|
[![Coverage Status](https://coveralls.io/repos/github/lukechilds/this/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/this?branch=master) |
|
|
|
[![npm](https://img.shields.io/npm/v/this.svg)](https://www.npmjs.com/package/this) |
|
|
|
|
|
|
|
Useful in tests so you don't have to require the package you're testing via relative paths. |
|
|
|
|
|
|
@ -13,18 +13,18 @@ Starts directory traversal from `process.cwd()` so this should really only be us |
|
|
|
## Install |
|
|
|
|
|
|
|
```shell |
|
|
|
npm install --save get-root-module |
|
|
|
npm install --save this |
|
|
|
``` |
|
|
|
|
|
|
|
Or if using for tests you'll probably want: |
|
|
|
|
|
|
|
```shell |
|
|
|
npm install --save-dev get-root-module |
|
|
|
npm install --save-dev this |
|
|
|
``` |
|
|
|
|
|
|
|
## Usage |
|
|
|
|
|
|
|
Just require `get-root-module` the same way you would require the root module with a relative path. |
|
|
|
Just require `this` the same way you would require the root module with a relative path. |
|
|
|
|
|
|
|
e.g instead of: |
|
|
|
|
|
|
@ -40,17 +40,17 @@ You can now do: |
|
|
|
|
|
|
|
```js |
|
|
|
import test from 'ava'; |
|
|
|
import myPackage from 'get-root-module'; |
|
|
|
import myPackage from 'this'; |
|
|
|
|
|
|
|
// and then in sub folders it's still just: |
|
|
|
import myPackage from 'get-root-module'; |
|
|
|
import myPackage from 'this'; |
|
|
|
``` |
|
|
|
|
|
|
|
e.g without import transpilation: |
|
|
|
|
|
|
|
```js |
|
|
|
const test = require('tape'); |
|
|
|
const myPackage = require('get-root-module'); |
|
|
|
const myPackage = require('this'); |
|
|
|
``` |
|
|
|
|
|
|
|
## License |
|
|
|