Merge pull request #51 from SoapBox/2.0

Linkify 2.0

.gitignore

@@ -6,5 +6,43 @@
 Thumbs.DB
 node_modules
 bower_components
-build/*
 demo/dist/*
+
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
+node_modules
+
+# Build files
+build
+dist
+lib
+
+# Specific to plugin website branch
+.sass-cache
+_site
+_sass
+js

.jshintrc

@@ -1,21 +1,16 @@
 {
-	"boss": true,
-	"curly": true,
-	"eqeqeq": true,
-	"eqnull": true,
-	"expr": true,
-	"immed": false,
-	"noarg": true,
-	"smarttabs": true,
-	"trailing": true,
-	"unused": true,
-	"strict": false,
-	"node": true,
-	"browser": true,
-	"jquery": true,
-	"globals": {
-		"prettyPrint": false,
-		"jQuery": false,
-		"Linkified": false
-	}
-}
+    "esnext": true,
+    "globalstrict": false,
+    "node": true,
+    "globals": {
+        "__base": false,
+        "__TLDS__": false,
+        "after": false,
+        "afterEach": false,
+        "before": false,
+        "beforeEach": false,
+        "expect": false,
+        "describe": false,
+        "it": false
+    }
+}

.npmignore

@@ -0,0 +1,24 @@
+# All compiled code will be in the `lib` folders
+.sass-cache
+_sass
+_site
+amd
+assets
+bower_components
+build
+coverage
+demo
+dist
+js
+src
+templates
+test
+
+# Files
+.editorconfig
+.jshintrc
+.travis.yml
+bower.json
+gulpfile.js
+testem.json
+run-tests.sh

.travis.yml

@@ -0,0 +1,11 @@
+language: node_js
+node_js:
+  - "0.12"
+  - "0.10"
+  - "iojs"
+env:
+  global:
+    - secure: LhH+mMqOktTe6cIt97PGKBfgUjZM8vRd0qddyg61FSxg7a3WrHQoHE8WdRioJ9+DDzpu/NSTsHEUFUpGN+kSRw1UY4tsNLH6HoBQnqrNN4tVOeefudJpdeteOKZrJ8r8TaA/eO7sAgXO2T+RLJ8+qTbhx8FVZtLaCAgkrS0w9Qk=
+    - secure: Okwm1aAR3oo09AhHDsjFSq1UGlIUtWYYvYeoolJScC/UVFGMiK9oC4fzRtUHv3kXcnshDlcVDrr/Q5JL9Qx6E+tosPJp+tioaqE8X4IDbVk7PPs/ToOOEmWnGvxkgmfCGSDuneG8RVhILkhls3fbm0z+rRWlvJkjefeA96T6zps=
+script: ./run-tests.sh
+after_script: npm run coverage

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Linkify Changelog
+
+### v2.0.0
+
+* New link-detection technique based on lexicographical analysis via two-stage scanner - essentially regexp with more flexibility.
+* Node.js API via `var linkify = require('linkifyjs');`
+* Internal plugin system so you can require only features you need. e.g., `require('linkifyjs/plugins/hashtag')(linkify);`
+* Browser modules (Browserify, AMD)
+* Mocha Unit tests
+* ES6 Implementation
+* Updated documentation

CONTRIBUTING.md

@@ -0,0 +1,82 @@
+# Contributing
+
+**Note:** This guide is a work in progress. Feel free to [submit an issue](https://github.com/SoapBox/jQuery-linkify/issues/new) if anything is confusing or unclear.
+
+## How linkify works
+
+_TODO: Insert diagram here_
+
+Linkify uses a two stage lexicographical analysis to detect patterns in plain text.
+
+The first stage, called the scanner, takes the input string and generates encompassing tokens that aggregate different types of components like domain names and TLDs. For example, substings like `http:` or `com` are converted into tokens named `PROTOCOL` and `TLD`, respectively.
+
+The second stage, the parser, takes this array of tokens and aggregates them into complete entities that are either become links or do not. For example, the tokens `PROTOCOL`, `SLASH`, `SLASH`, `DOMAIN`, `TLD` (appearing in that order) are grouped into a `URL` entity. These groups are called multitokens.
+
+A multi token is either a link or not a link. Basic linkify comes with these multitokens
+
+* **`TEXT`** is plain text (that contains no linkable entities)
+* **`NL`** represents a single newline character
+* **`EMAIL`** email address
+* **`URL`**
+
+The latter two are converted to links. `NL` is in some cases converted to a `<br>` HTML tag.
+
+You can use the Token class system to [create plugins](#building-plugins).
+
+## Style
+
+* ES6 Syntax (except tests for now)
+* Hard tabs with a width of 4 characters
+
+As usualy, try to keep it consistent with what's already there.
+
+## Development
+
+### Setup
+
+1. Install the latest version of [Node.js](https://nodejs.org/)
+2. Install the [gulp.js](http://gulpjs.com/) build system from the Terminal
+	* `npm install -g gulp`
+
+### Building
+
+Linkify is built and tested in the command line. Build tasks have the following format.
+
+```
+gulp <task>
+```
+
+Here are the primary build tasks used for development. See [gulpfile.js](https://github.com/SoapBox/jQuery-linkify/blob/master/gulpfile.js) for the complete list.
+
+* **`build`** transpiles ES6 to ES5 (via [Babel](http://babeljs.io/)) from `src/` into `lib/`. The lib folder will be published to [NPM](https://www.npmjs.com/). Also generates browser-ready scripts (globals and [AMD](http://requirejs.org/docs/whyamd.html)) into the `build/` folder.
+* **`dist`** copies and compresses the contents of `build/` into `dist/`. The contents of the dist folder will be published to [Bower](http://bower.io/).
+* **default** (run `gulp` without arguments) runs `build` and begins watching files for changes (rebuilding when they do)
+
+### Running tests
+
+Here are the tools used for testing linkify:
+
+* [Mocha](http://mochajs.org/) is our primary test case framework
+* [JSHint](http://jshint.com/) for code linting
+* [Istanbul](https://gotwarlost.github.io/istanbul/) for code coverage analysis
+* [Karma](http://karma-runner.github.io/0.12/index.html) is our browser test runner
+* [Sauce Labs](https://saucelabs.com/) for cross-browser testing
+
+These are all configured to run on gulp. Tasks `mocha` and `jshint` are the most basic you can run. Other tasks include:
+
+* `test` transpiles the code and runs JSHint and Mocha
+* `coverage` runs Istanbul code coverage on the Mocha tests
+* Karma has a number of tasks that allow you to run Mocha tests on different browsers (via [Browserify](http://browserify.org/))
+	* `karma` runs tests on the [PhantomJS](http://phantomjs.org/) headless browser
+	* `karma-chrome` runs tests on [Google Chrome](http://www.google.com/chrome/)
+	* `karma-ci` (or `test-ci`) runs Sauce Labs cross-browser tests (Sauce Labs environment configuration required)
+
+### Building plugins
+
+**Caution:** The plugin development API is in its very early stages and only supports very basic plugins. Updated features, APIs, and docs are in the works.
+
+Check out the sample [Hashtag plugin](https://github.com/SoapBox/jQuery-linkify/blob/2.0/src/linkify/plugins/hashtag.js) for an idea of how plugins are made. You have access to all the previously described tokens from the `linkify` variable. And should be able to extend them as necessary.
+
+If you decide that your plugin can be used by many people, you can add them to `src/linkify/plugins/`. Make sure you also create build templates for your plugin inside `templates/linkify/plugins/`. Follow the format of the existing files.
+
+Any plugin you add to `src/linkify/plugins/` will automatically be added to the build system.