fix: re2 must be installed as a peerDependency to alleviate build issues

spamscanner · Jan 3, 2022 · 8414fdb · 8414fdb
1 parent a050a90
commit 8414fdb
Show file tree

Hide file tree

Showing 3 changed files with 3,215 additions and 3,666 deletions.
diff --git a/README.md b/README.md
@@ -38,16 +38,18 @@ This package should hopefully more closely resemble real-world intended usage of
 
 ## Install
 
+**NOTE:** As of v3.0.0 you must also install `re2` as a peer dependency.
+
 [npm][]:
 
 ```sh
-npm install url-regex-safe
+npm install url-regex-safe re2
 ```
 
 [yarn][]:
 
 ```sh
-yarn add url-regex-safe
+yarn add url-regex-safe re2
 ```
 
 
@@ -106,6 +108,7 @@ To use this package with [TypeScript](https://www.typescriptlang.org/), you can
 npm install --save-dev @types/url-regex-safe
 ```
 
+
 ## Options
 
 | Property         | Type    | Default Value                                                | Description                                                                                                                                                                                                                                                                                                                                                    |   |

diff --git a/package.json b/package.json
@@ -16,21 +16,21 @@
     "Diego Perini"
   ],
   "dependencies": {
-    "ip-regex": "^4.3.0",
-    "tlds": "^1.217.0"
+    "ip-regex": "4.3.0",
+    "tlds": "^1.228.0"
   },
   "peerDependencies": {
-    "re2": "^1.16.0"
+    "re2": "^1.17.2"
   },
   "peerDependenciesMeta": {
     "re2": {
       "optional": true
     }
   },
   "devDependencies": {
-    "@babel/cli": "^7.12.16",
-    "@babel/core": "^7.12.16",
-    "@babel/preset-env": "^7.12.16",
+    "@babel/cli": "^7.16.7",
+    "@babel/core": "^7.16.7",
+    "@babel/preset-env": "^7.16.7",
     "@commitlint/cli": "latest",
     "@commitlint/config-conventional": "latest",
     "ava": "latest",
@@ -40,13 +40,14 @@
     "cross-env": "latest",
     "eslint": "latest",
     "eslint-config-xo-lass": "latest",
-    "eslint-plugin-compat": "^3.9.0",
+    "eslint-plugin-compat": "^4.0.0",
     "eslint-plugin-node": "^11.1.0",
     "fixpack": "latest",
     "husky": "latest",
     "jsdom": "15",
     "lint-staged": "latest",
     "nyc": "latest",
+    "re2": "latest",
     "remark-cli": "latest",
     "remark-preset-github": "latest",
     "tinyify": "^3.0.0",