normalize-url 5.3.0 → 6.1.0

package/index.d.ts

@@ -103,6 +103,30 @@ declare namespace normalizeUrl {
 		*/
 		readonly stripProtocol?: boolean;
 
+		/**
+		Strip the [text fragment](https://web.dev/text-fragments/) part of the URL
+
+		__Note:__ The text fragment will always be removed if the `stripHash` option is set to `true`, as the hash contains the text fragment.
+
+		@default true
+
+		@example
+		```
+		normalizeUrl('http://sindresorhus.com/about.html#:~:text=hello');
+		//=> 'http://sindresorhus.com/about.html#'
+
+		normalizeUrl('http://sindresorhus.com/about.html#section:~:text=hello');
+		//=> 'http://sindresorhus.com/about.html#section'
+
+		normalizeUrl('http://sindresorhus.com/about.html#:~:text=hello', {stripTextFragment: false});
+		//=> 'http://sindresorhus.com/about.html#:~:text=hello'
+
+		normalizeUrl('http://sindresorhus.com/about.html#section:~:text=hello', {stripTextFragment: false});
+		//=> 'http://sindresorhus.com/about.html#section:~:text=hello'
+		```
+		*/
+		readonly stripTextFragment?: boolean;
+
 		/**
 		Removes `www.` from the URL.
 
@@ -131,8 +155,26 @@ declare namespace normalizeUrl {
 		});
 		//=> 'http://sindresorhus.com/?foo=bar'
 		```
+
+		If a boolean is provided, `true` will remove all the query parameters.
+
+		```
+		normalizeUrl('www.sindresorhus.com?foo=bar', {
+			removeQueryParameters: true
+		});
+		//=> 'http://sindresorhus.com'
+		```
+
+		`false` will not remove any query parameter.
+
+		```
+		normalizeUrl('www.sindresorhus.com?foo=bar&utm_medium=test&ref=test_ref', {
+			removeQueryParameters: false
+		});
+		//=> 'http://www.sindresorhus.com/?foo=bar&ref=test_ref&utm_medium=test'
+		```
 		*/
-		readonly removeQueryParameters?: ReadonlyArray<RegExp | string>;
+		readonly removeQueryParameters?: ReadonlyArray<RegExp | string> | boolean;
 
 		/**
 		Removes trailing slash.

package/index.js

@@ -9,7 +9,7 @@ const testParameter = (name, filters) => {
 };
 
 const normalizeDataURL = (urlString, {stripHash}) => {
-	const match = /^data:(?<type>.*?),(?<data>.*?)(?:#(?<hash>.*))?$/.exec(urlString);
+	const match = /^data:(?<type>[^,]*?),(?<data>[^#]*?)(?:#(?<hash>.*))?$/.exec(urlString);
 
 	if (!match) {
 		throw new Error(`Invalid URL: ${urlString}`);
@@ -67,6 +67,7 @@ const normalizeUrl = (urlString, options) => {
 		forceHttps: false,
 		stripAuthentication: true,
 		stripHash: false,
+		stripTextFragment: true,
 		stripWWW: true,
 		removeQueryParameters: [/^utm_\w+/i],
 		removeTrailingSlash: true,
@@ -118,6 +119,8 @@ const normalizeUrl = (urlString, options) => {
 	// Remove hash
 	if (options.stripHash) {
 		urlObj.hash = '';
+	} else if (options.stripTextFragment) {
+		urlObj.hash = urlObj.hash.replace(/#?:~:text.*?$/i, '');
 	}
 
 	// Remove duplicate slashes if not preceded by a protocol
@@ -170,6 +173,10 @@ const normalizeUrl = (urlString, options) => {
 		}
 	}
 
+	if (options.removeQueryParameters === true) {
+		urlObj.search = '';
+	}
+
 	// Sort query parameters
 	if (options.sortQueryParameters) {
 		urlObj.searchParams.sort();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "normalize-url",
-	"version": "5.3.0",
+	"version": "6.1.0",
 	"description": "Normalize a URL",
 	"license": "MIT",
 	"repository": "sindresorhus/normalize-url",
@@ -8,7 +8,7 @@
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
 	"engines": {
 		"node": ">=10"
@@ -37,9 +37,14 @@
 	],
 	"devDependencies": {
 		"ava": "^2.4.0",
-		"coveralls": "^3.0.6",
 		"nyc": "^15.0.0",
 		"tsd": "^0.11.0",
 		"xo": "^0.25.3"
+	},
+	"nyc": {
+		"reporter": [
+			"text",
+			"lcov"
+		]
 	}
 }

package/readme.md

@@ -1,4 +1,4 @@
-# normalize-url [![Build Status](https://travis-ci.org/sindresorhus/normalize-url.svg?branch=master)](https://travis-ci.org/sindresorhus/normalize-url) [![Coverage Status](https://coveralls.io/repos/github/sindresorhus/normalize-url/badge.svg?branch=master)](https://coveralls.io/github/sindresorhus/normalize-url?branch=master)
+# normalize-url [![Coverage Status](https://codecov.io/gh/sindresorhus/normalize-url/branch/main/graph/badge.svg)](https://codecov.io/gh/sindresorhus/normalize-url)
 
 > [Normalize](https://en.wikipedia.org/wiki/URL_normalization) a URL
 
@@ -135,6 +135,29 @@ normalizeUrl('https://sindresorhus.com', {stripProtocol: true});
 //=> 'sindresorhus.com'
 ```
 
+##### stripTextFragment
+
+Type: `boolean`\
+Default: `true`
+
+Strip the [text fragment](https://web.dev/text-fragments/) part of the URL.
+
+**Note:** The text fragment will always be removed if the `stripHash` option is set to `true`, as the hash contains the text fragment.
+
+```js
+normalizeUrl('http://sindresorhus.com/about.html#:~:text=hello');
+//=> 'http://sindresorhus.com/about.html#'
+
+normalizeUrl('http://sindresorhus.com/about.html#section:~:text=hello');
+//=> 'http://sindresorhus.com/about.html#section'
+
+normalizeUrl('http://sindresorhus.com/about.html#:~:text=hello', {stripTextFragment: false});
+//=> 'http://sindresorhus.com/about.html#:~:text=hello'
+
+normalizeUrl('http://sindresorhus.com/about.html#section:~:text=hello', {stripTextFragment: false});
+//=> 'http://sindresorhus.com/about.html#section:~:text=hello'
+```
+
 ##### stripWWW
 
 Type: `boolean`\
@@ -152,7 +175,7 @@ normalizeUrl('http://www.sindresorhus.com', {stripWWW: false});
 
 ##### removeQueryParameters
 
-Type: `Array<RegExp | string>`\
+Type: `Array<RegExp | string> | boolean`\
 Default: `[/^utm_\w+/i]`
 
 Remove query parameters that matches any of the provided strings or regexes.
@@ -164,6 +187,24 @@ normalizeUrl('www.sindresorhus.com?foo=bar&ref=test_ref', {
 //=> 'http://sindresorhus.com/?foo=bar'
 ```
 
+If a boolean is provided, `true` will remove all the query parameters.
+
+```js
+normalizeUrl('www.sindresorhus.com?foo=bar', {
+	removeQueryParameters: true
+});
+//=> 'http://sindresorhus.com'
+```
+
+`false` will not remove any query parameter.
+
+```js
+normalizeUrl('www.sindresorhus.com?foo=bar&utm_medium=test&ref=test_ref', {
+	removeQueryParameters: false
+});
+//=> 'http://www.sindresorhus.com/?foo=bar&ref=test_ref&utm_medium=test'
+```
+
 ##### removeTrailingSlash
 
 Type: `boolean`\
@@ -232,7 +273,6 @@ normalizeUrl('www.sindresorhus.com?b=two&a=one&c=three', {
 
 - [compare-urls](https://github.com/sindresorhus/compare-urls) - Compare URLs by first normalizing them
 
-
 ---
 
 <div align="center">