tilde-path

Resolve a path into an absolute path, using tilde (~) if possible

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
tilde-path
003.0.04 years ago6 years agoMinified + gzip package size for tilde-path in KB

Readme

tilde-path
NPM version Build Status Build status Coverage Status
Resolve a path into an absolute path, using tilde (~) if possible
// On /Users/shinnn/project
const tildePath = require('tilde-path');

tildePath('foo'); //=> '~/project/foo'
tildePath('foo/bar'); //=> '~/project/foo/bar'
tildePath('../'); //=> '~'

Installation

Use npm.
npm install tilde-path

API

const tildePath = require('tilde-path');

tildePath(path)

path: string
Return: string
On a non-Windows environment,
  1. Resolves a given path into an absolute path if it's relative
  2. Replaces the home directory path with ~

On Windows, it just calls path.win32.resolve because Windows doesn't support tilde home path.
// On POSIX
tildePath('my/dir'); //=> '~/my/dir'

// On Windows
tildePath('my/dir'); //=> 'C:\\Users\\shinnn\\my\\dir'

License

ISC License © 2018 Shinnosuke Watanabe