resolve-dependency-path

4.0.0 • Public • Published

resolve-dependency-path

CI npm version npm downloads

Convert a dependency path into a filepath

npm install resolve-dependency-path

Usage

const resolvePath = require('resolve-dependency-path');

const resolved = resolvePath({
  dependency: './foobar',
  filename: 'path/to/file/containing/dependency.js',
  directory: 'path/to/all/files'
});
  • dependency: the actual dependency path (probably extracted from a require())
  • filename: the file that required this dependency (likely the file whose dependencies are being extracted)
  • directory: the root of all modules being processed. Dependencies are often about this root unless they're relative.

Example

If you have a file like:

myapp/foo.js

var require('./bar');

Then if you want to open the file associated with the dependency, you need to resolve ./bar onto the filesystem.

Since ./bar is a relative path, it should be resolved relative to foo.js, more specifically the directory containing foo.js, myapp/. This resolution would yield myapp/bar.js.

This is why the filename attribute is required to use this library.

If you have a non-relative dependency path like:

myapp/foo.js

define([
  'bar'
], function(bar) {

});

Then bar is relative to the root of all files, myapp. The resolution would yield myapp/bar.js.

A more complex example with subdirectories:

myapp/feature1/foo.js

define([
  'feature2/bar'
], function(bar) {

});

The dependency feature2/bar is relative to the root of all files, myapp, not the file foo.js.

This is why the directory attribute is required to use this library.

License

MIT

Dependencies (0)

    Dev Dependencies (3)

    Package Sidebar

    Install

    npm i resolve-dependency-path

    Weekly Downloads

    697,603

    Version

    4.0.0

    License

    MIT

    Unpacked Size

    6.8 kB

    Total Files

    4

    Last publish

    Collaborators

    • pahen
    • xhmikosr
    • mrjoelkemp