| # normalize-path [](https://www.npmjs.com/package/normalize-path) [](https://npmjs.org/package/normalize-path) [](https://npmjs.org/package/normalize-path) [](https://travis-ci.org/jonschlinkert/normalize-path) |
| |
| > Normalize slashes in a file path to be posix/unix-like forward slashes. Also condenses repeat slashes to a single slash and removes and trailing slashes, unless disabled. |
| |
| Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. |
| |
| ## Install |
| |
| Install with [npm](https://www.npmjs.com/): |
| |
| ```sh |
| $ npm install --save normalize-path |
| ``` |
| |
| ## Usage |
| |
| ```js |
| const normalize = require('normalize-path'); |
| |
| console.log(normalize('\\foo\\bar\\baz\\')); |
| //=> '/foo/bar/baz' |
| ``` |
| |
| **win32 namespaces** |
| |
| ```js |
| console.log(normalize('\\\\?\\UNC\\Server01\\user\\docs\\Letter.txt')); |
| //=> '//?/UNC/Server01/user/docs/Letter.txt' |
| |
| console.log(normalize('\\\\.\\CdRomX')); |
| //=> '//./CdRomX' |
| ``` |
| |
| **Consecutive slashes** |
| |
| Condenses multiple consecutive forward slashes (except for leading slashes in win32 namespaces) to a single slash. |
| |
| ```js |
| console.log(normalize('.//foo//bar///////baz/')); |
| //=> './foo/bar/baz' |
| ``` |
| |
| ### Trailing slashes |
| |
| By default trailing slashes are removed. Pass `false` as the last argument to disable this behavior and _**keep** trailing slashes_: |
| |
| ```js |
| console.log(normalize('foo\\bar\\baz\\', false)); //=> 'foo/bar/baz/' |
| console.log(normalize('./foo/bar/baz/', false)); //=> './foo/bar/baz/' |
| ``` |
| |
| ## Release history |
| |
| ### v3.0 |
| |
| No breaking changes in this release. |
| |
| * a check was added to ensure that [win32 namespaces](https://msdn.microsoft.com/library/windows/desktop/aa365247(v=vs.85).aspx#namespaces) are handled properly by win32 `path.parse()` after a path has been normalized by this library. |
| * a minor optimization was made to simplify how the trailing separator was handled |
| |
| ## About |
| |
| <details> |
| <summary><strong>Contributing</strong></summary> |
| |
| Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). |
| |
| </details> |
| |
| <details> |
| <summary><strong>Running Tests</strong></summary> |
| |
| 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: |
| |
| ```sh |
| $ npm install && npm test |
| ``` |
| |
| </details> |
| |
| <details> |
| <summary><strong>Building docs</strong></summary> |
| |
| _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ |
| |
| To generate the readme, run the following command: |
| |
| ```sh |
| $ npm install -g verbose/verb#dev verb-generate-readme && verb |
| ``` |
| |
| </details> |
| |
| ### Related projects |
| |
| Other useful path-related libraries: |
| |
| * [contains-path](https://www.npmjs.com/package/contains-path): Return true if a file path contains the given path. | [homepage](https://github.com/jonschlinkert/contains-path "Return true if a file path contains the given path.") |
| * [is-absolute](https://www.npmjs.com/package/is-absolute): Returns true if a file path is absolute. Does not rely on the path module… [more](https://github.com/jonschlinkert/is-absolute) | [homepage](https://github.com/jonschlinkert/is-absolute "Returns true if a file path is absolute. Does not rely on the path module and can be used as a polyfill for node.js native `path.isAbolute`.") |
| * [is-relative](https://www.npmjs.com/package/is-relative): Returns `true` if the path appears to be relative. | [homepage](https://github.com/jonschlinkert/is-relative "Returns `true` if the path appears to be relative.") |
| * [parse-filepath](https://www.npmjs.com/package/parse-filepath): Pollyfill for node.js `path.parse`, parses a filepath into an object. | [homepage](https://github.com/jonschlinkert/parse-filepath "Pollyfill for node.js `path.parse`, parses a filepath into an object.") |
| * [path-ends-with](https://www.npmjs.com/package/path-ends-with): Return `true` if a file path ends with the given string/suffix. | [homepage](https://github.com/jonschlinkert/path-ends-with "Return `true` if a file path ends with the given string/suffix.") |
| * [unixify](https://www.npmjs.com/package/unixify): Convert Windows file paths to unix paths. | [homepage](https://github.com/jonschlinkert/unixify "Convert Windows file paths to unix paths.") |
| |
| ### Contributors |
| |
| | **Commits** | **Contributor** | |
| | --- | --- | |
| | 35 | [jonschlinkert](https://github.com/jonschlinkert) | |
| | 1 | [phated](https://github.com/phated) | |
| |
| ### Author |
| |
| **Jon Schlinkert** |
| |
| * [LinkedIn Profile](https://linkedin.com/in/jonschlinkert) |
| * [GitHub Profile](https://github.com/jonschlinkert) |
| * [Twitter Profile](https://twitter.com/jonschlinkert) |
| |
| ### License |
| |
| Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert). |
| Released under the [MIT License](LICENSE). |
| |
| *** |
| |
| _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on April 19, 2018._ |