Docs 📝 .

Author: IonicaBizau

DOCUMENTATION.md

@@ -2,3 +2,32 @@
 
 You can see below the API reference of this module.
 
+### `parseUrl(url, normalize)`
+Parses the input url.
+
+**Note**: This *throws* if invalid urls are provided.
+
+#### Params
+
+- **String** `url`: The input url.
+- **Boolean|Object** `normalize`: Whether to normalize the url or not.                         Default is `false`. If `true`, the url will
+                        be normalized. If an object, it will be the
+                        options object sent to [`normalize-url`](https://github.com/sindresorhus/normalize-url).
+
+                        For SSH urls, normalize won't work.
+
+#### Return
+- **Object** An object containing the following fields:
+   - `protocols` (Array): An array with the url protocols (usually it has one element).
+   - `protocol` (String): The first protocol, `"ssh"` (if the url is a ssh url) or `"file"`.
+   - `port` (String): The domain port.
+   - `resource` (String): The url domain (including subdomains).
+   - `host` (String):  The fully qualified domain name of a network host, or its IP address.
+   - `user` (String): The authentication user (usually for ssh urls).
+   - `pathname` (String): The url pathname.
+   - `hash` (String): The url hash.
+   - `search` (String): The url querystring value.
+   - `href` (String): The input url.
+   - `query` (Object): The url querystring, parsed as object.
+   - `parse_failed` (Boolean): Whether the parsing failed or not.
+

README.md

@@ -36,7 +36,7 @@
 
 
 
-For low-level path parsing, check out [`parse-path`](https://github.com/IonicaBizau/parse-path). This very module is designed to parse urls. By default the urls are normalized.
+For low-level path parsing, check out [`parse-path`](https://github.com/IonicaBizau/parse-path). This very module is designed to parse urls.
 
 
 
@@ -151,6 +151,40 @@ console.log(parseUrl("git@github.com:IonicaBizau/git-stats.git", false))
 
 
 
+## :memo: Documentation
+
+
+### `parseUrl(url, normalize)`
+Parses the input url.
+
+**Note**: This *throws* if invalid urls are provided.
+
+#### Params
+
+- **String** `url`: The input url.
+- **Boolean|Object** `normalize`: Whether to normalize the url or not.                         Default is `false`. If `true`, the url will
+                        be normalized. If an object, it will be the
+                        options object sent to [`normalize-url`](https://github.com/sindresorhus/normalize-url).
+
+                        For SSH urls, normalize won't work.
+
+#### Return
+- **Object** An object containing the following fields:
+   - `protocols` (Array): An array with the url protocols (usually it has one element).
+   - `protocol` (String): The first protocol, `"ssh"` (if the url is a ssh url) or `"file"`.
+   - `port` (String): The domain port.
+   - `resource` (String): The url domain (including subdomains).
+   - `host` (String):  The fully qualified domain name of a network host, or its IP address.
+   - `user` (String): The authentication user (usually for ssh urls).
+   - `pathname` (String): The url pathname.
+   - `hash` (String): The url hash.
+   - `search` (String): The url querystring value.
+   - `href` (String): The input url.
+   - `query` (Object): The url querystring, parsed as object.
+   - `parse_failed` (Boolean): Whether the parsing failed or not.
+
+
+
 
 
 

dist/index.js

@@ -195,6 +195,37 @@ function normalizeUrl(urlString, options) {
   return urlString;
 }
 
+/**
+ * parseUrl
+ * Parses the input url.
+ *
+ * **Note**: This *throws* if invalid urls are provided.
+ *
+ * @name parseUrl
+ * @function
+ * @param {String} url The input url.
+ * @param {Boolean|Object} normalize Whether to normalize the url or not.
+ *                         Default is `false`. If `true`, the url will
+ *                         be normalized. If an object, it will be the
+ *                         options object sent to [`normalize-url`](https://github.com/sindresorhus/normalize-url).
+ *
+ *                         For SSH urls, normalize won't work.
+ *
+ * @return {Object} An object containing the following fields:
+ *
+ *    - `protocols` (Array): An array with the url protocols (usually it has one element).
+ *    - `protocol` (String): The first protocol, `"ssh"` (if the url is a ssh url) or `"file"`.
+ *    - `port` (String): The domain port.
+ *    - `resource` (String): The url domain (including subdomains).
+ *    - `host` (String):  The fully qualified domain name of a network host, or its IP address.
+ *    - `user` (String): The authentication user (usually for ssh urls).
+ *    - `pathname` (String): The url pathname.
+ *    - `hash` (String): The url hash.
+ *    - `search` (String): The url querystring value.
+ *    - `href` (String): The input url.
+ *    - `query` (Object): The url querystring, parsed as object.
+ *    - `parse_failed` (Boolean): Whether the parsing failed or not.
+ */
 const parseUrl = (url, normalize = false) => {
   const GIT_RE = /^(?:([a-zA-Z_][a-zA-Z0-9_-]{0,31})@|https?:\/\/)([\w\.\-@]+)[\/:](([\~,\.\w,\-,\_,\/,\s]|%[0-9A-Fa-f]{2})+?(?:\.git|\/)?)$/;
   const throwErr = (msg) => {

dist/index.mjs

@@ -193,6 +193,37 @@ function normalizeUrl(urlString, options) {
   return urlString;
 }
 
+/*!
+ * parseUrl
+ * Parses the input url.
+ *
+ * **Note**: This *throws* if invalid urls are provided.
+ *
+ * @name parseUrl
+ * @function
+ * @param {String} url The input url.
+ * @param {Boolean|Object} normalize Whether to normalize the url or not.
+ *                         Default is `false`. If `true`, the url will
+ *                         be normalized. If an object, it will be the
+ *                         options object sent to [`normalize-url`](https://github.com/sindresorhus/normalize-url).
+ *
+ *                         For SSH urls, normalize won't work.
+ *
+ * @return {Object} An object containing the following fields:
+ *
+ *    - `protocols` (Array): An array with the url protocols (usually it has one element).
+ *    - `protocol` (String): The first protocol, `"ssh"` (if the url is a ssh url) or `"file"`.
+ *    - `port` (String): The domain port.
+ *    - `resource` (String): The url domain (including subdomains).
+ *    - `host` (String):  The fully qualified domain name of a network host, or its IP address.
+ *    - `user` (String): The authentication user (usually for ssh urls).
+ *    - `pathname` (String): The url pathname.
+ *    - `hash` (String): The url hash.
+ *    - `search` (String): The url querystring value.
+ *    - `href` (String): The input url.
+ *    - `query` (Object): The url querystring, parsed as object.
+ *    - `parse_failed` (Boolean): Whether the parsing failed or not.
+ */
 const parseUrl = (url, normalize = false) => {
   const GIT_RE = /^(?:([a-zA-Z_][a-zA-Z0-9_-]{0,31})@|https?:\/\/)([\w\.\-@]+)[\/:](([\~,\.\w,\-,\_,\/,\s]|%[0-9A-Fa-f]{2})+?(?:\.git|\/)?)$/;
   const throwErr = (msg) => {

package-lock.json

@@ -72,10 +72,15 @@
   },
   "blah": {
     "description": [
-      "For low-level path parsing, check out [`parse-path`](https://github.com/IonicaBizau/parse-path). This very module is designed to parse urls. By default the urls are normalized."
+      "For low-level path parsing, check out [`parse-path`](https://github.com/IonicaBizau/parse-path). This very module is designed to parse urls."
     ]
   },
   "tsd": {
     "directory": "test"
+  },
+  "pkgroll": {
+    "esbuildOptions": {
+      "legalComments": "inline"
+    }
   }
-}
+}

package.json

@@ -3,7 +3,7 @@
 import normalizeUrl from "normalize-url";
 import parsePath from "parse-path";
 
-/**
+/*!
  * parseUrl
  * Parses the input url.
  *
@@ -40,10 +40,10 @@ const parseUrl = (url, normalize = false) => {
     /**
      * ([a-zA-Z_][a-zA-Z0-9_-]{0,31}) Try to match the user
      * ([\w\.\-@]+) Match the host/resource
-     * (([\~,\.\w,\-,\_,\/,\s]|%[0-9A-Fa-f]{2})+?(?:\.git|\/)?) Match the path, allowing spaces/white 
+     * (([\~,\.\w,\-,\_,\/,\s]|%[0-9A-Fa-f]{2})+?(?:\.git|\/)?) Match the path, allowing spaces/white
      */
     const GIT_RE = /^(?:([a-zA-Z_][a-zA-Z0-9_-]{0,31})@|https?:\/\/)([\w\.\-@]+)[\/:](([\~,\.\w,\-,\_,\/,\s]|%[0-9A-Fa-f]{2})+?(?:\.git|\/)?)$/;
-    
+
     const throwErr = msg => {
         const err = new Error(msg)
         err.subject_url = url