normalize-path

What is normalize-path?

The normalize-path npm package is designed to normalize file paths, making them consistent across different operating systems and environments. It can be particularly useful for handling file paths in a cross-platform manner, ensuring that paths are correctly formatted and can be reliably compared or manipulated regardless of the underlying OS.

What are normalize-path's main functionalities?

Normalize slashes

Converts Windows backslash paths to POSIX forward slashes, making paths consistent across different environments.

"const normalize = require('normalize-path');
console.log(normalize('C:\\path\\to\\file')); // 'C:/path/to/file'"

Remove trailing slashes

Optionally removes trailing slashes from paths, which can be useful for comparing directory paths or constructing URLs.

"const normalize = require('normalize-path');
console.log(normalize('path/to/resource/', false)); // 'path/to/resource'"

Normalize for use in URLs

Cleans up the path by resolving dot segments (e.g., '..' and '.') to produce a canonical path. This is particularly useful for creating clean URLs.

"const normalize = require('normalize-path');
console.log(normalize('/foo/bar//baz/asdf/quux/..')); // '/foo/bar/baz/asdf'"

Other packages similar to normalize-path

path

The 'path' module is a core Node.js module that provides utilities for working with file and directory paths. It offers similar normalization functionalities but is built into Node.js, meaning it doesn't require an additional installation. Unlike normalize-path, it handles paths differently based on the operating system.

upath

upath is an extension of Node.js's path module that normalizes paths to always use forward slashes, similar to normalize-path. It also adds filename and extension manipulation functions. upath provides a broader set of path manipulation utilities while maintaining cross-platform consistency.

README

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, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save normalize-path

Usage

const normalize = require('normalize-path');

console.log(normalize('\\foo\\bar\\baz\\')); 
//=> '/foo/bar/baz'

win32 namespaces

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.

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:

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 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

Contributing

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

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:

$ npm install && npm test

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:

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

Related projects

Other useful path-related libraries:

• contains-path: Return true if a file path contains the given path. | homepage
• is-absolute: Returns true if a file path is absolute. Does not rely on the path module… more | homepage
• is-relative: Returns true if the path appears to be relative. | homepage
• parse-filepath: Pollyfill for node.js path.parse, parses a filepath into an object. | homepage
• path-ends-with: Return true if a file path ends with the given string/suffix. | homepage
• unixify: Convert Windows file paths to unix paths. | homepage

Contributors

Commits	Contributor
35	jonschlinkert
1	phated

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

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

This file was generated by verb-generate-readme, v0.6.0, on April 19, 2018.

Changelog

[3.0.0]

No breaking changes.

Added

• Ensuring that win32 namespaces has two leading slashes, so that the path is handled properly by the win32 version of path.parse() after being normalized.
• Making sure a single forward slash is returned in cases like: "\", "/" in spite of the above change.
• Other various testing

Changed

• Various updates to tooling
• Benchmark refactors

Removed

• Removed the remove-trailing-separator dependency