expand-tilde

What is expand-tilde?

The expand-tilde npm package is designed to expand the tilde (~) in file paths to the user's home directory. This is particularly useful in Node.js applications where you might need to access or specify paths relative to the user's home directory in a platform-independent way.

What are expand-tilde's main functionalities?

Expand tilde to home directory

This feature allows the expansion of the tilde (~) to the current user's home directory. In the code sample, '~/example' is expanded to the full path, such as '/Users/username/example' on macOS or Linux, and 'C:\Users\username\example' on Windows.

const expandTilde = require('expand-tilde');
console.log(expandTilde('~/example'));

Other packages similar to expand-tilde

untildify

Similar to expand-tilde, untildify converts a tilde path to an absolute path by expanding the tilde to the user's home directory. The main difference is in the implementation details and API design, but both serve the same purpose of tilde expansion.

os-homedir

While not directly offering tilde expansion, os-homedir provides a way to find the user's home directory across different platforms. It can be used in conjunction with other path manipulation methods to achieve similar outcomes as expand-tilde.

README

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.