First commit

.editorconfig

@@ -0,0 +1,21 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# http://editorconfig.org
+
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+
+[*.md]
+trim_trailing_whitespace = false

.eslintrc

@@ -0,0 +1,57 @@
+{
+    // Parser
+    "parser": "babel-eslint",
+    // ECMA Features
+    "ecmaFeatures": {
+        "arrowFunctions": true,
+        "blockBindings": true,
+        "classes": true,
+        "defaultParams": true,
+        "destructuring": true,
+        "modules": true,
+        "objectLiteralComputedProperties": true,
+        "templateStrings": true
+    },
+    "rules": {
+        // Possible Errors
+        "no-dupe-args": 2,
+        "no-dupe-keys": 2,
+        "no-empty": 2,
+        "no-func-assign": 2,
+        "no-inner-declarations": 2,
+        "no-unreachable": 2,
+        "no-unexpected-multiline": 2,
+        // Best practices
+        "consistent-return": 0,
+        "curly": [2, "multi-line"],
+        "eqeqeq": 2,
+        "no-else-return": 2,
+        "no-multi-spaces": 0,
+        // Strict mode
+        "strict": 0,
+        // Variables
+        "no-shadow": 0,
+        "no-unused-vars": 2,
+        "no-use-before-define": 0,
+        // Style
+        "brace-style": [2, "1tbs"],
+        "comma-spacing": [2, {"before": false, "after": true}],
+        "comma-style": [2, "last"],
+        "consistent-this":  [2, "that"],
+        "lines-around-comment": [2, {"allowBlockStart": true}],
+        "key-spacing": 0,
+        "new-parens": 0,
+        "quotes": [2, "single", "avoid-escape"],
+        "no-underscore-dangle": 0,
+        "no-unneeded-ternary": 2,
+        "semi": 2,
+        // ES6
+        "no-var": 2,
+        "no-this-before-super": 2,
+        "object-shorthand": 2,
+    },
+    "env": {
+        "node": true,
+        "browser": true
+    }
+}

.gitattributes

@@ -0,0 +1,15 @@
+# Automatically normalize line endings for all text-based files
+# http://git-scm.com/docs/gitattributes#_end_of_line_conversion
+* text=auto
+
+# For the following file types, normalize line endings to LF on
+# checkin and prevent conversion to CRLF when they are checked out
+# (this is required in order to prevent newline related issues like,
+# for example, after the build script is run)
+.*      text eol=lf
+*.css   text eol=lf
+*.ejs   text eol=lf
+*.js    text eol=lf
+*.md    text eol=lf
+*.txt   text eol=lf
+*.json  text eol=lf

.gitignore

@@ -0,0 +1,8 @@
+# Include your project-specific ignores in this file
+# Read about how to use .gitignore: https://help.github.com/articles/ignoring-files
+
+coverage
+dist
+docs/dist
+node_modules
+npm-debug.log

.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: node_js
+node_js:
+  - '6'
+  - '5'
+  - '4'
+script:
+  - npm run lint
+  - npm run test:cover
+after_success:
+  - npm run coveralls

CHANGELOG.md

@@ -0,0 +1,38 @@
+## Babel Starter Kit Change Log
+
+All notable changes to this project will be documented in this file.
+
+### [Unreleased][unreleased]
+
+- Allow to execute tests in a browser environment (PLANNED)
+
+### [v1.2.0] - 2016-05-04
+
+- Add `tools/build.js` script
+- Build source files into `dist` folder
+- Update npm modules
+- Publish as CommonJS, ES2015 and UMD via [Rollup](http://rollupjs.org/). See `tools/build.js`.
+
+### [v1.1.2] - 2016-04-03
+
+- Add `npm run test:watch` npm script for running tests in watch mode
+- Add a recipe: Testing with `mocha` and `jsdom` 
+- Add a recipe: Throwing errors with FB's `invariant` (`fbjs`) library
+- Update `eslint` and `babel-eslint` npm modules to the latest versions
+- Update unit test code sample
+- Add [CONTRIBUTING.md](CONTRIBUTING.md) and [CHANGELOG.md](CHANGELOG.md) files
+
+### [v1.1.0] - 2016-03-31
+
+- Add code coverage in unit tests with [Istanbul](https://github.com/gotwarlost/istanbul) and [Coveralls](https://coveralls.io/) [#8](https://github.com/kriasoft/babel-starter-kit/pull/8)
+
+### [v1.0.0] - 2016-03-30
+
+- Clean up the code and `package.json` file, update project dependencies
+- Integrate [Easystatic](https://easystatic.com) that generates a static site from the `docs/*.md` files
+
+[unreleased]: https://github.com/kriasoft/babel-starter-kit/compare/v1.2.0...HEAD
+[v1.2.0]: https://github.com/kriasoft/babel-starter-kit/compare/v1.1.2...v1.2.0
+[v1.1.2]: https://github.com/kriasoft/babel-starter-kit/compare/v1.1.0...v1.1.2
+[v1.1.0]: https://github.com/kriasoft/babel-starter-kit/compare/v1.0.0...v1.1.0
+[v1.0.0]: https://github.com/kriasoft/babel-starter-kit/compare/v0.1.1...v1.0.0

CONTRIBUTING.md

@@ -0,0 +1,136 @@
+## Contributing to Babel Starter Kit
+
+♥ [Babel Starter Kit](https://www.kriasoft.com/babel-starter-kit) and want to get involved? Thanks!
+There are plenty of ways you can help!
+
+Please take a moment to review this document in order to make the contribution process easy and
+effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time of the developers
+managing and developing this open source project. In return, they should reciprocate that respect in
+addressing your issue or assessing patches and features.
+
+
+### Using the issue tracker
+
+The [issue tracker](https://github.com/kriasoft/babel-starter-kit/issues) is the preferred channel
+for [bug reports](#bugs), [features requests](#features) and [submitting pull requests](#pull-requests),
+but please respect the following restrictions:
+
+* Please **do not** use the issue tracker for personal support requests.
+  [Stack Overflow](https://stackoverflow.com/questions/tagged/babel-starter-kit),
+  [Gitter](https://gitter.im/kriasoft/babel-starter-kit) or
+  [Codementor](https://www.codementor.io/koistya) are better places to get help.
+
+* Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of
+  others.
+
+
+<a name="bugs"></a>
+### Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are
+extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search** &mdash; check if the issue has already been reported.
+
+2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest `master` or
+   development branch in the repository.
+
+3. **Isolate the problem** &mdash; ideally create a reduced test case and a live example.
+
+A good bug report shouldn't leave others needing to chase you up for more information. Please try to
+be as detailed as possible in your report. What is your environment? What steps will reproduce the
+issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All
+these details will help people to fix any potential bugs.
+
+Example:
+
+> Short and descriptive example bug report title
+>
+> A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the
+> steps required to reproduce the bug.
+>
+> 1. This is the first step
+> 2. This is the second step
+> 3. Further steps, etc.
+>
+> `<url>` - a link to the reduced test case
+>
+> Any other information you want to share that is relevant to the issue being reported. This might
+> include the lines of code that you have identified as causing the bug, and potential solutions
+> (and your opinions on their merits).
+
+
+<a name="features"></a>
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea fits with the scope
+and aims of the project. It's up to *you* to make a strong case to convince the project's developers
+of the merits of this feature. Please provide as much detail and context as possible.
+
+
+<a name="pull-requests"></a>
+## Pull requests
+
+Good pull requests - patches, improvements, new features - are a fantastic help. They should remain
+focused in scope and avoid containing unrelated commits.
+
+**Please ask first** before embarking on any significant pull request (e.g. implementing features,
+refactoring code, porting to a different language), otherwise you risk spending a lot of time
+working on something that the project's developers might not want to merge into the project.
+
+Please adhere to the coding conventions used throughout a project (indentation, accurate comments,
+etc.) and any other requirements (such as test coverage).
+
+Adhering to the following process is the best way to get your work included in the project:
+
+1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork, and configure
+   the remotes:
+
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/<your-username>/babel-starter-kit.git
+   # Navigate to the newly cloned directory
+   cd babel-starter-kit
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/kriasoft/babel-starter-kit.git
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout master
+   git pull upstream master
+   ```
+
+3. Create a new topic branch (off the main project development branch) to contain your feature,
+   change, or fix:
+
+   ```bash
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+   or your code is unlikely be merged into the main project. Use Git's [interactive rebase](https://help.github.com/articles/about-git-rebase/)
+   feature to tidy up your commits before making them public.
+
+5. Locally merge (or rebase) the upstream development branch into your topic branch:
+
+   ```bash
+   git pull [--rebase] upstream master
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```bash
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title
+   and description.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owners to license your work
+under the terms of the [MIT License](LICENSE.txt).

LICENSE.txt

@@ -0,0 +1,21 @@
+                               The MIT License
+
+Copyright (c) 2015-2016 Konstantin Tarkus, Kriasoft LLC. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,77 @@
+
+# mobx-router5
+
+## Warning
+This is an early work-in-progress.
+This is not published on npm yet.
+
+## Usage
+
+```javascript 
+import createRouter from 'router5';
+import loggerPlugin from 'router5/plugins/logger';
+import listenersPlugin from 'router5/plugins/listeners';
+import browserPlugin from 'router5/plugins/browser';
+import routes from './routes';
+
+import mobxPlugin from 'mobx-router5/mobxPlugin';
+import RouterStore from 'mobx-router5/RouterStore';
+
+// I instantiate it here because we could extend the class before invoking new
+const routerStore = new RouterStore();
+
+const routerOptions = {
+  defaultRoute: 'home',
+  strictQueryParams: true
+};
+
+
+export default function configureRouter(useListenersPlugin = false) {
+  const router = createRouter(routes, routerOptions)
+    // Plugins
+    .usePlugin(loggerPlugin)
+    .usePlugin(mobxPlugin(routerStore, {storeNavigation: true}))
+    .usePlugin(browserPlugin({
+      useHash: true
+    }));
+
+  if (useListenersPlugin) {
+    router.usePlugin(listenersPlugin());
+  }
+
+  return router;
+}
+```
+
+##Actions
+The routerStore instance expose these actions/handlers automatically invoked by the plugin on transition Start/Success/Error.
+
+- onTransitionStart(route, previousRoute)
+- onTransitionSuccess(route, previousRoute)
+- onTransitionError(route, previousRoute, transitionError)
+
+This ensure that the observables are always up-to-date with the current route:
+
+- @observable route 
+- @observable previousRoute
+- @observable transitionRoute
+- @observable transitionError
+
+To be called manually (todo)
+- clearErrors()
+
+### Manual actions (optional)
+Only available if we pass the option `storeNavigation: true` on plugin creation.
+
+```
+.usePlugin(mobxPlugin(routerStore, {storeNavigation: true})
+```
+
+In this case when the plugin is create it will use the `setRouter` method of the store to pass in the router so that router methods can be used directly.  
+
+- navigateTo(routeName, routeParams = {}, routeOptions = {})
+- cancelTransition()
+- canActivate(routeName, true | false)
+- canDeactivate(routeName, true | false)
+
+If you use react and an HOC component like `RouterProvider` to inject the router instance into your components context this is not necessary because you can access the router methods directly.