chore(*): Rename npm package from ui-router-ng2 to @uirouter/angular its just angular

Author: christopherthielen

.travis.yml

@@ -13,19 +13,19 @@ matrix:
 
 env:
   matrix:
-    # CORE_BRANCH env variable specifies the branch of ui-router-core to use during build/test
+    # CORE_BRANCH env variable specifies the branch of @uirouter/core to use during build/test
     # Each CORE_BRANCH listed here will trigger a SEPARATE job in travis
     - CORE_BRANCH=master
 
-    # If CORE_BRANCH is empty, it will use the ui-router-core from npm dependencies
+    # If CORE_BRANCH is empty, it will use the @uirouter/core from npm dependencies
     # (as specified in package.json)
     - CORE_BRANCH=
 
 script:
   - echo "CORE_BRANCH = x${CORE_BRANCH}x";
   - >
     if [ "x${CORE_BRANCH}x" != "xx" ] ; then
-      echo "Installing ui-router-core from ${CORE_BRANCH}" && \
+      echo "Installing @uirouter/core from ${CORE_BRANCH}" && \
       git clone --depth=10 --branch="${CORE_BRANCH}" https://github.com/ui-router/core.git ui-router-core && \
       pushd ui-router-core && \
       npm install && \

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 # Report an Issue
 
 Help us make UI-Router better! If you think you might have found a bug, or some other weirdness, start by making sure
-it hasn't already been reported. You can [search through existing ui-router-ng2 issues](https://github.com/ui-router/ng2?search?q=wat%3F&type=Issues) and [ui-router-core issues](https://github.com/ui-router/core?search?q=wat%3F&type=Issues)
+it hasn't already been reported. You can [search through existing @uirouter/angular issues](https://github.com/ui-router/ng2?search?q=wat%3F&type=Issues) and [@uirouter/core issues](https://github.com/ui-router/core?search?q=wat%3F&type=Issues)
 to see if someone's reported one similar to yours.
 
 If not, then [create a plunkr](http://bit.ly/UIR-Plunk) that demonstrates the problem (try to use as little code
@@ -14,7 +14,7 @@ that plunkr you created!
 
 **Note**: If you're unsure how a feature is used, or are encountering some unexpected behavior that you aren't sure
 is a bug, it's best to talk it out on
-[StackOverflow](http://stackoverflow.com/questions/ask?tags=angular2,ui-router-ng2) before reporting it. This
+[StackOverflow](http://stackoverflow.com/questions/ask?tags=angular2,@uirouter/angular) before reporting it. This
 keeps development streamlined, and helps us focus on building great software.
 
 
@@ -47,50 +47,53 @@ Please keep in mind that the issue tracker is for *issues*. Please do *not* post
 
 The code for `ui-router-ng2` is split into two source repositories:
 
-* [UI-Router Core](https://github.com/ui-router/core) (`ui-router-core` on npm)
+* [UI-Router Core](https://github.com/ui-router/core) (`@uirouter/core` on npm)
 * [UI-Router for Angular 2](https://github.com/ui-router/ng2) (`ui-router-ng2` on npm)
 
 Clone both repositories into directories next to each other.
 
 ```
-git clone https://github.com/ui-router/ng2.git ui-router-ng2
-git clone https://github.com/ui-router/core.git ui-router-core
+mkdir uirouter
+cd uirouter
+git clone https://github.com/ui-router/ng2.git
+git clone https://github.com/ui-router/core.git
 ```
 
 ## Install dependencies
 
 Use `npm` to install the development dependencies for each repository.
 
 ```
-cd ui-router-core
+cd core
 npm install
-cd ../ui-router-ng2
+cd ../ng2
 npm install
 cd ..
 ```
 
 ## Link the directories
 
-This step is necessary if you need to modify any code in `ui-router-core`.
-Using `npm`, link `ui-router-core` into `ui-router-ng2`
+This step is necessary if you need to modify any code in `@uirouter/core`.
+Using `npm`, link `@uirouter/core` into `ui-router-ng2`
 
 ```
-cd ui-router-core
+cd core
 npm link
-cd ../ui-router-ng2
-npm link ui-router-core
+cd ../ng2
+npm link @uirouter/core
 cd ..
 ```
 
-After executing these steps, `ui-router-ng2` will be built using your local copy of `ui-router-core`.
+After executing these steps, your local copy of `@uirouter/angular` will be built using your local copy of `@uirouter/core`
+instead of the prebuilt version specified in `package.json`.
 
 ## Develop
 
 * `npm run build`: Perform a full build.
 * `npm run watch`: Continuously builds and runs tests when source or tests change.
 
-If you make changes in `ui-router-core`, run these scripts before rebuilding or re-testing `ui-router-ng2`:
+If you make changes in `@uirouter/core`, run these scripts before rebuilding or re-testing `@uirouter/angular`:
 
-* `npm run build`: Compiles `ui-router-core` code
-* `npm run watch`: Continuously builds the `ui-router-core` code when sources change.
+* `npm run build`: Compiles `@uirouter/core` code
+* `npm run watch`: Continuously builds the `@uirouter/core` code when sources change.
 

README.md

@@ -1,6 +1,6 @@
 # UI-Router for Angular  [![Build Status](https://travis-ci.org/ui-router/ng2.svg?branch=master)](https://travis-ci.org/ui-router/ng2)
 
-### ui-router-ng2: State based routing for Angular (v2+)
+### @uirouter/angular: State based routing for Angular (v2+)
 
 ---
 **[Tutorials](https://ui-router.github.io/tutorials/)** |
@@ -9,11 +9,11 @@
 **[Sample App](http://ui-router.github.io/resources/sampleapp/) |**
 **[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)**
+**[Help!](http://stackoverflow.com/questions/ask?tags=@uirouter/angular)**
 
 ---
 
-ui-router-ng2 is a client-side [Single Page Application](https://en.wikipedia.org/wiki/Single-page_application) 
+@uirouter/angular 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 

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/index.ts'
+        '@uirouter/angular': 'src/index.ts'
     },
     map: {
         '@uirouter/core': 'node_modules/@uirouter/core/lib',

migrate/migrate.json

@@ -0,0 +1,4 @@
+{
+  "old": "ui-router-ng2",
+  "new": "@uirouter/angular"
+}

migrate/migratewarn.js

@@ -0,0 +1,10 @@
+#!env node
+"use strict";
+
+var pkg = require('../package.json');
+var migrate = require('./migrate.json');
+
+if (pkg.name === migrate.old) {
+  var warning = 'WARNING! this npm package "' + migrate.old + '" has moved to "' + migrate.new + '".  Please update your package.json';
+  console.log("\x1b[1m\x1b[37m\x1b[41m%s\x1b[0m", warning);
+}

package.json

@@ -7,12 +7,13 @@
     "compile": "npm run clean && ngc",
     "bundle": "rollup -c && rollup -c --environment MINIFY",
     "build": "npm run compile && npm run bundle",
+    "install": "node ./migrate/migratewarn.js",
     "travis": "npm run build && npm run noimplicitany && npm run test",
     "test": "karma start",
     "noimplicitany": "tsc --noEmit --noImplicitAny --moduleResolution node --target es6 test/noimplicitany.ts",
     "debug": "karma start --singleRun=false --autoWatch=true --autoWatchInterval=1 --browsers=Chrome",
     "package": "npm run build",
-    "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",
+    "docs": "typedoc --tsconfig tsconfig.typedoc.json --readme README.md --name '@uirouter/angular' --theme node_modules/ui-router-typedoc-themes/bin/default --out _doc --internal-aliases internal,coreapi,ng2api --external-aliases internalapi,external --navigation-label-globals @uirouter/angular",
     "prepublish": "npm run build",
     "changelog": "node scripts/update_changelog.js",
     "release": "node scripts/release.js",

rollup.config.js

@@ -54,7 +54,7 @@ function isExternal(id) {
 }
 
 const CONFIG = {
-  moduleName: 'ui-router-ng2',
+  moduleName: '@uirouter/angular',
   entry: 'lib/index.js',
   dest: '_bundles/ui-router-ng2' + extension,
 

scripts/show_core_changelog.js

@@ -5,12 +5,14 @@ var shelljs = require('shelljs');
 var path = require('path');
 var fs = require('fs');
 
-var CORE_PKG = 'ui-router-core';
-var CORE_DIR = path.join(__dirname, "..", "..", CORE_PKG);
+var CORE = `core`;
+var CORE_PKG = `@uirouter/${CORE}`;
+var CORE_DIR = path.join(__dirname, "..", "..", CORE);
 var SHOWCHANGELOG_SCRIPT = path.join(CORE_DIR, "scripts", "show_changelog.js");
 
 var currentPackage = require('../package.json');
 if (!currentPackage.dependencies || !currentPackage.dependencies[CORE_PKG]) {
+  console.error(stringify(currentPackage.dependencies));
   throw new Error("No dependency on " + CORE_PKG + " found in package.json.")
 }
 
@@ -33,15 +35,17 @@ gitSemverTags(function (err, val) {
     try {
       prevPackage = JSON.parse(prevRaw);
     } catch (error) {
-      console.error("Unable to parse previous package.json");
+      console.error("Unable to parse previous package.json in ${val[0]}");
       console.error(prevRaw);
       throw error;
     }
 
     if (!prevPackage.dependencies) {
-      throw new Error("previous package.json has no `dependencies` key.");
+      console.error(stringify(prevPackage));
+      throw new Error(`previous package.json in ${val[0]} has no "dependencies" key.`);
     } else if (!prevPackage.dependencies[CORE_PKG]) {
-      throw new Error("previous package.json has no `dependencies['ui-router-core']` key.");
+      console.error(stringify(prevPackage.dependencies));
+      throw new Error(`previous package.json in ${val[0]} has no "dependencies['${CORE_PKG}']" key.`);
     }
 
     fromTag = prevPackage.dependencies[CORE_PKG].replace(/[=~^]/, "");
@@ -53,3 +57,8 @@ gitSemverTags(function (err, val) {
   shelljs.config.silent = false;
   shelljs.exec("node " + SHOWCHANGELOG_SCRIPT + " " + fromTag + " " + toTag)
 });
+
+
+function stringify(object) {
+  return JSON.stringify(object, null, 2);
+}

src/providers.ts

@@ -1,17 +1,17 @@
 /**
  * # UI-Router for Angular (v2+)
  *
- * - [ui-router-ng2 home page](https://ui-router.github.io/ng2)
+ * - [@uirouter/angular home page](https://ui-router.github.io/ng2)
  * - [tutorials](https://ui-router.github.io/tutorial/ng2/helloworld)
  * - [quick start repository](http://github.com/ui-router/quickstart-ng2)
  *
  * Getting started:
  *
- * - Use npm. Add a dependency on latest `ui-router-ng2`
- * - Import UI-Router classes directly from `"ui-router-ng2"`
+ * - Use npm. Add a dependency on latest `@uirouter/angular`
+ * - Import UI-Router classes directly from `"@uirouter/angular"`
  *
  * ```js
- * import {StateRegistry} from "ui-router-ng2";
+ * import {StateRegistry} from "@uirouter/angular";
  * ```
  *
  * - Create application states (as defined by [[Ng2StateDeclaration]]).
@@ -71,7 +71,7 @@
  * Pass the class to [[UIRouterModule.forRoot]] or [[UIRouterModule.forChild]].
  *
  * ```js
- * import {UIRouter} from "ui-router-ng2";
+ * import {UIRouter} from "@uirouter/angular";
  *
  * @ Injectable()
  * export class MyUIRouterConfig {

src/statebuilders/lazyLoad.ts

@@ -22,7 +22,7 @@ import { loadNgModule } from "../lazyLoad/lazyLoadNgModule";
  * ```
  * would build a state with a `lazyLoad` function like:
  * ```js
- * import { loadNgModule } from "ui-router-ng2";
+ * import { loadNgModule } from "@uirouter/angular";
  * var decl = {
  *   lazyLoad: loadNgModule(() => System.import('./childModule.ts')
  * }
@@ -39,7 +39,7 @@ import { loadNgModule } from "../lazyLoad/lazyLoadNgModule";
  * ```
  * would build a state with a `lazyLoad` function like:
  * ```js
- * import { loadNgModule } from "ui-router-ng2";
+ * import { loadNgModule } from "@uirouter/angular";
  * var decl = {
  *   lazyLoad: () => System.import('third-party-library')
  *       .then(() => loadNgModule(() => System.import('./childModule.ts'))

src/statebuilders/views.ts

@@ -11,7 +11,7 @@ import {ViewService} from "@uirouter/core";
  * This is a [[StateBuilder.builder]] function for Angular `views`.
  *
  * When the [[StateBuilder]] builds a [[State]] object from a raw [[StateDeclaration]], this builder
- * handles the `views` property with logic specific to ui-router-ng2.
+ * handles the `views` property with logic specific to @uirouter/angular.
  *
  * If no `views: {}` property exists on the [[StateDeclaration]], then it creates the `views` object and
  * applies the state-level configuration to a view named `$default`.

src/uiRouterNgModule.ts

@@ -197,7 +197,7 @@ export interface StatesModule {
    * #### Example:
    * ```js
    * import { Injector } from "@angular/core";
-   * import { UIRouter } from "ui-router-ng2";
+   * import { UIRouter } from "@uirouter/angular";
    * import { requireAuthHook } from "./requireAuthHook";
    * import { MyService } from "./myService";
    *

test/index.js

@@ -15,7 +15,7 @@ require('zone.js/dist/fake-async-test');
 // Init testing harness
 require('./bootstrap');
 
-// Add ui-router-ng2
+// Add @uirouter/angular
 require('../src/index');
 
 var testsContext = require['context'](".", true, /\.spec$/);

tsconfig.typedoc.json

@@ -11,7 +11,7 @@
   },
   "files": [
     "src/index.ts",
-    "../ui-router-core/src/index.ts",
+    "../core/src/index.ts",
     "node_modules/typescript/lib/lib.es6.d.ts"
   ]
 }