Linkify 2.0

[nfrasser]

2.0 includes completely rewritten internals and a Node.js/io.js API. This PR supersedes #17 and fixes numerous additionally reported issues.

Work in Progress.

Overview

• New link-detection technique based on lexicographical analysis via two-stage scanner
• Node.js API via var linkify = require('linkifyjs');
• Internal plugin system so you can require only features you need. e.g., require('linkifyjs-mentions')(linkify);
• Multiple browser builds with various features Deferring these to a future release
  • Basic linkify for URLs with most available TLDs and email addresses
  • Slim linkify with only the most common TLDs
  • More builds with mentions and hashtags to come
• Browser modules
  • Browserify (regular Node)
  • AMD
  • Browser build
• Mocha Unit tests
• Written in future-proof ES6 compiled to ES5
• Updated documentation for all the new features

Fixes

• Links have mandatory domain extension #19 - Domain extension isn't required for URLs like localhost, but IP addresses are not yet supported
• Link generated is not getting the right protocol #20, ftp or any links other than http as a protocol #27 - URLs keep original protocol
• Brackets in URL #22, Links with ( and ) in it #52 (Partial) - URL queries can have brackets now as long as the URL does not end in a bracket
  • It's unlikely that we'll fix this problem fully
• Capital letters in domain names #30 - Domains can have capitals
• Links in double quotes #31 - Links in double quotes should be detected now
  • Test case
• IE 8 support #32 - IE89 Support (full IE 8 Support deferred to post 2.0 release)
  • Tests with SauceLabs
• Links with @ in it. #33 - Query strings can have @
• Why all 2-Letter TLDs are Valid? #38 - Valid two-letter domains only
• Need a callback once linkify finishes #43 - Linkify callback
• [object NodeList] error when testing with phantomjs #46 - Should be fixed with replaced test suite

APIs

• find - Find links
• test - Is the given string a link?
• Plugin API - for adding mentions and hashtags (to be provided by the plugin)
• String of plain text to string of HTML with .linkify anchor tags (can be used on the server-side)
  • Supports options and callbacks
• Updated jQuery/DOM API
  • Supports options and callbacks

Deprecations

• Bower package will be moved to linkifyjs (install with bower install linkifyjs)

[nfrasser]

Should switch the current ES6 Transpiler to this one https://6to5.org

Seems much more robust and supports compiling to various modules

[nfrasser]

Been doing a lot of mental labour trying to come up with a sophisticated build system. I have AMD modules working so far (should make building an Ember CLI plugin trivial!), and now I have to come up with the vanilla browser build.

Here's the game plan so far

• Export to AMD modules with a complete linkify.amd.js file
  • AMD modules for Linkify plugins - e.g., defining the hashtag plugin, then immediately applying it to Linkify (so that it's active as soon as the file is loaded)
• Browser build using the closure compiler - Can convert the generated CJS modules in lib/ - see this post
  • Would this provide a viable non-minified version? Look into the closure compiler options
• Verify that Browserify modules do "just work"

[nfrasser]

Shim repo located at https://github.com/nfrasser/linkify-shim (to be transferred to https://github.com/SoapBox/linkify-shim )

[nfrasser]

This is just about ready to merge. Next up, updating Bower to point to the shim repository.