resolve-file

resolve-file

Resolve an absolute file path from local directories, local node_modules or global node_modules.

Install

Install with npm:

$ npm install --save resolve-file

Usage

var resolveFile = require('resolve-file');

API

resolve

Resolve the path to a file located in one of the following places:

• local to the current project ('./index.js')
• absolute ('/usr/something.rc')
• node module "main" file ('cwd')
• specific file inside a node module ('cwd/LICENSE')
• file located in user's home directory ('~/.npmrc')

Params

• name {String}: Filename to resolve
• options {Object}: Additional options to specify cwd
• returns {String}: Resolved filepath if found

Example

var fp = resolve('./index.js')
//=> /path/to/resolve-file/index.js

.file

Resolve the path to a file located in one of the following places:

• local to the current project ('./index.js')
• absolute ('/usr/something.rc')
• node module "main" file ('cwd')
• specific file inside a node module ('cwd/LICENSE')
• file located in user's home directory ('~/.npmrc')

Params

• name {String}: Filename to resolve
• options {Object}: Additional options to specify cwd
• returns {Object}: File object with resolved path if found.

Example

var file = resolve.file('./index.js')
//=> {
//=>   cwd: '/path/to/resolve-file',
//=>   path: '/path/to/resolve-file/index.js'
//=> }

About

Related projects

• cwd: Easily get the CWD (current working directory) of a project based on package.json, optionally starting… more | homepage
• expand-tilde: Bash-like tilde expansion for node.js. Expands a leading tilde in a file path to the… more | homepage
• look-up: Faster drop-in replacement for find-up and findup-sync. | homepage
• resolve: resolve like require.resolve() on behalf of files asynchronously and synchronously | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2016, Brian Woodward. Released under the MIT license.

---

This file was generated by verb, v0.9.0, on August 17, 2016.