Merge pull request #31 from ui-router/AoT

Add AoT + lazy loading + Angular-CLI support

Author: christopherthielen

.gitignore

@@ -16,3 +16,4 @@ _doc
 _bundles
 lib
 lib-esm
+stats.html

.npmignore

@@ -1,5 +1,6 @@
 # Any hidden files
 **/.*
+.*
 
 src
 config
@@ -12,6 +13,8 @@ tslint.json
 tsconfig.json
 tsconfig.**.json
 webpack.config.js
+rollup.config.js
+yarn.lock
 
 *.iml
 *.ipr

.travis.yml

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-  - "4.1"
+  - "6.6"
 
 before_script:
   - export DISPLAY=:99.0

README.md

@@ -1,27 +1,20 @@
-# AngularUI Router  [![Build Status](https://travis-ci.org/angular-ui/ui-router.svg?branch=master)](https://travis-ci.org/angular-ui/ui-router)
+# UI-Router for Angular 2  [![Build Status](https://travis-ci.org/ui-router/ng2.svg?branch=master)](https://travis-ci.org/ui-router/ng2)
 
-**Note: this is the Angular 1.x source for UI-Router version 1.0.  If you are looking for the source for UI-Router 
-version 0.2.x, it can be found [here](https://github.com/angular-ui/ui-router/tree/legacy)**
+### ui-router-ng2: State based routing for Angular (2+)
 
 ---
-
-
-#### The de-facto solution to flexible routing in angular
----
 **[Tutorials](https://ui-router.github.io/tutorials/)** |
-**[API Docs](https://ui-router.github.io/docs/latest/)** |
-**[Download stable](http://unpkg.com/angular-ui-router@latest/release/angular-ui-router.js)** (or **[Minified](http://unpkg.com/angular-ui-router@latest/release/angular-ui-router.min.js)**) **|**
-**[Guide](https://github.com/angular-ui/ui-router/wiki) |**
+**[API Docs](https://ui-router.github.io/ng2/docs/latest/)** |
+**[Guides](https://ui-router.github.io/guide)** |
 **[Sample App](http://ui-router.github.io/resources/sampleapp/) |**
-**[FAQ](https://github.com/angular-ui/ui-router/wiki/Frequently-Asked-Questions) |**
-**[Report an Issue](https://github.com/angular-ui/ui-router/blob/master/CONTRIBUTING.md#report-an-issue) |**
-**[Contribute](https://github.com/angular-ui/ui-router/blob/master/CONTRIBUTING.md#contribute) |**
-**[Help!](http://stackoverflow.com/questions/ask?tags=angularjs,angular-ui-router) |**
+**[Report an Issue](https://github.com/ui-router/ng2/blob/master/CONTRIBUTING.md#report-an-issue) |**
+**[Contribute](https://github.com/ui-router/ng2/blob/master/CONTRIBUTING.md#contribute) |**
+**[Help!](http://stackoverflow.com/questions/ask?tags=ui-router-ng2)**
 
 ---
 
-Angular UI-Router is a client-side [Single Page Application](https://en.wikipedia.org/wiki/Single-page_application) 
-routing framework for [AngularJS](http://angularjs.org).  
+ui-router-ng2 is a client-side [Single Page Application](https://en.wikipedia.org/wiki/Single-page_application) 
+routing framework for [Angular](http://angular.io).  
 
 Routing frameworks for SPAs update the browser's URL as the user navigates through the app.  Conversely, this allows 
 changes to the browser's URL to drive navigation through the app, thus allowing the user to create a bookmark to a 
@@ -33,23 +26,7 @@ application states in a transaction-like manner.
 
 ## Get Started
 
-
-- [UI-Router for Angular 1](https://ui-router.github.io/ng1)
 - [UI-Router for Angular 2](https://ui-router.github.io/ng2)
-- [UI-Router for React](https://ui-router.github.io/react)
-
-## Resources
-
-* [In-Depth Guide](https://github.com/angular-ui/ui-router/wiki)
-* [Slides comparing ngRoute to ui-router](http://slid.es/timkindberg/ui-router#/)
-* [UI-Router Extras / Addons for legacy (0.x)](http://christopherthielen.github.io/ui-router-extras/#/home) (@christopherthielen)
- 
-### Videos
-
-* [Introduction Video](https://egghead.io/lessons/angularjs-introduction-ui-router) (egghead.io)
-* [Tim Kindberg on Angular UI-Router](https://www.youtube.com/watch?v=lBqiZSemrqg)
-* [Activating States](https://egghead.io/lessons/angularjs-ui-router-activating-states) (egghead.io)
-* [Learn Angular.js using UI-Router](http://youtu.be/QETUuZ27N0w) (LearnCode.academy)
 
 ## Reporting issues and Contributing
 

config/system.config.js

@@ -10,7 +10,7 @@ System.config({
         'rxjs': 'node_modules/rxjs/bundles/Rx.js',
         '@angular': 'node_modules/@angular',
 
-        'ui-router-ng2': 'src/ng2.ts'
+        'ui-router-ng2': 'src/index.ts'
     },
     map: {
         'ui-router-core': 'node_modules/ui-router-core/lib',

package.json

@@ -3,29 +3,18 @@
   "description": "State-based routing for Angular 2",
   "version": "1.0.0-beta.4",
   "scripts": {
-    "clean": "shx rm -rf lib lib-esm _bundles _doc",
-    "build": "npm run clean && node_modules/.bin/ngc && node_modules/.bin/ngc -p tsconfig.esm.json && webpack",
-    "test": "karma start config/karma.ng2.js",
-    "docs": "typedoc --tsconfig tsconfig.typedoc.json --readme README.md --name 'ui-router-ng2' --theme node_modules/ui-router-typedoc-themes/bin/default --out _doc --internal-aliases internal,coreapi,ng2api --external-aliases internalapi,external --navigation-label-globals ui-router-ng2"
+    "clean": "shx rm -rf lib lib-esm _bundles _dec",
+    "compile": "npm run clean && ngc",
+    "bundle": "rollup -c && rollup -c --environment MINIFY",
+    "build": "npm run compile && npm run bundle",
+    "docs": "typedoc --tsconfig tsconfig.typedoc.json --readme README.md --name 'ui-router-ng2' --theme node_modules/ui-router-typedoc-themes/bin/default --out _doc --internal-aliases internal,coreapi,ng2api --external-aliases internalapi,external --navigation-label-globals ui-router-ng2",
+    "prepublish": "npm run build"
   },
   "homepage": "https://ui-router.github.io/ng2",
   "contributors": [
-    {
-      "name": "Nate Abele",
-      "email": "[email protected]",
-      "web": "https://radify.io"
-    },
     {
       "name": "Chris Thielen",
       "web": "https://github.com/christopherthielen"
-    },
-    {
-      "name": "Tim Kindberg",
-      "web": "https://github.com/timkindberg"
-    },
-    {
-      "name": "Karsten Sperling",
-      "web": "https://github.com/ksperling"
     }
   ],
   "maintainers": [
@@ -42,18 +31,20 @@
     "url": "https://github.com/ui-router/ng2/issues"
   },
   "engines": {
-    "node": ">4"
+    "node": ">6"
   },
   "license": "MIT",
-  "jsnext:main": "lib-esm/ng2.js",
-  "main": "lib/ng2.js",
-  "typings": "lib/ng2.d.ts",
+  "main": "_bundles/ui-router-ng2.js",
+  "module": "lib/index.js",
+  "typings": "lib/index.d.ts",
   "dependencies": {
-    "ui-router-core": "=1.0.1"
+    "ui-router-core": "=4.0.0",
+    "ui-router-rx": "=0.2.1"
   },
   "peerDependencies": {
-    "@angular/core": "^2.0.0",
-    "@angular/common": "^2.0.0"
+    "@angular/common": "^2.3.1",
+    "@angular/core": "^2.3.1",
+    "@angular/router": "^3.3.1"
   },
   "devDependencies": {
     "@angular/common": "^2.3.1",
@@ -63,9 +54,12 @@
     "@angular/platform-browser": "^2.3.1",
     "@angular/platform-browser-dynamic": "^2.3.1",
     "@angular/platform-server": "^2.3.1",
+    "@angular/router": "^3.3.1",
     "@types/jasmine": "^2.2.34",
     "@types/jquery": "^1.10.31",
     "awesome-typescript-loader": "^2.2.4",
+    "babel-core": "^6.22.1",
+    "babel-loader": "^6.2.10",
     "conventional-changelog": "^1.1.0",
     "conventional-changelog-cli": "^1.1.1",
     "jasmine-core": "^2.4.1",
@@ -76,6 +70,13 @@
     "karma-phantomjs-launcher": "^1.0.2",
     "karma-script-launcher": "~0.1.0",
     "karma-systemjs": "^0.7.2",
+    "rollup": "^0.41.4",
+    "rollup-plugin-commonjs": "^7.0.0",
+    "rollup-plugin-node-resolve": "^2.0.0",
+    "rollup-plugin-progress": "^0.2.1",
+    "rollup-plugin-sourcemaps": "^0.4.1",
+    "rollup-plugin-uglify": "^1.0.1",
+    "rollup-plugin-visualizer": "^0.2.0",
     "rxjs": "5.0.0-beta.12",
     "shelljs": "^0.7.0",
     "shx": "^0.1.4",
@@ -87,8 +88,9 @@
     "typedoc-plugin-ui-router": "^1.0.0",
     "typescript": "~2.0.3",
     "ui-router-typedoc-themes": "^1.0.0",
-    "webpack": "1.x",
-    "webpack-dev-server": "1.x",
+    "webpack": "2.2.0",
+    "webpack-dev-server": "2.2.0",
+    "webpack-visualizer-plugin": "^0.1.10",
     "zone.js": "^0.6.21"
   }
 }

rollup.config.js

@@ -0,0 +1,97 @@
+import nodeResolve from 'rollup-plugin-node-resolve';
+import uglify from 'rollup-plugin-uglify';
+import progress from 'rollup-plugin-progress';
+import sourcemaps from 'rollup-plugin-sourcemaps';
+import visualizer from 'rollup-plugin-visualizer';
+import commonjs from 'rollup-plugin-commonjs';
+
+let MINIFY = process.env.MINIFY;
+
+let pkg = require('./package.json');
+let banner =
+`/**
+ * ${pkg.description}
+ * @version v${pkg.version}
+ * @link ${pkg.homepage}
+ * @license MIT License, http://www.opensource.org/licenses/MIT
+ */`;
+
+let uglifyOpts = { output: {} };
+// retain multiline comment with @license
+uglifyOpts.output.comments = (node, comment) =>
+comment.type === 'comment2' && /@license/i.test(comment.value);
+
+let plugins = [
+  nodeResolve({jsnext: true}),
+  progress(),
+  sourcemaps(),
+  commonjs(),
+];
+
+if (MINIFY) plugins.push(uglify(uglifyOpts));
+if (MINIFY) plugins.push(visualizer({ sourcemap: true }));
+
+let extension = MINIFY ? '.min.js' : '.js';
+
+// Suppress this error message... there are hundreds of them. Angular team says to ignore it.
+// https://github.com/rollup/rollup/wiki/Troubleshooting#this-is-undefined
+function onwarn(warning) {
+  if (warning.code === 'THIS_IS_UNDEFINED') return;
+  console.error(warning.message);
+}
+
+function isExternal(id) {
+  // All rxjs and @angular/* should be external
+  // except for @angular/router/src/router_config_loader
+  let externals = [ /^rxjs/, /^@angular\/(?!router\/src\/router_config_loader)/, ];
+  return externals.map(regex => regex.exec(id)).reduce((acc, val) => acc || !!val, false);
+}
+
+const CONFIG = {
+  moduleName: 'ui-router-ng2',
+  entry: 'lib/index.js',
+  dest: '_bundles/ui-router-ng2' + extension,
+
+  sourceMap: true,
+  format: 'umd',
+  exports: 'named',
+  plugins: plugins,
+  banner: banner,
+
+  onwarn: onwarn,
+  external: isExternal,
+
+  globals: {
+    'rxjs/ReplaySubject': 'Rx',
+
+    // Copied these from @angular/router rollup config
+    'rxjs/BehaviorSubject': 'Rx',
+    'rxjs/Observable': 'Rx',
+    'rxjs/Subject': 'Rx',
+    'rxjs/Subscription': 'Rx',
+    'rxjs/util/EmptyError': 'Rx',
+
+    'rxjs/observable/from': 'Rx.Observable',
+    'rxjs/observable/fromPromise': 'Rx.Observable',
+    'rxjs/observable/forkJoin': 'Rx.Observable',
+    'rxjs/observable/of': 'Rx.Observable',
+
+    'rxjs/operator/toPromise': 'Rx.Observable.prototype',
+    'rxjs/operator/map': 'Rx.Observable.prototype',
+    'rxjs/operator/mergeAll': 'Rx.Observable.prototype',
+    'rxjs/operator/concatAll': 'Rx.Observable.prototype',
+    'rxjs/operator/mergeMap': 'Rx.Observable.prototype',
+    'rxjs/operator/reduce': 'Rx.Observable.prototype',
+    'rxjs/operator/every': 'Rx.Observable.prototype',
+    'rxjs/operator/first': 'Rx.Observable.prototype',
+    'rxjs/operator/catch': 'Rx.Observable.prototype',
+    'rxjs/operator/last': 'Rx.Observable.prototype',
+    'rxjs/operator/filter': 'Rx.Observable.prototype',
+    'rxjs/operator/concatMap': 'Rx.Observable.prototype',
+    
+    '@angular/core': 'ng.core',
+    '@angular/common': 'ng.common',
+  }
+};
+
+export default CONFIG;

scripts/release.js

@@ -1,12 +1,16 @@
 #!env node
 "use strict";
 
+let version = require('../package.json').version;
+
 require('shelljs/global');
 let readlineSync = require('readline-sync');
+let fs = require('fs');
+let path = require('path');
 let util = require('./util');
 let _exec = util._exec;
 
-let version = require('../package.json').version;
+cd(path.join(__dirname, '..'));
 
 if (!readlineSync.keyInYN('Did you bump the version number in package.json?')) {
   process.exit(1);
@@ -16,12 +20,24 @@ if (!readlineSync.keyInYN('Did you update CHANGELOG.md using scripts/update_chan
   process.exit(1);
 }
 
-if (!readlineSync.keyInYN('Did you commit/push all changes back to origin?')) {
+if (!readlineSync.keyInYN('Did you push all changes back to origin?')) {
+  process.exit(1);
+}
+
+if (!readlineSync.keyInYN('Ready to publish?')) {
   process.exit(1);
 }
 
 util.ensureCleanMaster('master');
+
+_exec('npm run package');
+_exec(`npm run docs`);
+
+// publish to npm first
 _exec(`npm publish`);
+
+// then tag and push tag
 _exec(`git tag ${version}`);
 _exec(`git push origin ${version}`);
 
+console.log("\n\nAPI docs generated (but not deployed) at ./_docs");