unresolve

Guess an import identifier that might require.resolve() to the same file path but starts with a package name.

API

This module exports one function:

unresolve(path[, opt])

Expects path to be a traditional, mundane file system path of some file inside a node module. Returns a promise for a string that might be an import identifier that starts with a package name and would require.resolve() to path.

opt is an optional options object that supports these keys:

• srcFile: If non-empty, path is expected to be a relative path and will be resolved relative to the parent directory of opt.srcFile.

Usage

from test/usage.js:

1var self = require('../package.json').name, other = 'bluebird',
2  othMain = require.resolve(other),
3  othReadme = require.resolve(other + '/README.md'),
4  othDir = dirname(othReadme) + '/',
5  othSub = othMain.slice(othDir.length);
6
7thenEqual(unresolve(othMain),   other + '/' + othSub);
8thenEqual(unresolve(othReadme), other + '/README.md');
9thenEqual(unresolve(othDir),    other);
10
11thenEqual(unresolve(module.filename), self + '/test/usage.js');
12thenEqual(unresolve(dirname(module.filename)), self + '/test');
13thenEqual(unresolve('../', { srcFile: module.filename }), self);

Known issues

• Needs more/better tests and docs.

 

License

ISC