Add the ability to stripPrefix option to decide whether to only strip the scheme, the 'www', or both

Author: gregjacobs

README.md

@@ -122,8 +122,8 @@ providing an Object as the second parameter to [Autolinker.link()](http://gregja
   `true` to have URLs auto-linked, `false` to skip auto-linking of URLs.
   Defaults to `true`.<br>
 
-  This option also accepts an Object form with 3 properties, to allow for more
-  customization of what exactly gets linked. All default to `true`:
+  This option also accepts an Object form with 3 properties to allow for 
+  more customization of what exactly gets linked. All default to `true`:
 
     - schemeMatches (Boolean): `true` to match URLs found prefixed with a scheme,
       i.e. `http://google.com`, or `other+scheme://google.com`, `false` to
@@ -154,8 +154,25 @@ providing an Object as the second parameter to [Autolinker.link()](http://gregja
   values at this time are 'twitter', 'facebook' and 'instagram'. Pass `false` to skip
   auto-linking of hashtags. Defaults to `false`.<br /><br />
 - [stripPrefix](http://gregjacobs.github.io/Autolinker.js/docs/#!/api/Autolinker-cfg-stripPrefix) : Boolean<br />
-  `true` to have the 'http://' or 'https://' and/or the 'www.' stripped from the
-  beginning of links, `false` otherwise. Defaults to `true`.<br /><br />
+  `true` to have the `'http://'` (or `'https://'`) and/or the `'www.'` 
+  stripped from the beginning of displayed links, `false` otherwise. 
+  Defaults to `true`.<br />
+  
+  This option also accepts an Object form with 2 properties to allow for 
+  more customization of what exactly is prevented from being displayed. 
+  Both default to `true`:
+
+    - scheme (Boolean): `true` to prevent the scheme part of a URL match
+      from being displayed to the user. Example: `'http://google.com'` 
+      will be displayed as `'google.com'`. `false` to not strip the 
+      scheme. NOTE: Only an `'http://'` or `'https://'` scheme will be
+      removed, so as not to remove a potentially dangerous scheme (such
+      as `'file://'` or `'javascript:'`).
+    - www (Boolean): `true` to prevent the `'www.'` part of a URL match
+      from being displayed to the user. Ex: `'www.google.com'` will be
+      displayed as `'google.com'`. `false` to not strip the `'www'`.
+  
+  <br /><br />
 - [stripTrailingSlash](http://gregjacobs.github.io/Autolinker.js/docs/#!/api/Autolinker-cfg-stripTrailingSlash) : Boolean<br />
   `true` to remove the trailing slash from URL matches, `false` to keep
   the trailing slash. Example when `true`: `http://google.com/` will be 

dist/Autolinker.js

@@ -137,7 +137,7 @@ var Autolinker = function( cfg ) {
 	this.hashtag = cfg.hashtag || false;
 	this.mention = cfg.mention || false;
 	this.newWindow = typeof cfg.newWindow === 'boolean' ? cfg.newWindow : true;
-	this.stripPrefix = typeof cfg.stripPrefix === 'boolean' ? cfg.stripPrefix : true;
+	this.stripPrefix = this.normalizeStripPrefixCfg( cfg.stripPrefix );
 	this.stripTrailingSlash = typeof cfg.stripTrailingSlash === 'boolean' ? cfg.stripTrailingSlash : true;
 
 	// Validate the value of the `mention` cfg
@@ -207,23 +207,36 @@ Autolinker.prototype = {
 	constructor : Autolinker,  // fix constructor property
 
 	/**
-	 * @cfg {Boolean/Object} [urls=true]
+	 * @cfg {Boolean/Object} [urls]
 	 *
 	 * `true` if URLs should be automatically linked, `false` if they should not
-	 * be.
+	 * be. Defaults to `true`.
 	 *
-	 * This option also accepts an Object form with 3 properties, to allow for
-	 * more customization of what exactly gets linked. All default to `true`:
+	 * Examples:
 	 *
-	 * @param {Boolean} schemeMatches `true` to match URLs found prefixed with a
-	 *   scheme, i.e. `http://google.com`, or `other+scheme://google.com`,
+	 *     urls: true
+	 *
+	 *     // or
+	 *
+	 *     urls: {
+	 *         schemeMatches : true,
+	 *         wwwMatches    : true,
+	 *         tldMatches    : true
+	 *     }
+	 *
+	 * As shown above, this option also accepts an Object form with 3 properties
+	 * to allow for more customization of what exactly gets linked. All default
+	 * to `true`:
+	 *
+	 * @cfg {Boolean} [urls.schemeMatches] `true` to match URLs found prefixed
+	 *   with a scheme, i.e. `http://google.com`, or `other+scheme://google.com`,
 	 *   `false` to prevent these types of matches.
-	 * @param {Boolean} wwwMatches `true` to match urls found prefixed with
+	 * @cfg {Boolean} [urls.wwwMatches] `true` to match urls found prefixed with
 	 *   `'www.'`, i.e. `www.google.com`. `false` to prevent these types of
 	 *   matches. Note that if the URL had a prefixed scheme, and
 	 *   `schemeMatches` is true, it will still be linked.
-	 * @param {Boolean} tldMatches `true` to match URLs with known top level
-	 *   domains (.com, .net, etc.) that are not prefixed with a scheme or
+	 * @cfg {Boolean} [urls.tldMatches] `true` to match URLs with known top
+	 *   level domains (.com, .net, etc.) that are not prefixed with a scheme or
 	 *   `'www.'`. This option attempts to match anything that looks like a URL
 	 *   in the given text. Ex: `google.com`, `asdf.org/?page=1`, etc. `false`
 	 *   to prevent these types of matches.
@@ -275,10 +288,37 @@ Autolinker.prototype = {
 	 */
 
 	/**
-	 * @cfg {Boolean} [stripPrefix=true]
+	 * @cfg {Boolean/Object} [stripPrefix]
+	 *
+	 * `true` if 'http://' (or 'https://') and/or the 'www.' should be stripped
+	 * from the beginning of URL links' text, `false` otherwise. Defaults to
+	 * `true`.
+	 *
+	 * Examples:
 	 *
-	 * `true` if 'http://' or 'https://' and/or the 'www.' should be stripped
-	 * from the beginning of URL links' text, `false` otherwise.
+	 *     stripPrefix: true
+	 *
+	 *     // or
+	 *
+	 *     stripPrefix: {
+	 *         scheme : true,
+	 *         www    : true
+	 *     }
+	 *
+	 * As shown above, this option also accepts an Object form with 2 properties
+	 * to allow for more customization of what exactly is prevented from being
+	 * displayed. Both default to `true`:
+	 *
+	 * @cfg {Boolean} [stripPrefix.scheme] `true` to prevent the scheme part of
+	 *   a URL match from being displayed to the user. Example:
+	 *   `'http://google.com'` will be displayed as `'google.com'`. `false` to
+	 *   not strip the scheme. NOTE: Only an `'http://'` or `'https://'` scheme
+	 *   will be removed, so as not to remove a potentially dangerous scheme
+	 *   (such as `'file://'` or `'javascript:'`)
+	 * @cfg {Boolean} [stripPrefix.www] www (Boolean): `true` to prevent the
+	 *   `'www.'` part of a URL match from being displayed to the user. Ex:
+	 *   `'www.google.com'` will be displayed as `'google.com'`. `false` to not
+	 *   strip the `'www'`.
 	 */
 
 	/**
@@ -445,6 +485,31 @@ Autolinker.prototype = {
 	},
 
 
+	/**
+	 * Normalizes the {@link #stripPrefix} config into an Object with 2
+	 * properties: `scheme`, and `www` - both Booleans.
+	 *
+	 * See {@link #stripPrefix} config for details.
+	 *
+	 * @private
+	 * @param {Boolean/Object} stripPrefix
+	 * @return {Object}
+	 */
+	normalizeStripPrefixCfg : function( stripPrefix ) {
+		if( stripPrefix == null ) stripPrefix = true;  // default to `true`
+
+		if( typeof stripPrefix === 'boolean' ) {
+			return { scheme: stripPrefix, www: stripPrefix };
+
+		} else {  // object form
+			return {
+				scheme : typeof stripPrefix.scheme === 'boolean' ? stripPrefix.scheme : true,
+				www    : typeof stripPrefix.www === 'boolean'    ? stripPrefix.www    : true
+			};
+		}
+	},
+
+
 	/**
 	 * Normalizes the {@link #truncate} config into an Object with 2 properties:
 	 * `length` (Number), and `location` (String).
@@ -2749,8 +2814,9 @@ Autolinker.match.Url = Autolinker.Util.extend( Autolinker.match.Match, {
 	 */
 
 	/**
-	 * @cfg {Boolean} stripPrefix (required)
-	 * @inheritdoc Autolinker#cfg-stripPrefix
+	 * @cfg {Object} stripPrefix (required)
+	 *
+	 * The Object form of {@link Autolinker#cfg-stripPrefix}.
 	 */
 
 	/**
@@ -2785,12 +2851,20 @@ Autolinker.match.Url = Autolinker.Util.extend( Autolinker.match.Match, {
 
 	/**
 	 * @private
-	 * @property {RegExp} urlPrefixRegex
+	 * @property {RegExp} schemePrefixRegex
+	 *
+	 * A regular expression used to remove the 'http://' or 'https://' from
+	 * URLs.
+	 */
+	schemePrefixRegex: /^(https?:\/\/)?/i,
+
+	/**
+	 * @private
+	 * @property {RegExp} wwwPrefixRegex
 	 *
-	 * A regular expression used to remove the 'http://' or 'https://' and/or
-	 * the 'www.' from URLs.
+	 * A regular expression used to remove the 'www.' from URLs.
 	 */
-	urlPrefixRegex: /^(https?:\/\/)?(www\.)?/i,
+	wwwPrefixRegex: /^(https?:\/\/)?(www\.)?/i,
 
 	/**
 	 * @private
@@ -2881,8 +2955,11 @@ Autolinker.match.Url = Autolinker.Util.extend( Autolinker.match.Match, {
 			// Strip off any protocol-relative '//' from the anchor text
 			anchorText = this.stripProtocolRelativePrefix( anchorText );
 		}
-		if( this.stripPrefix ) {
-			anchorText = this.stripUrlPrefix( anchorText );
+		if( this.stripPrefix.scheme ) {
+			anchorText = this.stripSchemePrefix( anchorText );
+		}
+		if( this.stripPrefix.www ) {
+			anchorText = this.stripWwwPrefix( anchorText );
 		}
 		if( this.stripTrailingSlash ) {
 			anchorText = this.removeTrailingSlash( anchorText );  // remove trailing slash, if there is one
@@ -2897,15 +2974,29 @@ Autolinker.match.Url = Autolinker.Util.extend( Autolinker.match.Match, {
 	// Utility Functionality
 
 	/**
-	 * Strips the URL prefix (such as "http://" or "https://") from the given text.
+	 * Strips the scheme prefix (such as "http://" or "https://") from the given
+	 * `url`.
 	 *
 	 * @private
-	 * @param {String} text The text of the anchor that is being generated, for which to strip off the
-	 *   url prefix (such as stripping off "http://")
-	 * @return {String} The `anchorText`, with the prefix stripped.
+	 * @param {String} url The text of the anchor that is being generated, for
+	 *   which to strip off the url scheme.
+	 * @return {String} The `url`, with the scheme stripped.
+	 */
+	stripSchemePrefix : function( url ) {
+		return url.replace( this.schemePrefixRegex, '' );
+	},
+
+
+	/**
+	 * Strips the 'www' prefix from the given `url`.
+	 *
+	 * @private
+	 * @param {String} url The text of the anchor that is being generated, for
+	 *   which to strip off the 'www' if it exists.
+	 * @return {String} The `url`, with the 'www' stripped.
 	 */
-	stripUrlPrefix : function( text ) {
-		return text.replace( this.urlPrefixRegex, '' );
+	stripWwwPrefix : function( url ) {
+		return url.replace( this.wwwPrefixRegex, '$1' );  // leave any scheme ($1), it one exists
 	},
 
 
@@ -3279,8 +3370,9 @@ Autolinker.matcher.Mention = Autolinker.Util.extend( Autolinker.matcher.Matcher,
 Autolinker.matcher.Url = Autolinker.Util.extend( Autolinker.matcher.Matcher, {
 
 	/**
-	 * @cfg {Boolean} stripPrefix (required)
-	 * @inheritdoc Autolinker#stripPrefix
+	 * @cfg {Object} stripPrefix (required)
+	 *
+	 * The Object form of {@link Autolinker#cfg-stripPrefix}.
 	 */
 
 	/**

dist/Autolinker.min.js

@@ -119,7 +119,7 @@ var Autolinker = function( cfg ) {
 	this.hashtag = cfg.hashtag || false;
 	this.mention = cfg.mention || false;
 	this.newWindow = typeof cfg.newWindow === 'boolean' ? cfg.newWindow : true;
-	this.stripPrefix = typeof cfg.stripPrefix === 'boolean' ? cfg.stripPrefix : true;
+	this.stripPrefix = this.normalizeStripPrefixCfg( cfg.stripPrefix );
 	this.stripTrailingSlash = typeof cfg.stripTrailingSlash === 'boolean' ? cfg.stripTrailingSlash : true;
 
 	// Validate the value of the `mention` cfg
@@ -189,23 +189,36 @@ Autolinker.prototype = {
 	constructor : Autolinker,  // fix constructor property
 
 	/**
-	 * @cfg {Boolean/Object} [urls=true]
+	 * @cfg {Boolean/Object} [urls]
 	 *
 	 * `true` if URLs should be automatically linked, `false` if they should not
-	 * be.
+	 * be. Defaults to `true`.
 	 *
-	 * This option also accepts an Object form with 3 properties, to allow for
-	 * more customization of what exactly gets linked. All default to `true`:
+	 * Examples:
 	 *
-	 * @param {Boolean} schemeMatches `true` to match URLs found prefixed with a
-	 *   scheme, i.e. `http://google.com`, or `other+scheme://google.com`,
+	 *     urls: true
+	 *
+	 *     // or
+	 *
+	 *     urls: {
+	 *         schemeMatches : true,
+	 *         wwwMatches    : true,
+	 *         tldMatches    : true
+	 *     }
+	 *
+	 * As shown above, this option also accepts an Object form with 3 properties
+	 * to allow for more customization of what exactly gets linked. All default
+	 * to `true`:
+	 *
+	 * @cfg {Boolean} [urls.schemeMatches] `true` to match URLs found prefixed
+	 *   with a scheme, i.e. `http://google.com`, or `other+scheme://google.com`,
 	 *   `false` to prevent these types of matches.
-	 * @param {Boolean} wwwMatches `true` to match urls found prefixed with
+	 * @cfg {Boolean} [urls.wwwMatches] `true` to match urls found prefixed with
 	 *   `'www.'`, i.e. `www.google.com`. `false` to prevent these types of
 	 *   matches. Note that if the URL had a prefixed scheme, and
 	 *   `schemeMatches` is true, it will still be linked.
-	 * @param {Boolean} tldMatches `true` to match URLs with known top level
-	 *   domains (.com, .net, etc.) that are not prefixed with a scheme or
+	 * @cfg {Boolean} [urls.tldMatches] `true` to match URLs with known top
+	 *   level domains (.com, .net, etc.) that are not prefixed with a scheme or
 	 *   `'www.'`. This option attempts to match anything that looks like a URL
 	 *   in the given text. Ex: `google.com`, `asdf.org/?page=1`, etc. `false`
 	 *   to prevent these types of matches.
@@ -257,10 +270,37 @@ Autolinker.prototype = {
 	 */
 
 	/**
-	 * @cfg {Boolean} [stripPrefix=true]
+	 * @cfg {Boolean/Object} [stripPrefix]
+	 *
+	 * `true` if 'http://' (or 'https://') and/or the 'www.' should be stripped
+	 * from the beginning of URL links' text, `false` otherwise. Defaults to
+	 * `true`.
+	 *
+	 * Examples:
+	 *
+	 *     stripPrefix: true
 	 *
-	 * `true` if 'http://' or 'https://' and/or the 'www.' should be stripped
-	 * from the beginning of URL links' text, `false` otherwise.
+	 *     // or
+	 *
+	 *     stripPrefix: {
+	 *         scheme : true,
+	 *         www    : true
+	 *     }
+	 *
+	 * As shown above, this option also accepts an Object form with 2 properties
+	 * to allow for more customization of what exactly is prevented from being
+	 * displayed. Both default to `true`:
+	 *
+	 * @cfg {Boolean} [stripPrefix.scheme] `true` to prevent the scheme part of
+	 *   a URL match from being displayed to the user. Example:
+	 *   `'http://google.com'` will be displayed as `'google.com'`. `false` to
+	 *   not strip the scheme. NOTE: Only an `'http://'` or `'https://'` scheme
+	 *   will be removed, so as not to remove a potentially dangerous scheme
+	 *   (such as `'file://'` or `'javascript:'`)
+	 * @cfg {Boolean} [stripPrefix.www] www (Boolean): `true` to prevent the
+	 *   `'www.'` part of a URL match from being displayed to the user. Ex:
+	 *   `'www.google.com'` will be displayed as `'google.com'`. `false` to not
+	 *   strip the `'www'`.
 	 */
 
 	/**
@@ -427,6 +467,31 @@ Autolinker.prototype = {
 	},
 
 
+	/**
+	 * Normalizes the {@link #stripPrefix} config into an Object with 2
+	 * properties: `scheme`, and `www` - both Booleans.
+	 *
+	 * See {@link #stripPrefix} config for details.
+	 *
+	 * @private
+	 * @param {Boolean/Object} stripPrefix
+	 * @return {Object}
+	 */
+	normalizeStripPrefixCfg : function( stripPrefix ) {
+		if( stripPrefix == null ) stripPrefix = true;  // default to `true`
+
+		if( typeof stripPrefix === 'boolean' ) {
+			return { scheme: stripPrefix, www: stripPrefix };
+
+		} else {  // object form
+			return {
+				scheme : typeof stripPrefix.scheme === 'boolean' ? stripPrefix.scheme : true,
+				www    : typeof stripPrefix.www === 'boolean'    ? stripPrefix.www    : true
+			};
+		}
+	},
+
+
 	/**
 	 * Normalizes the {@link #truncate} config into an Object with 2 properties:
 	 * `length` (Number), and `location` (String).