Merge pull request #157 from SoapBox/v2.1

v2.1

Author: Nick Frasser

CHANGELOG.md

@@ -1,5 +1,46 @@
 # Linkify Changelog
 
+### v2.1.0
+
+#### BREAKING CHANGES
+
+* The `dist/jquery.linkify.js` 1.x legacy browser files have been permanently
+removed from the release bundle.
+  * Use `linkify.js` and `linkify-jquery.js` instead.
+* The deprecated `newLine` option from linkify 1.x has been completely removed.
+  * Use the [`nl2br` option](http://soapbox.github.io/linkifyjs/options.html#nl2br) instead.
+
+#### Features
+
+* [New React.js interface](http://soapbox.github.io/linkifyjs/linkify-react.html)
+* [@mention plugin](http://soapbox.github.io/linkifyjs/plugin-mention.html)
+* [GitHub-style ticket/issue reference plugin](http://soapbox.github.io/linkifyjs/plugin-ticket.html)
+* Improved option definitions
+  * Options that take functions with value and type arguments can now be
+    specified as objects, where each key is the target link type.
+
+#### Deprecations
+
+* The `linkAttributes` option is deprecated in favour of just **`attributes`**.
+* The `linkClass` option is deprecated in favour of **`className`**.
+* The default `.linkified` class is deprecated and will be fully removed
+in a future release.
+
+To maintain compatibility with versions >= 2.1, make sure options objects
+include these properties instead of `linkAttributes` and `linkClass`
+
+#### All Changes
+
+* Build optimizations to make compiled AMD payload smaller
+* Bugfix in quick-es3 task
+* Make better use of ES6 modules and rollup
+* Tickets plugin (#156)
+* Additional Mentions features, enhancements, and tests (#155)
+* Mentions plugin (#111)
+* Revamped options utility (#154)
+* Linkify React Interface (#150)
+* Development upgrades (#153)
+
 ### v2.0.5
 
 * Correct trailing symbol parsing (#149)

README.md

@@ -61,7 +61,7 @@ bower install linkifyjs
 Add [linkify](https://github.com/nfrasser/linkify-shim/raw/master/linkify.min.js) and [linkify-jquery](https://github.com/nfrasser/linkify-shim/raw/master/linkify-jquery.min.js) to your HTML following jQuery:
 
 ```html
-<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
 <script src="linkify.min.js"></script>
 <script src="linkify-jquery.min.js"></script>
 ```
@@ -158,16 +158,21 @@ Note that if you are using `linkify-jquery.amd.js`, a `jquery` module must be de
 ### Browser globals
 
 ```html
-<script src="jquery.js"></script>
+<script src="react.js"></script>
+<script src="react-dom.js"></script>
 <script src="linkify.js"></script>
-<script src="linkify-string.js"></script>
-<script src="linkify-jquery.js"></script>
+<script src="linkify-react.js"></script>
 ```
 
-```js
+```jsx
 linkify.test('[email protected]'); // true
-var htmlStr = linkifyStr('Check out soapboxhq.com it is great!');
-$('p').linkify();
+
+ReactDOM.render(
+  <Linkify options={{ignoreTags: ['style']}}>
+    Check out soapboxhq.com it is great!
+  </Linkify>,
+  document.getElementById('#container');
+);
 ```
 
 ## Internet Explorer
@@ -198,6 +203,7 @@ Download the [**latest release**](https://github.com/SoapBox/linkifyjs/releases)
 
 **Interfaces** _(recommended - include at least one)_
 
+* **[react](http://soapbox.github.io/linkifyjs/docs/linkify-react.html)**<br> [`.min.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-react.min.js) · [`.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-react.js) · [`.amd.min.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-react.amd.min.js) · [`.amd.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-react.amd.js)
 * **[jquery](http://soapbox.github.io/linkifyjs/docs/linkify-jquery.html)**<br> [`.min.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-jquery.min.js) · [`.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-jquery.js) · [`.amd.min.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-jquery.amd.min.js) · [`.amd.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-jquery.amd.js)
 * **[html](http://soapbox.github.io/linkifyjs/docs/linkify-html.html)**<br> [`.min.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-html.min.js) · [`.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-html.js) · [`.amd.min.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-html.amd.min.js) · [`.amd.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-html.amd.js)
 * **[element](http://soapbox.github.io/linkifyjs/docs/linkify-element.html)** _(Included with linkify-jquery)_<br> [`.min.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-element.min.js) · [`.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-element.js) · [`.amd.min.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-element.amd.min.js) · [`.amd.js`](https://github.com/nfrasser/linkify-shim/raw/master/linkify-element.amd.js)

gulpfile.js

@@ -61,7 +61,7 @@ gulp.task('babel', () =>
 /**
 	ES6 to babel AMD modules
 */
-gulp.task('babel-amd', () =>
+gulp.task('babel-amd-core', () =>
 	gulp.src(paths.src)
 	.pipe(replace('__TLDS__', tldsReplaceStr))
 	.pipe(babel({
@@ -72,10 +72,29 @@ gulp.task('babel-amd', () =>
 		moduleIds: true
 		// moduleRoot: 'linkifyjs'
 	}))
+	.pipe(quickEs3())
 	.pipe(gulp.dest('build/amd')) // Required for building plugins separately
-	.pipe(amdOptimize('linkify'))
-	.pipe(concat('linkify.amd.js'))
+);
+
+
+/**
+	ES6 to babel AMD modules
+	Must run interfaces first because a more optimized core linkify payload will
+	overwrite the AMD-generated one
+*/
+gulp.task('babel-amd', ['babel-amd-core'], () =>
+	gulp.src(paths.srcCore)
+	.pipe(rollup({
+		bundle: {
+			format: 'amd',
+			moduleId: 'linkify',
+			moduleName: 'linkify'
+		}
+	}))
+	.pipe(babel())
+	.pipe(replace('__TLDS__', tldsReplaceStr))
 	.pipe(quickEs3())
+	.pipe(concat('linkify.amd.js'))
 	.pipe(gulp.dest('build'))
 );
 
@@ -232,6 +251,7 @@ gulp.task('build-polyfill', () =>
 // Build steps
 gulp.task('build', [
 	'babel',
+	'babel-amd-core',
 	'babel-amd',
 	'build-core',
 	'build-interfaces',
@@ -340,16 +360,8 @@ gulp.task('karma-amd-ci', (callback) => {
 	return server.start();
 });
 
-// Build the deprecated legacy interface
-gulp.task('build-legacy', ['build'], () =>
-	gulp.src(['build/linkify.js', 'build/linkify-jquery.js'])
-	.pipe(concat('jquery.linkify.js'))
-	.pipe(wrap({src: 'templates/linkify-legacy.js'}))
-	.pipe(gulp.dest('build/dist'))
-);
-
 // Build a file that can be used for easy headless benchmarking
-gulp.task('build-benchmark', ['build-legacy'], () =>
+gulp.task('build-benchmark', ['build'], () =>
 	gulp.src('build/dist/jquery.linkify.js')
 	.pipe(concat('linkify-benchmark.js'))
 	.pipe(wrap({src: 'templates/linkify-benchmark.js'}))
@@ -358,26 +370,18 @@ gulp.task('build-benchmark', ['build-legacy'], () =>
 );
 
 // NOTE: DO NOT Upgrade gulp-uglify, it breaks IE8 and the options don't seem to be working
-gulp.task('uglify', ['build-legacy'], () => {
+gulp.task('uglify', ['build'], () => {
 	let options = {
 		mangleProperties: {
 			regex: new RegExp(`^(?!(${unmangleableProps.join('|')})).*$`)
 		}
 	};
 
-	let task = gulp.src('build/*.js')
+	return gulp.src('build/*.js')
 	.pipe(gulp.dest('dist')) // non-minified copy
 	.pipe(rename((path) => path.extname = '.min.js'))
 	.pipe(uglify(options))
 	.pipe(gulp.dest('dist'));
-
-	let taskLegacy = gulp.src('build/dist/jquery.linkify.js')
-	.pipe(gulp.dest('dist/dist')) // non-minified copy
-	.pipe(rename((path) => path.extname = '.min.js'))
-	.pipe(uglify(options))
-	.pipe(gulp.dest('dist/dist'));
-
-	return merge(task, taskLegacy);
 });
 
 gulp.task('dist', ['uglify']);