333

schangxiang@126.com

2025-09-19 18966e02fb573c7e2bb0c6426ed792b38b910940

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# parent-require
 
[![Build](https://travis-ci.org/jaredhanson/node-parent-require.png)](http://travis-ci.org/jaredhanson/node-parent-require)
[![Coverage](https://coveralls.io/repos/jaredhanson/node-parent-require/badge.png)](https://coveralls.io/r/jaredhanson/node-parent-require)
[![Dependencies](https://david-dm.org/jaredhanson/node-parent-require.png)](http://david-dm.org/jaredhanson/node-parent-require)
 
 
Require modules from parent (i.e. loading) module.
 
## Install
 
    $ npm install parent-require
 
## Usage
 
`parent-require` addresses an annoying error condition that arises when
developing plugins, which have [peer dependencies](http://blog.nodejs.org/2013/02/07/peer-dependencies/),
that are `npm link`'d into an application.
 
The problem is best illustrated by example.  We'll use a shared package of [Mongoose](http://mongoosejs.com/)
schemas, but the concept applies equally well to any module you plugin to a
larger framework.
 
#### Develop a Plugin for a Framework
 
Let's develop a set of shared [Mongoose](http://mongoosejs.com/) schemas for a
user database, packaged as `mongoose-schemas-users` for reuse by any application
that needs to query the database.
 
```javascript
var mongoose = require('mongoose');
 
var UserSchema = new mongoose.Schema(...);
 
module.exports = UserSchema;
```
 
The important bit here is that `mongoose` is a *peer dependency* of this
package.
 
#### Require a Plugin from an App
 
Now, let's install this package...
 
    npm install mongoose-schemas-users
 
..and require it within our application:
 
```javascript
var mongoose = require('mongoose')
  , schemas = require('mongoose-schemas-users')
  
mongoose.model('User', schemas.UserSchema);
```
 
So far, so good.
 
#### npm link Plugin for Development
 
During the course of developing the application, we discover that we need to
tweak the schemas we've defined.  This is usually easy:
 
    npm link mongoose-schemas-users
 
We've made some edits, and run the application:
 
    Error: Cannot find module 'mongoose'
 
WTF?!?  This issue arises because `mongoose` is a *peer dependency*.  Now that
it has been `npm link`'d to a directory that resides outside of the application
itself, Node's typical resolution algorithm fails to find it.
 
#### Fallback to Parent Require
 
This is where `parent-require` comes into play.  It provides a fallback to
`require` modules from the *loading* (aka parent) module.  Because the loading
module exists within the application itself, Node's resolution algorithm will
correctly find our peer dependency.
 
```javascript
try {
  var mongoose = require('mongoose');
} catch (_) {
  // workaround when `npm link`'ed for development
  var prequire = require('parent-require')
    , mongoose = prequire('mongoose');
}
 
var UserSchema = new mongoose.Schema(...);
 
module.exports = UserSchema;
```
 
With the fallback in place, we can both `npm install` and `npm link` this
plugin, correctly resolving peer dependencies in both cases.
 
## Tests
 
    $ npm install
    $ npm test
 
## Credits
 
  - [Jared Hanson](http://github.com/jaredhanson)
 
## License
 
[The MIT License](http://opensource.org/licenses/MIT)
 
Copyright (c) 2013 Jared Hanson <[http://jaredhanson.net/](http://jaredhanson.net/)>