# package-root

> Generate paths relative to your package's source root

Latest version **0.9.2** (published 2015-11-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install package-root
pnpm add package-root
yarn add package-root
bun add package-root
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.2 |
| Published | 2015-11-05 |
| First published | 2015-08-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Brian Lauber |
| Maintainers | briandamaged |
| Keywords | path |

## Links

- npm: https://www.npmjs.com/package/package-root
- Repository: https://github.com/briandamaged/package-root
- Homepage: https://github.com/briandamaged/package-root#readme
- Issues: https://github.com/briandamaged/package-root/issues
- npm.io page: https://npm.io/package/package-root

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^3.10.1
- [stack-trace](https://npm.io/package/stack-trace.md) 0.0.9

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 0.9.2 (latest) — 2015-11-05
- 0.9.1 — 2015-08-26
- 0.9.0 — 2015-08-26
- 0.8.0 — 2015-08-26
- 0.1.0 — 2015-08-26

## README

# package-root #

Is your application or package suffering from relative-path Hell?  Do your ```require``` statements look like the following?

```javascript
var config           = require("../../../config"           );
var middleware       = require("../../../lib/middleware"   );
var users_controller = require("../../../controllers/users");
```

Don't worry -- ```package-root``` is here to help!  With ```package-root```, you can generate package-relative paths with ease!

```javascript
var pr = require('package-root');

var config           = pr("config");
var middleware       = pr("lib/middleware");
var users_controller = pr("controllers/users");
```

There -- I bet you feel better already!


## Installation ##

```shell
npm install package-root
```


## Usage ##

### Setup ###

```package-root``` discovers your package's root by searching for a file named ```__package_root```.  For example, let's imagine that our application / package is structured as follows:

```
.
├── package.json
└── src
    ├── config.json
    ├── controllers
    │   ├── index.js
    │   └── users.js
    └── mw
        ├── auth.js
        └── index.js
```

Since the package's code lives in the ```src/``` folder, we'll want to place the ```___package_root``` file there.  Afterwards, the filesystem will look like this:

```
.
├── package.json
└── src
    ├── config.json
    ├── controllers
    │   ├── index.js
    │   └── users.js
    ├── mw
    │   ├── auth.js
    │   └── index.js
    └── __package_root
```

### Package-relative require statements ###

Now that you've planted the ```__package_root``` file in the appropriate location, you can perform package-relative ```require```s as follows:

```javascript
var pr = require('package-root');

// Path is relative to src/
var config = pr("config");
```

### Package-relative path joins ###

Of course, maybe you just want to obtain the path to some file in your package.  You can achieve this by using the ```join``` function:

```javascript
var pr = require('package-root');

// Generate the path to the package's config.json file
var config_path = pr.join("config.json");
```

Just like ```path.join```, ```package-root```'s ```join``` function can accept a variable number of arguments:

```javascript
var users_controller_path = pr.join("controllers", "users.js");
```

Pretty simple, huh?

---
_Source: https://npm.io/package/package-root · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._