normalize-url 1.8.0 → 2.0.1

package/index.js

@@ -1,24 +1,23 @@
 'use strict';
-var url = require('url');
-var punycode = require('punycode');
-var queryString = require('query-string');
-var prependHttp = require('prepend-http');
-var sortKeys = require('sort-keys');
-var objectAssign = require('object-assign');
-
-var DEFAULT_PORTS = {
+const url = require('url');
+const punycode = require('punycode');
+const queryString = require('query-string');
+const prependHttp = require('prepend-http');
+const sortKeys = require('sort-keys');
+
+const DEFAULT_PORTS = {
 	'http:': 80,
 	'https:': 443,
 	'ftp:': 21
 };
 
-// protocols that always contain a `//`` bit
-var slashedProtocol = {
-	'http': true,
-	'https': true,
-	'ftp': true,
-	'gopher': true,
-	'file': true,
+// Protocols that always contain a `//`` bit
+const slashedProtocol = {
+	http: true,
+	https: true,
+	ftp: true,
+	gopher: true,
+	file: true,
 	'http:': true,
 	'https:': true,
 	'ftp:': true,
@@ -27,81 +26,84 @@ var slashedProtocol = {
 };
 
 function testParameter(name, filters) {
-	return filters.some(function (filter) {
-		return filter instanceof RegExp ? filter.test(name) : filter === name;
-	});
+	return filters.some(filter => filter instanceof RegExp ? filter.test(name) : filter === name);
 }
 
-module.exports = function (str, opts) {
-	opts = objectAssign({
+module.exports = (str, opts) => {
+	opts = Object.assign({
 		normalizeProtocol: true,
+		normalizeHttps: false,
 		stripFragment: true,
 		stripWWW: true,
 		removeQueryParameters: [/^utm_\w+/i],
 		removeTrailingSlash: true,
-		removeDirectoryIndex: false
+		removeDirectoryIndex: false,
+		sortQueryParameters: true
 	}, opts);
 
 	if (typeof str !== 'string') {
 		throw new TypeError('Expected a string');
 	}
 
-	var hasRelativeProtocol = str.indexOf('//') === 0;
+	const hasRelativeProtocol = str.startsWith('//');
 
-	// prepend protocol
+	// Prepend protocol
 	str = prependHttp(str.trim()).replace(/^\/\//, 'http://');
 
-	var urlObj = url.parse(str);
+	const urlObj = url.parse(str);
+
+	if (opts.normalizeHttps && urlObj.protocol === 'https:') {
+		urlObj.protocol = 'http:';
+	}
 
 	if (!urlObj.hostname && !urlObj.pathname) {
 		throw new Error('Invalid URL');
 	}
 
-	// prevent these from being used by `url.format`
+	// Prevent these from being used by `url.format`
 	delete urlObj.host;
 	delete urlObj.query;
 
-	// remove fragment
+	// Remove fragment
 	if (opts.stripFragment) {
 		delete urlObj.hash;
 	}
 
-	// remove default port
-	var port = DEFAULT_PORTS[urlObj.protocol];
+	// Remove default port
+	const port = DEFAULT_PORTS[urlObj.protocol];
 	if (Number(urlObj.port) === port) {
 		delete urlObj.port;
 	}
 
-	// remove duplicate slashes
+	// Remove duplicate slashes
 	if (urlObj.pathname) {
 		urlObj.pathname = urlObj.pathname.replace(/\/{2,}/g, '/');
 	}
 
-	// decode URI octets
+	// Decode URI octets
 	if (urlObj.pathname) {
 		urlObj.pathname = decodeURI(urlObj.pathname);
 	}
 
-	// remove directory index
+	// Remove directory index
 	if (opts.removeDirectoryIndex === true) {
 		opts.removeDirectoryIndex = [/^index\.[a-z]+$/];
 	}
 
-	if (Array.isArray(opts.removeDirectoryIndex) && opts.removeDirectoryIndex.length) {
-		var pathComponents = urlObj.pathname.split('/');
-		var lastComponent = pathComponents[pathComponents.length - 1];
+	if (Array.isArray(opts.removeDirectoryIndex) && opts.removeDirectoryIndex.length > 0) {
+		let pathComponents = urlObj.pathname.split('/');
+		const lastComponent = pathComponents[pathComponents.length - 1];
 
 		if (testParameter(lastComponent, opts.removeDirectoryIndex)) {
 			pathComponents = pathComponents.slice(0, pathComponents.length - 1);
+			urlObj.pathname = pathComponents.slice(1).join('/') + '/';
 		}
-
-		urlObj.pathname = pathComponents.slice(1).join('/') + '/';
 	}
 
-	// resolve relative paths, but only for slashed protocols
+	// Resolve relative paths, but only for slashed protocols
 	if (slashedProtocol[urlObj.protocol]) {
-		var domain = urlObj.protocol + '//' + urlObj.hostname;
-		var relative = url.resolve(domain, urlObj.pathname);
+		const domain = urlObj.protocol + '//' + urlObj.hostname;
+		const relative = url.resolve(domain, urlObj.pathname);
 		urlObj.pathname = relative.replace(domain, '');
 	}
 
@@ -109,46 +111,50 @@ module.exports = function (str, opts) {
 		// IDN to Unicode
 		urlObj.hostname = punycode.toUnicode(urlObj.hostname).toLowerCase();
 
-		// remove trailing dot
+		// Remove trailing dot
 		urlObj.hostname = urlObj.hostname.replace(/\.$/, '');
 
-		// remove `www.`
+		// Remove `www.`
 		if (opts.stripWWW) {
 			urlObj.hostname = urlObj.hostname.replace(/^www\./, '');
 		}
 	}
 
-	// remove URL with empty query string
+	// Remove URL with empty query string
 	if (urlObj.search === '?') {
 		delete urlObj.search;
 	}
 
-	var queryParameters = queryString.parse(urlObj.search);
+	const queryParameters = queryString.parse(urlObj.search);
 
-	// remove query unwanted parameters
+	// Remove query unwanted parameters
 	if (Array.isArray(opts.removeQueryParameters)) {
-		for (var key in queryParameters) {
+		for (const key in queryParameters) {
 			if (testParameter(key, opts.removeQueryParameters)) {
 				delete queryParameters[key];
 			}
 		}
 	}
 
-	// sort query parameters
-	urlObj.search = queryString.stringify(sortKeys(queryParameters));
+	// Sort query parameters
+	if (opts.sortQueryParameters) {
+		urlObj.search = queryString.stringify(sortKeys(queryParameters));
+	}
 
-	// decode query parameters
-	urlObj.search = decodeURIComponent(urlObj.search);
+	// Decode query parameters
+	if (urlObj.search !== null) {
+		urlObj.search = decodeURIComponent(urlObj.search);
+	}
 
-	// take advantage of many of the Node `url` normalizations
+	// Take advantage of many of the Node `url` normalizations
 	str = url.format(urlObj);
 
-	// remove ending `/`
+	// Remove ending `/`
 	if (opts.removeTrailingSlash || urlObj.pathname === '/') {
 		str = str.replace(/\/$/, '');
 	}
 
-	// restore relative protocol, if applicable
+	// Restore relative protocol, if applicable
 	if (hasRelativeProtocol && !opts.normalizeProtocol) {
 		str = str.replace(/^http:\/\//, '//');
 	}

package/license

@@ -1,21 +1,9 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "normalize-url",
-  "version": "1.8.0",
+  "version": "2.0.1",
   "description": "Normalize a URL",
   "license": "MIT",
   "repository": "sindresorhus/normalize-url",
@@ -24,12 +24,9 @@
     "uri",
     "address",
     "string",
-    "str",
-    "normalise",
     "normalization",
     "normalisation",
     "query",
-    "string",
     "querystring",
     "unicode",
     "simplify",
@@ -38,13 +35,12 @@
     "canonical"
   ],
   "dependencies": {
-    "object-assign": "^4.0.1",
-    "prepend-http": "^1.0.0",
-    "query-string": "^4.1.0",
-    "sort-keys": "^1.0.0"
+    "prepend-http": "^2.0.0",
+    "query-string": "^5.0.1",
+    "sort-keys": "^2.0.0"
   },
   "devDependencies": {
     "ava": "*",
-    "xo": "^0.16.0"
+    "xo": "*"
   }
 }

package/readme.md

@@ -1,6 +1,6 @@
 # normalize-url [![Build Status](https://travis-ci.org/sindresorhus/normalize-url.svg?branch=master)](https://travis-ci.org/sindresorhus/normalize-url)
 
-> [Normalize](http://en.wikipedia.org/wiki/URL_normalization) a URL
+> [Normalize](https://en.wikipedia.org/wiki/URL_normalization) a URL
 
 Useful when you need to display, store, deduplicate, sort, compare, etc, URLs.
 
@@ -8,7 +8,7 @@ Useful when you need to display, store, deduplicate, sort, compare, etc, URLs.
 ## Install
 
 ```
-$ npm install --save normalize-url
+$ npm install normalize-url
 ```
 
 
@@ -37,6 +37,8 @@ URL to normalize.
 
 #### options
 
+Type: `Object`
+
 ##### normalizeProtocol
 
 Type: `boolean`<br>
@@ -52,6 +54,21 @@ normalizeUrl('//sindresorhus.com:80/', {normalizeProtocol: false});
 //=> '//sindresorhus.com'
 ```
 
+##### normalizeHttps
+
+Type: `boolean`<br>
+Default: `false`
+
+Normalize `https:` URLs to `http:`.
+
+```js
+normalizeUrl('https://sindresorhus.com:80/');
+//=> 'https://sindresorhus.com'
+
+normalizeUrl('https://sindresorhus.com:80/', {normalizeHttps: true});
+//=> 'http://sindresorhus.com'
+```
+
 ##### stripFragment
 
 Type: `boolean`<br>
@@ -130,6 +147,20 @@ normalizeUrl('www.sindresorhus.com/foo/default.php', {
 //=> 'http://sindresorhus.com/foo'
 ```
 
+##### sortQueryParameters
+
+Type: `boolean`<br>
+Default: `true`
+
+Sort the query parameters alphabetically by key.
+
+```js
+normalizeUrl('www.sindresorhus.com?b=two&a=one&c=three', {
+	sortQueryParameters: false
+});
+//=> 'http://sindresorhus.com/?b=two&a=one&c=three'
+```
+
 
 ## Related