Socket
Socket
Sign inDemoInstall

normalize-path

Package Overview
Dependencies
0
Maintainers
3
Versions
11
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

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.


Version published
Maintainers
3
Weekly downloads
44,897,133
decreased by-17.73%
Install size
9.95 kB

Weekly downloads

Package description

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

Readme

Source

normalize-path NPM version NPM monthly downloads NPM total downloads Linux Build Status

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

Other useful path-related libraries:

Contributors

CommitsContributor
35jonschlinkert
1phated

Author

Jon Schlinkert

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.

Keywords

FAQs

Last updated on 19 Apr 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc