Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

hidepath

jviotti46.6kMIT1.0.1

Get the hidden equivalent of a file path

hide, hidden, file, path

readme

hidepath

Get the hidden equivalent of a file path.

npm version dependencies Build Status Build status

Installation

Install hidepath by running:

$ npm install --save hidepath

Documentation

hidepath~hidepath(file) ⇒ String

This function prepends . or _, on Unix and Windows respectively to the passed file path.

Kind: inner method of hidepath
Summary: Get the hidden equivalent of a file path
Returns: String - hidden equivalent file path
Access: public

Param Type Description
file String file path

Example

var hidepath = require('hidepath');
console.log(hidepath('/home/jviotti/vimrc'));
> /home/jviotti/.vimrc

Support

If you're having any problem, please raise an issue on GitHub and I'll be happy to help.

Tests

Run the test suite by doing:

$ gulp test

Contribute

Before submitting a PR, please make sure that you include tests, and that jshint runs without any warning:

$ npm run lint

License

The project is licensed under the MIT license.

changelog

Change Log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.