docs: new docs app (CirclonGroup#865)

Author: tobiasengelhardt

angular.json

@@ -96,7 +96,10 @@
               "projects/example-app/src/favicon.ico",
               "projects/example-app/src/assets"
             ],
-            "styles": ["projects/example-app/src/styles.scss"],
+            "styles": [
+              "./node_modules/@angular/material/prebuilt-themes/indigo-pink.css",
+              "projects/example-app/src/styles.scss"
+            ],
             "scripts": []
           }
         },
@@ -144,6 +147,109 @@
           }
         }
       }
+    },
+    "docs-app": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "style": "scss"
+        }
+      },
+      "root": "projects/docs-app",
+      "sourceRoot": "projects/docs-app/src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:browser",
+          "options": {
+            "outputPath": "dist/docs-app",
+            "index": "projects/docs-app/src/index.html",
+            "main": "projects/docs-app/src/main.ts",
+            "polyfills": "projects/docs-app/src/polyfills.ts",
+            "tsConfig": "projects/docs-app/tsconfig.app.json",
+            "aot": false,
+            "assets": [
+              "projects/docs-app/src/favicon.ico",
+              "projects/docs-app/src/assets"
+            ],
+            "styles": ["projects/docs-app/src/styles.scss"],
+            "scripts": []
+          },
+          "configurations": {
+            "production": {
+              "fileReplacements": [
+                {
+                  "replace": "projects/docs-app/src/environments/environment.ts",
+                  "with": "projects/docs-app/src/environments/environment.prod.ts"
+                }
+              ],
+              "optimization": true,
+              "outputHashing": "all",
+              "sourceMap": false,
+              "extractCss": true,
+              "namedChunks": false,
+              "extractLicenses": true,
+              "vendorChunk": false,
+              "buildOptimizer": true,
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "2mb",
+                  "maximumError": "5mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "6kb",
+                  "maximumError": "10kb"
+                }
+              ]
+            }
+          }
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "options": {
+            "browserTarget": "docs-app:build"
+          },
+          "configurations": {
+            "production": {
+              "browserTarget": "docs-app:build:production"
+            }
+          }
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "browserTarget": "docs-app:build"
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "main": "projects/docs-app/src/test.ts",
+            "polyfills": "projects/docs-app/src/polyfills.ts",
+            "tsConfig": "projects/docs-app/tsconfig.spec.json",
+            "karmaConfig": "projects/docs-app/karma.conf.js",
+            "assets": [
+              "projects/docs-app/src/favicon.ico",
+              "projects/docs-app/src/assets"
+            ],
+            "styles": ["projects/docs-app/src/styles.scss"],
+            "scripts": []
+          }
+        },
+        "lint": {
+          "builder": "@angular-devkit/build-angular:tslint",
+          "options": {
+            "tsConfig": [
+              "projects/docs-app/tsconfig.app.json",
+              "projects/docs-app/tsconfig.spec.json",
+              "projects/docs-app/e2e/tsconfig.json"
+            ],
+            "exclude": ["**/node_modules/**"]
+          }
+        }
+      }
     }
   },
   "defaultProject": "example-app"

package-lock.json

@@ -42,6 +42,8 @@
     "prepublish:lib:win": "npm run build:lib && npm run copy:files:win",
     "start:example-app": "ng serve",
     "start:example-app:es5": "ng serve --configuration=es5",
+    "start:docs-app": "ng serve --project=docs-app",
+    "build:docs-app": "ng build docs-app",
     "example:cli:build": "npm run build && cd example/cli && npm install && cp -rf ../../dist node_modules/angular-tree-component/ && cp src/index.build.html src/index.html && ./node_modules/.bin/ng build --aot && cp src/index.dev.html src/index.html && mkdir -p 500tech/angular-tree-component/master/example/cli/ && cp -rf dist 500tech/angular-tree-component/master/example/cli/",
     "test:ci:local": "testcafe chrome:headless e2e/*.testcafe.js --app \"ng serve\" -r xunit:./xunit/res.xml -c 4 --assertion-timeout 10000 --app-init-delay 20000 --page-load-timeout 10000 --selector-timeout 20000",
     "test:dev": "testcafe chrome:headless e2e/*.testcafe.js",
@@ -59,6 +61,10 @@
     "Adam Klein <adam@500tech.com>"
   ],
   "dependencies": {
+    "@angular/animations": "^10.0.0 || ^11.0.0-0",
+    "@angular/cdk": "^10.1.3",
+    "@angular/forms": "^10.0.0 || ^11.0.0-0",
+    "@angular/material": "^10.1.3",
     "lodash-es": "^4.17.15",
     "mobx": "~4.14.1"
   },
@@ -71,6 +77,7 @@
     "@angular/compiler": "^10.0.4",
     "@angular/compiler-cli": "^10.0.4",
     "@angular/core": "^10.0.4",
+    "@angular/elements": "^10.0.4",
     "@angular/forms": "^10.0.4",
     "@angular/platform-browser": "^10.0.4",
     "@angular/platform-browser-dynamic": "^10.0.4",
@@ -132,11 +139,5 @@
     "*.ts": [
       "tslint"
     ]
-  },
-  "husky": {
-    "hooks": {
-      "post-commit": "git reset",
-      "pre-commit": "lint-staged"
-    }
   }
 }

package.json

@@ -0,0 +1,18 @@
+# This file is used by the build system to adjust CSS and JS output to support the specified browsers below.
+# For additional information regarding the format and rule options, please see:
+# https://github.com/browserslist/browserslist#queries
+
+# For the full list of supported browsers by the Angular framework, please see:
+# https://angular.io/guide/browser-support
+
+# You can see what browsers were selected by your queries by running:
+#   npx browserslist
+
+last 1 Chrome version
+last 1 Firefox version
+last 2 Edge major versions
+last 2 Safari major versions
+last 2 iOS major versions
+Firefox ESR
+not IE 9-10 # Angular support for IE 9-10 has been deprecated and will be removed as of Angular v11. To opt-in, remove the 'not' prefix on this line.
+IE 11 # Angular supports IE 11 only as an opt-in. To opt-in, remove the 'not' prefix on this line.

projects/docs-app/.browserslistrc

@@ -0,0 +1,32 @@
+// Karma configuration file, see link for more information
+// https://karma-runner.github.io/1.0/config/configuration-file.html
+
+module.exports = function(config) {
+  config.set({
+    basePath: '',
+    frameworks: ['jasmine', '@angular-devkit/build-angular'],
+    plugins: [
+      require('karma-jasmine'),
+      require('karma-chrome-launcher'),
+      require('karma-jasmine-html-reporter'),
+      require('karma-coverage-istanbul-reporter'),
+      require('@angular-devkit/build-angular/plugins/karma')
+    ],
+    client: {
+      clearContext: false // leave Jasmine Spec Runner output visible in browser
+    },
+    coverageIstanbulReporter: {
+      dir: require('path').join(__dirname, '../../coverage/docs-app'),
+      reports: ['html', 'lcovonly', 'text-summary'],
+      fixWebpackSourcePaths: true
+    },
+    reporters: ['progress', 'kjhtml'],
+    port: 9876,
+    colors: true,
+    logLevel: config.LOG_INFO,
+    autoWatch: true,
+    browsers: ['Chrome'],
+    singleRun: false,
+    restartOnFileChange: true
+  });
+};

projects/docs-app/karma.conf.js

@@ -0,0 +1,59 @@
+import { NgModule } from '@angular/core';
+import { RouterModule, Routes } from '@angular/router';
+import { GettingStartedComponent } from './getting-started/getting-started.component';
+import { BasicUsageComponent } from './examples/basic-usage/basic-usage.component';
+import { NodesComponent } from './fundamentals/nodes/nodes.component';
+import { OptionsComponent } from './fundamentals/options/options.component';
+import { ActionsComponent } from './fundamentals/actions/actions.component';
+import { TemplatesComponent } from './fundamentals/templates/templates.component';
+import { EventsComponent } from './fundamentals/events/events.component';
+import { StateBindingComponent } from './fundamentals/state-binding/state-binding.component';
+import { ApiComponent } from './fundamentals/api/api.component';
+import { StylingComponent } from './fundamentals/styling/styling.component';
+import { FocusComponent } from './fundamentals/focus/focus.component';
+import { IssuesComponent } from './fundamentals/issues/issues.component';
+
+const routes: Routes = [
+  {
+    path: '',
+    component: GettingStartedComponent,
+    pathMatch: 'full',
+  },
+  {
+    path: 'examples',
+    children: [
+      { path: 'basic', component: BasicUsageComponent }
+    ]
+  },
+  {
+    path: 'fundamentals',
+    children: [
+      { path: 'nodes', component: NodesComponent },
+      { path: 'options', component: OptionsComponent },
+      { path: 'actions', component: ActionsComponent },
+      { path: 'templates', component: TemplatesComponent },
+      { path: 'events', component: EventsComponent },
+      { path: 'state', component: StateBindingComponent },
+      { path: 'api', component: ApiComponent },
+      { path: 'styling', component: StylingComponent },
+      { path: 'focus', component: FocusComponent },
+      { path: 'issues', component: IssuesComponent },
+    ]
+  },
+];
+
+@NgModule({
+  imports: [
+    RouterModule.forRoot(
+      routes,
+      {
+        scrollPositionRestoration: 'enabled'
+      }
+    ),
+  ],
+  exports: [
+    RouterModule,
+  ]
+})
+export class AppRoutingModule {
+}

projects/docs-app/src/app/app-routing.module.ts

@@ -0,0 +1,29 @@
+<mat-toolbar class="toolbar mat-primary">
+    <button mat-icon-button class="example-icon" aria-label="Example icon-button with menu icon" (click)="sidenav.toggle()">
+        <mat-icon>menu</mat-icon>
+    </button>
+    <mat-icon svgIcon="tree-logo" aria-hidden="false" class="main-logo"></mat-icon>
+    <span>Angular Tree Component</span>
+    <span class="example-spacer"></span>
+    <a href="https://github.com/CirclonGroup/angular-tree-component" title="GitHub" target="_blank" class="toolbar-link">
+        <mat-icon svgIcon="github" aria-hidden="false" aria-label="Example thumbs up SVG icon"></mat-icon>
+    </a>
+</mat-toolbar>
+
+<mat-sidenav-container class="sidenav-container">
+    <mat-sidenav #sidenav mode="side" opened class="sidenav">
+        <div class="sidenav-menu">
+            <app-nav-item *ngFor="let navEntry of nav"
+                          [node]="navEntry" [selectedNodes]="currentNodes"></app-nav-item>
+        </div>
+    </mat-sidenav>
+    <mat-sidenav-content class="sidenav-content" [ngClass]="{'sidenav-open': sidenav.opened}">
+        <main role="main" class="main-content">
+            <router-outlet></router-outlet>
+        </main>
+    </mat-sidenav-content>
+</mat-sidenav-container>
+
+<footer>
+    <app-footer></app-footer>
+</footer>