Skip to content
Resolve a directory that is either local, global or in the user's home directory.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig
.eslintrc.json
.gitattributes
.gitignore
.travis.yml
.verb.md
LICENSE
README.md
appveyor.yml
index.js
package.json
test.js

README.md

resolve-dir NPM version NPM downloads Linux Build Status

Resolve a directory that is either local, global or in the user's home directory.

Install

Install with npm:

$ npm install --save resolve-dir

Usage

var resolve = require('resolve-dir');

Returns a local directory path unchanged

resolve('a')
//=> 'a'

Resolves the path to user home

resolve('~')
//=> '/Users/jonschlinkert'
resolve('~/foo')
//=> '/Users/jonschlinkert/foo'

Resolves the path to global npm modules

resolve('@')
//=> '/usr/local/lib/node_modules'
resolve('@/foo')
//=> '/usr/local/lib/node_modules/foo'

About

Related projects

  • expand-tilde: Bash-like tilde expansion for node.js. Expands a leading tilde in a file path to the… more | homepage
  • findup-sync: Find the first file matching a given pattern in the current directory or the nearest… more | homepage
  • resolve-modules: Resolves local and global npm modules that match specified patterns, and returns a configuration object… more | 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

Jon Schlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.


This file was generated by verb-generate-readme, v0.2.0, on October 18, 2016.

You can’t perform that action at this time.