# hidepath

> Get the hidden equivalent of a file path

Latest version **1.0.1** (published 2017-08-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install hidepath
pnpm add hidepath
yarn add hidepath
bun add hidepath
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-08-07 |
| First published | 2016-03-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Juan Cruz Viotti |
| Maintainers | jviotti |
| Keywords | hide, hidden, file, path |

## Links

- npm: https://www.npmjs.com/package/hidepath
- Repository: https://github.com/jviotti/hidepath
- Issues: https://github.com/jviotti/hidepath/issues
- npm.io page: https://npm.io/package/hidepath

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2017-08-07
- 1.0.0 — 2016-03-28

## README

hidepath
========

> Get the hidden equivalent of a file path.

[![npm version](https://badge.fury.io/js/hidepath.svg)](http://badge.fury.io/js/hidepath)
[![dependencies](https://david-dm.org/jviotti/hidepath.svg)](https://david-dm.org/jviotti/hidepath.svg)
[![Build Status](https://travis-ci.org/jviotti/hidepath.svg?branch=master)](https://travis-ci.org/jviotti/hidepath)
[![Build status](https://ci.appveyor.com/api/projects/status/p5ofmqoxeyq7j7nf/branch/master?svg=true)](https://ci.appveyor.com/project/jviotti/hidepath/branch/master)

Installation
------------

Install `hidepath` by running:

```sh
$ npm install --save hidepath
```

Documentation
-------------

<a name="module_hidepath..hidepath"></a>

### hidepath~hidepath(file) ⇒ <code>String</code>
This function prepends `.` or `_`, on Unix and
Windows respectively to the passed file path.

**Kind**: inner method of <code>[hidepath](#module_hidepath)</code>  
**Summary**: Get the hidden equivalent of a file path  
**Returns**: <code>String</code> - hidden equivalent file path  
**Access:** public  

| Param | Type | Description |
| --- | --- | --- |
| file | <code>String</code> | file path |

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

Support
-------

If you're having any problem, please [raise an issue](https://github.com/jviotti/hidepath/issues/new) on GitHub and I'll be happy to help.

Tests
-----

Run the test suite by doing:

```sh
$ gulp test
```

Contribute
----------

- Issue Tracker: [github.com/jviotti/hidepath/issues](https://github.com/jviotti/hidepath/issues)
- Source Code: [github.com/jviotti/hidepath](https://github.com/jviotti/hidepath)

Before submitting a PR, please make sure that you include tests, and that [jshint](http://jshint.com) runs without any warning:

```sh
$ npm run lint
```

License
-------

The project is licensed under the MIT license.

---
_Source: https://npm.io/package/hidepath · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._