jonschlinkert / expand-tilde

Bash-like tilde expansion for node.js. Expands a leading tilde in a file path to the user home directory, or `~+` to the cwd.

expand-tilde

Bash-like tilde expansion for node.js. Expands a leading tilde in a file path to the user home directory, or ~+ to the cwd.

Install

Install with npm:

$ npm install --save expand-tilde

Usage

See the Bash documentation for Tilde Expansion.

var expandTilde = require('expand-tilde');

expandTilde('~')
//=> '/Users/jonschlinkert'

expandTilde('~+')
//=> process.cwd()

Run tests

Install dev dependencies:

npm i -d && npm test

About

Related projects

• braces: Fast, comprehensive, bash-like brace expansion implemented in JavaScript. Complete support for the Bash 4.3 braces… more | homepage
• expand-brackets: Expand POSIX bracket expressions (character classes) in glob patterns. | homepage
• is-glob: Returns true if the given string looks like a glob pattern or an extglob pattern… more | homepage
• micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | 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

• github/jonschlinkert
• twitter/jonschlinkert

License

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

---

This file was generated by verb-generate-readme, v0.2.0, on December 08, 2016.

expand-tilde's Issues

Publish TypeScript types for this package

I'm about to submit a PR to DefinitelyTyped that will define TypeScript types for this package. This issue will auto-close when that PR is accepted, after which TypeScript users of this package will be able to install the types the "usual" way, npm i -S expand-tilde @types/expand-tilde. No further action is required on your part. This issue is mostly just a heads-up FYI.

Please tag 1.2.2 release

Please tag the 1.2.2 release that corresponds with the 1.2.2 tarball on registry.npmjs.com.

broken for node < v.2.3.0

The package.json lists '"engines": { "node": ">=0.10.0" }', yet uses a method os.homedir() that doesn't exist in 0.10.x or 0.12.x; in fact the node.js API documentation says "Added in: v2.3.0".
Recommended support module: os-homedir