refactor: rename package to @angular-component/router (#80)

Closes #65

Author: brandonroberts

.circleci/config.yml

@@ -31,7 +31,7 @@ jobs:
       - restore_cache:
           keys:
             - *cache_key
-      - run: yarn nx build angular-routing --prod
+      - run: yarn build
 
   test:
     <<: *run_in_node
@@ -40,7 +40,7 @@ jobs:
       - restore_cache:
           keys:
             - *cache_key
-      - run: yarn nx test angular-routing
+      - run: yarn test
 
   test-e2e:
     <<: *run_in_browser
@@ -49,7 +49,7 @@ jobs:
       - restore_cache:
           keys:
             - *cache_key
-      - run: yarn nx e2e example-app-e2e
+      - run: yarn affected:e2e --base=origin/master
 
 workflows:
   version: 2

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Brandon Roberts
+Copyright (c) 2020-2021 Brandon Roberts
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,4 +1,4 @@
-# Angular Routing
+# Angular Component Router
 
 [![npm version](https://img.shields.io/npm/v/angular-routing.svg)](https://www.npmjs.com/package/angular-routing)
 
@@ -15,36 +15,36 @@
 Use your package manager of choice to install the package.
 
 ```sh
-npm install angular-routing
+npm install @angular-component/router
 ```
 
 OR
 
 ```sh
-yarn add angular-routing
+yarn add @angular-component/router
 ```
 
 ## Installation with ng add
 
 You can use ng add to install the package by using the command below.
 
 ```sh
-ng add angular-routing
+ng add @angular-component/router
 ```
 
-The above command will install the package, and add the RoutingModule import in the AppModule.
+The above command will install the package, and add the ComponentRouterModule import in the AppModule.
 
 ## Usage
 
-To register the Router, add the `RoutingModule.forRoot()` to your AppModule imports.
+To register the Router, add the `ComponentRouterModule.forRoot()` to your AppModule imports.
 
 ```ts
-import { RoutingModule } from 'angular-routing';
+import { ComponentRouterModule } from '@angular-component/router';
 
 @NgModule({
   imports: [
     // ... other imports
-    RoutingModule.forRoot(),
+    ComponentRouterModule.forRoot(),
   ],
 })
 export class AppModule {}
@@ -53,12 +53,12 @@ export class AppModule {}
 Or in a feature module
 
 ```ts
-import { RoutingModule } from 'angular-routing';
+import { ComponentRouterModule } from '@angular-component/router';
 
 @NgModule({
   imports: [
     // ... other imports
-    RoutingModule,
+    ComponentRouterModule,
   ],
 })
 export class FeatureModule {}
@@ -170,7 +170,7 @@ To navigate from a component class, or get global route information, such as the
 
 ```ts
 import { Component } from '@angular/core';
-import { Router } from 'angular-routing';
+import { Router } from '@angular-component/router';
 
 @Component({...})
 export class MyComponent {
@@ -201,7 +201,7 @@ To get the route params, inject the `RouteParams` observable. Provide a type for
 
 ```ts
 import { Component } from '@angular/core';
-import { RouteParams } from 'angular-routing';
+import { RouteParams } from '@angular-component/router';
 
 @Component({...})
 export class MyComponent {
@@ -221,7 +221,7 @@ To get the route params, inject the `QueryParams` observable. Provide a type for
 
 ```ts
 import { Component } from '@angular/core';
-import { QueryParams } from 'angular-routing';
+import { QueryParams } from '@angular-component/router';
 
 @Component({...})
 export class MyComponent {
@@ -260,7 +260,7 @@ Register a component to register the child routes.
 
 ```ts
 import { NgModule, Component } from '@angular/core';
-import { ModuleWithRoute } from 'angular-routing';
+import { ModuleWithRoute } from '@angular-component/router';
 
 @Component({
   template: `

angular.json

@@ -1,21 +1,21 @@
 {
   "version": 1,
   "projects": {
-    "angular-routing": {
+    "router": {
       "projectType": "library",
-      "root": "libs/angular-routing",
-      "sourceRoot": "libs/angular-routing/src",
+      "root": "libs/router",
+      "sourceRoot": "libs/router/src",
       "prefix": "reactiveangular",
       "architect": {
         "build-package": {
           "builder": "@nrwl/angular:package",
           "options": {
-            "tsConfig": "libs/angular-routing/tsconfig.lib.json",
-            "project": "libs/angular-routing/ng-package.json"
+            "tsConfig": "libs/router/tsconfig.lib.json",
+            "project": "libs/router/ng-package.json"
           },
           "configurations": {
             "production": {
-              "tsConfig": "libs/angular-routing/tsconfig.lib.prod.json"
+              "tsConfig": "libs/router/tsconfig.lib.prod.json"
             }
           }
         },
@@ -25,10 +25,10 @@
             "parallel": false,
             "commands": [
               {
-                "command": "ng run angular-routing:build-package"
+                "command": "ng run router:build-package"
               },
               {
-                "command": "yarn tsc -p libs/angular-routing/tsconfig.schematics.json"
+                "command": "yarn tsc -p libs/router/tsconfig.schematics.json"
               }
             ]
           }
@@ -37,19 +37,19 @@
           "builder": "@angular-devkit/build-angular:tslint",
           "options": {
             "tsConfig": [
-              "libs/angular-routing/tsconfig.lib.json",
-              "libs/angular-routing/tsconfig.spec.json"
+              "libs/router/tsconfig.lib.json",
+              "libs/router/tsconfig.spec.json"
             ],
-            "exclude": ["**/node_modules/**", "!libs/angular-routing/**/*"]
+            "exclude": ["**/node_modules/**", "!libs/router/**/*"]
           }
         },
         "test": {
           "builder": "@nrwl/jest:jest",
           "options": {
-            "jestConfig": "libs/angular-routing/jest.config.js",
-            "tsConfig": "libs/angular-routing/tsconfig.spec.json",
+            "jestConfig": "libs/router/jest.config.js",
+            "tsConfig": "libs/router/tsconfig.spec.json",
             "passWithNoTests": true,
-            "setupFile": "libs/angular-routing/src/test-setup.ts"
+            "setupFile": "libs/router/src/test-setup.ts"
           }
         }
       },
@@ -548,5 +548,5 @@
       "unitTestRunner": "jest"
     }
   },
-  "defaultProject": "angular-routing"
+  "defaultProject": "router"
 }

apps/example-app/src/app/app.module.ts

@@ -3,7 +3,7 @@ import { CommonModule } from '@angular/common';
 import { HttpClientModule } from '@angular/common/http';
 import { BrowserModule } from '@angular/platform-browser';
 import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
-import { RoutingModule } from 'angular-routing';
+import { ComponentRouterModule } from '@angular-component/router';
 
 import { StoreModule } from '@ngrx/store';
 import { EffectsModule } from '@ngrx/effects';
@@ -21,7 +21,7 @@ import { AppComponent } from '@example-app/core/containers';
     BrowserModule,
     BrowserAnimationsModule,
     HttpClientModule,
-    RoutingModule.forRoot(),
+    ComponentRouterModule.forRoot(),
 
     /**
      * StoreModule.forRoot is imported once in the root module, accepting a reducer

apps/example-app/src/app/auth/effects/auth.effects.spec.ts

@@ -1,6 +1,6 @@
 import { TestBed } from '@angular/core/testing';
 import { MatDialog } from '@angular/material/dialog';
-import { Router } from 'angular-routing';
+import { Router } from '@angular-component/router';
 import { Actions } from '@ngrx/effects';
 import { provideMockActions } from '@ngrx/effects/testing';
 import { cold, hot } from 'jasmine-marbles';

apps/example-app/src/app/auth/effects/auth.effects.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@angular/core';
 import { MatDialog } from '@angular/material/dialog';
-import { Router } from 'angular-routing';
+import { Router } from '@angular-component/router';
 import { Actions, ofType, createEffect } from '@ngrx/effects';
 import { of } from 'rxjs';
 import { catchError, exhaustMap, map, tap } from 'rxjs/operators';

apps/example-app/src/app/books/books.module.ts

@@ -20,7 +20,10 @@ import {
 
 import { MaterialModule } from '@example-app/material';
 import { PipesModule } from '@example-app/shared/pipes';
-import { RoutingModule, ModuleWithRoute } from 'angular-routing';
+import {
+  ComponentRouterModule,
+  ModuleWithRoute,
+} from '@angular-component/router';
 import { AuthGuard } from '@example-app/auth/services';
 import { BookEffects, CollectionEffects } from '@example-app/books/effects';
 
@@ -70,7 +73,7 @@ export const CONTAINERS = [
   imports: [
     CommonModule,
     MaterialModule,
-    RoutingModule,
+    ComponentRouterModule,
     PipesModule,
     /**
      * StoreModule.forFeature is used for composing state

apps/example-app/src/app/books/containers/collection-page.component.spec.ts

@@ -1,6 +1,6 @@
 import { ComponentFixture, TestBed } from '@angular/core/testing';
 import { NoopAnimationsModule } from '@angular/platform-browser/animations';
-import { RoutingModule } from 'angular-routing';
+import { ComponentRouterModule } from '@angular-component/router';
 
 import { MockStore, provideMockStore } from '@ngrx/store/testing';
 
@@ -23,7 +23,7 @@ describe('Collection Page', () => {
 
   beforeEach(() => {
     TestBed.configureTestingModule({
-      imports: [NoopAnimationsModule, MaterialModule, RoutingModule],
+      imports: [NoopAnimationsModule, MaterialModule, ComponentRouterModule],
       declarations: [
         CollectionPageComponent,
         BookPreviewListComponent,

apps/example-app/src/app/books/containers/find-book-page.component.spec.ts

@@ -1,7 +1,7 @@
 import { ComponentFixture, TestBed } from '@angular/core/testing';
 import { ReactiveFormsModule } from '@angular/forms';
 import { NoopAnimationsModule } from '@angular/platform-browser/animations';
-import { RoutingModule } from 'angular-routing';
+import { ComponentRouterModule } from '@angular-component/router';
 
 import { MockStore, provideMockStore } from '@ngrx/store/testing';
 
@@ -27,7 +27,7 @@ describe('Find Book Page', () => {
     TestBed.configureTestingModule({
       imports: [
         NoopAnimationsModule,
-        RoutingModule,
+        ComponentRouterModule,
         MaterialModule,
         ReactiveFormsModule,
       ],