cjs-module

CJS (Node.js) style modules resolver

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
cjs-module
1.5.05 years ago9 years agoMinified + gzip package size for cjs-module in KB

Readme

!Build statusnix-build-imagenix-build-url !Windows statuswin-build-imagewin-build-url !Transpilation statustranspilation-image !npm versionnpm-imagenpm-url
cjs-module

CJS (Node.js) modules resolver

Environment agnostic CJS (Node.js) modules resolver.
It implements a strict version of Node.js modules resolution logic, differences are as follows:
  • Loading from global folders is not supported
  • Only Unix path separators (/) are supported in require's path arguments (Background: even though Node.js internally seems to follow Windows path separator in Windows environment, it won't work in \*nix environments, and even in Window env it's not reliable so by all means should be avoided)
  • There's no awareness of node.js core modules
e.g. `resolve(dir, 'fs')` will naturally result with _null_

Installation

$ npm install cjs-module

API

getResolver(extensions, confirmFile, resolvePackageMain)

For provided configuration, returns a CJS modules resolver:
  • extensions - List of supported file extensions in order of singificance, e.g. for Node.js it would be ['.js', '.json', '.node']
  • confirmFile - a confirmFile(filepath) function. Confirms whether there's a module at provided (not normalized, absolute) file path. Returns promise-like object which resolves with either normalized full path of a module or null (if there's no module for given path).
Although result is expected to be a promise-like object, resolution can be synchronous.
  • resolvePackageMain - a resolvePackageMain(dirpath) function. Returns value of package.json's main property for given path. Returns promise-like object which resolves with either resolved value, or null, when either package.json file was not found, or it didn't have main property.
Same as with `confirmFile` resolution can be synchronous.

resolve(dir, path)

Node.js resolver
Asynchronously resolves module path against provided directory path. Returns promise. If no matching module was found, promise resolves with null otherwise full module path becomes a resolved value.
var resolve = require("cjs-module/resolve");

// Asynchronously resolve path for 'foo' module against current path
resolve(__dirname, "foo").done(function(fooModulePath) {
	if (!fooModulePath) {
		// 'foo' module doesn't exist
	} else {
		// 'foo' module found at fooModulePath
	}
});

resolveSync(dir, path)

Node.js resolver
Synchronously resolves module path against provided directory path. If matching module was found then full module path is returned, otherwise null.
var resolveSync = require("cjs-module/resolve/sync");

// Synchronously resolve path for 'foo' module against current path
var fooModulePath = resolveSync(__dirname, "foo");
if (!fooModulePath) {
	// 'foo' module doesn't exist
} else {
	// 'foo' module found
}

isPackageRoot(dirPath)

Whether provided path is a root of a package
var isPackageRoot = require("cjs-module/is-package-root");

isPackageRoot(dirPath).done(function(isRoot) {
	if (isRoot) {
		// Provided path is package root
	}
});

resolvePackageRoot(dirPath)

Resolve package root path for provided path. It is about resolution of first upper package root
var resolvePackageRoot = require("cjs-module/resolve-package-root");

resolvePackageRoot(dirPath).done(function(root) {
	if (!root) {
		// Provided path is not located in any package
	}
});

resolveProjectRoot(dirPath)

Resolve project root path for provided path. It is about resolution of topmost package root for given path
var resolveProjectRoot = require("cjs-module/resolve-project-root");

resolveProjectRoot(dirPath).done(function(root) {
	if (!root) {
		// Provided path is not located in any project
	}
});

getDependecies(modulePath)

Resolve all module dependencies. Returns promise that resolves with an array of paths, that includes path to input module and paths to all its dependencies (it includes deep dependencies, so also dependencies of the dependencies)
var getDependencies = require("cjs-module/get-dependencies");

getDependencies(modulePath).done(function(deps) {
	console.log(deps); // e.g. [pathToModulePath, pathToDep1, pathToDep2, ...pathToDepn]
});

Tests Build Status

$ npm test