webext-patterns 1.4.0 → 1.5.0

package/index.d.ts

@@ -3,7 +3,8 @@ export declare const allStarsRegex: RegExp;
 export declare const allUrlsRegex: RegExp;
 export declare function assertValidPattern(matchPattern: string): void;
 export declare function isValidPattern(matchPattern: string): boolean;
-export declare function doesUrlMatchPatterns(url: string, ...matchPattern: string[]): boolean;
+export declare function doesUrlMatchPatterns(url: string, ...patterns: string[]): boolean;
+export declare function findMatchingPatterns(url: string, ...patterns: string[]): string[];
 export declare function patternToRegex(...matchPatterns: readonly string[]): RegExp;
 export declare function globToRegex(...globs: readonly string[]): RegExp;
 export declare function excludeDuplicatePatterns(matchPatterns: readonly string[]): string[];

package/index.js

@@ -8,26 +8,29 @@ export const allStarsRegex = isFirefox
 export const allUrlsRegex = /^(https?|file|ftp):[/]+/;
 export function assertValidPattern(matchPattern) {
     if (!isValidPattern(matchPattern)) {
-        throw new Error(matchPattern + ' is an invalid pattern, it must match ' + String(patternValidationRegex));
+        throw new Error(matchPattern + ' is an invalid pattern. See https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Match_patterns for more info.');
     }
 }
 export function isValidPattern(matchPattern) {
     return matchPattern === '<all_urls>' || patternValidationRegex.test(matchPattern);
 }
-export function doesUrlMatchPatterns(url, ...matchPattern) {
-    if (matchPattern.includes('<all_urls>') && allUrlsRegex.test(url)) {
+export function doesUrlMatchPatterns(url, ...patterns) {
+    if (patterns.includes('<all_urls>') && allUrlsRegex.test(url)) {
         return true;
     }
-    if (matchPattern.includes('*://*/*') && allStarsRegex.test(url)) {
+    if (patterns.includes('*://*/*') && allStarsRegex.test(url)) {
         return true;
     }
-    for (const pattern of matchPattern) {
+    for (const pattern of patterns) {
         if (patternToRegex(pattern).test(url)) {
             return true;
         }
     }
     return false;
 }
+export function findMatchingPatterns(url, ...patterns) {
+    return patterns.filter(pattern => doesUrlMatchPatterns(url, pattern));
+}
 function getRawPatternRegex(matchPattern) {
     assertValidPattern(matchPattern);
     // Host undefined for file:///
@@ -38,12 +41,10 @@ function getRawPatternRegex(matchPattern) {
     if (host === '*') {
         host = '[^/]+';
     }
-    else if (host) {
-        host = host
-            .replace(/^[*][.]/, '([^/]+.)*') // Initial wildcard
-            .replaceAll(/[.]/g, '[.]') // Escape dots
-            .replace(/[*]$/, '[^.]+'); // Last wildcard
-    }
+    host &&= host
+        .replace(/^[*][.]/, '([^/]+.)*') // Initial wildcard
+        .replaceAll(/[.]/g, '[.]') // Escape dots
+        .replace(/[*]$/, '[^.]+'); // Last wildcard
     pathname = pathname
         .replaceAll(/[/]/g, '[/]') // Escape slashes
         .replaceAll(/[.]/g, '[.]') // Escape dots

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "webext-patterns",
-	"version": "1.4.0",
+	"version": "1.5.0",
 	"description": "Tool to convert the patterns and globs of your WebExtension manifest to regex",
 	"keywords": [
 		"browser",
@@ -49,12 +49,12 @@
 	},
 	"devDependencies": {
 		"@sindresorhus/tsconfig": "^5.0.0",
-		"@types/chrome": "0.0.256",
-		"ava": "^6.0.1",
-		"sinon": "^17.0.1",
-		"type-fest": "^4.9.0",
-		"typescript": "^5.3.3",
-		"xo": "^0.56.0"
+		"@types/chrome": "0.0.268",
+		"ava": "^6.1.3",
+		"sinon": "^18.0.0",
+		"type-fest": "^4.20.0",
+		"typescript": "^5.4.5",
+		"xo": "^0.58.0"
 	},
 	"engines": {
 		"node": ">=18"

package/readme.md

@@ -3,9 +3,7 @@
 [badge-gzip]: https://img.shields.io/bundlephobia/minzip/webext-patterns.svg?label=gzipped
 [link-bundlephobia]: https://bundlephobia.com/result?p=webext-patterns
 
-> Tool to convert the [patterns](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/content_scripts#globs) of your WebExtension manifest to regex
-
-This might be incomplete. Please help me test it by adding more pattern and URLs to the [tests](./test.js).
+> Utilities for [patterns](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/content_scripts#matching_url_patterns) and globs for WebExtensions
 
 ## Install
 
@@ -18,7 +16,6 @@ npm install webext-patterns
 ```
 
 ```js
-// This module is only offered as a ES Module
 import {
 	patternToRegex,
 	globToRegex,
@@ -118,10 +115,14 @@ excludeDuplicatePatterns([
 Accepts a URL and any number of patterns and returns `true` if the URL matches any of the patterns. This is a convenience method that wraps `patternToRegex` for single use. If you plan on testing multiple URLs to the same pattern, it's better to convert the patterns to a regex once and reuse that.
 
 ```js
-doesUrlMatchPatterns('https://google.com/', ['https://*.google.com/*', '*://example.com/*']);
+doesUrlMatchPatterns('https://google.com/', 'https://*.google.com/*', '*://example.com/*');
 // Returns true
 ```
 
+#### findMatchingPatterns(url, ...patterns)
+
+Accepts a URL and any number of patterns and returns an array of the patterns that match the URL. It returns an empty array if none of the patterns match the URL.
+
 #### assertValidPattern(pattern)
 
 Accepts a pattern and throws an error if it's invalid.
@@ -142,19 +143,12 @@ isValidPattern('https://google.*/*');
 
 ## Related
 
-### Permissions
-
-- [webext-additional-permissions](https://github.com/fregante/webext-additional-permissions) - Get any optional permissions that users have granted you.
-- [webext-dynamic-content-scripts](https://github.com/fregante/webext-dynamic-content-scripts) - Automatically registers your content_scripts on domains added via permission.request
-
-### Others
-
-- [webext-options-sync](https://github.com/fregante/webext-options-sync) - Helps you manage and autosave your extension's options. Chrome and Firefox.
-- [webext-storage-cache](https://github.com/fregante/webext-storage-cache) - Map-like promised cache storage with expiration. Chrome and Firefox
-- [webext-detect-page](https://github.com/fregante/webext-detect-page) - Detects where the current browser extension code is being run. Chrome and Firefox.
-- [webext-content-script-ping](https://github.com/fregante/webext-content-script-ping) - One-file interface to detect whether your content script have loaded.
-- [web-ext-submit](https://github.com/fregante/web-ext-submit) - Wrapper around Mozilla’s web-ext to submit extensions to AMO.
+- [webext-permissions](https://github.com/fregante/webext-permissions) - Get any optional permissions that users have granted you.
+- [webext-options-sync](https://github.com/fregante/webext-options-sync) - Helps you manage and autosave your extension's options.
+- [webext-storage-cache](https://github.com/fregante/webext-storage-cache) - Map-like promised cache storage with expiration.
+- [webext-detect-page](https://github.com/fregante/webext-detect-page) - Detects where the current browser extension code is being run.
 - [Awesome-WebExtensions](https://github.com/fregante/Awesome-WebExtensions) - A curated list of awesome resources for WebExtensions development.
+- [More…](https://github.com/fregante/webext-fun)
 
 ## License