unixify

Convert Windows file paths to unix paths.

Install

Install with npm:

1$ npm install --save unixify

Install with yarn:

1$ yarn add unixify

Usage

1var unixify = require('unixify');
2unixify(filepath[, stripTrailingSlash]);

Strips leading drive letters and dot-slash (./)

1unixify('.\\one\\two\\three');  //=> 'one/two/three'
2unixify('./one/two/three');     //=> 'one/two/three'
3unixify('C:\\one\\two\\three'); //=> '/one/two/three'
4unixify('\\one\\two\\three');   //=> '/one/two/three'

Normalizes path separators to forward slashes

1unixify('one\\two\\three');      //=> 'one/two/three'
2unixify('\\one\\two\\three');    //=> '/one/two/three'
3unixify('C:\\one\\two\\three');  //=> '/one/two/three'

Combines multiple consecutive slashes

1unixify('one//two//////three'),     //=> 'one/two/three'
2unixify('\\one\\two\\//three');     //=> '/one/two/three'
3unixify('C:\\//one\\two\\//three'); //=> '/one/two/three'

Strips trailing slashes by default

1unixify('one//two//////three//'), //=> 'one/two/three'
2unixify('C:\\one\\two\\three\\'); //=> '/one/two/three'

Keep trailing slashes

By passing false as the second argument

1unixify('one//two//////three//'), //=> 'one/two/three/'
2unixify('C:\\one\\two\\three\\'); //=> '/one/two/three/'

About

Related projects

• contains-path: Return true if a file path contains the given path. | homepage
• ends-with: Returns true if the given string or array ends with suffix using strict equality for… more | homepage
• is-absolute: Polyfill for node.js path.isAbolute. Returns true if a file path is absolute. | homepage
• normalize-path: Normalize file path slashes to be unix-like forward slashes. Also condenses repeat slashes to a… more | homepage
• path-ends-with: Return true if a file path ends with the given string/suffix. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

1$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

1$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.5.0, on April 14, 2017.