refactor: break the schematics into a separate NPM package

Splaktar · Splaktar · commit 2a07bb5aa121 · 2018-10-08T03:46:45.000-04:00
add readme files
fix tests
diff --git a/.gitignore b/.gitignore
@@ -1,9 +1,9 @@
 # See http://help.github.com/ignore-files/ for more about ignoring files.
 
 # compiled output
-projects/*/src/**/*.js
-projects/*/src/**/*.js.map
-projects/*/src/**/*.d.ts
+projects/schematics/src/**/*.js
+projects/schematics/src/**/*.js.map
+projects/schematics/src/**/*.d.ts
 /dist
 /tmp
 /out-tsc
diff --git a/README.md b/README.md
@@ -1,18 +1,29 @@
-# DevDemo
+# DevIntent Application Development Tools
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 7.0.0-rc.2.
+This root project contains a demo app, in [src/](src/), that demonstrates the features of the
+[@devintent/dev](projects/dev) application development library.
+
+This repository also includes [@devintent/schematics](projects/schematics) which provide code generation
+based upon the modules in the `@devintent/dev` library.
 
 ## Development server
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+Run `npm start` to serve the demo app in a dev server.
+Navigate to `http://localhost:4200/`.
+The app will automatically reload if you change any of the source files.
 
 ## Code scaffolding
 
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+Run `ng generate component component-name` to generate a new component. You can also use
+`ng generate directive|pipe|service|class|guard|interface|enum|module`.
 
 ## Build
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
+- Run `npm run build` to build the demo project.
+The build artifacts will be stored in the `dist/dev-demo` directory.
+- Run `npm run build:lib` to build the library project.
+The build artifacts will be stored in the `dist/dev` directory.
+- Run `npm run build:schematics` to build the schematics project.
 
 ## Running unit tests
 
diff --git a/package.json b/package.json
@@ -3,12 +3,14 @@
   "version": "0.0.1",
   "scripts": {
     "ng": "ng",
-    "start": "ng serve",
-    "copy:schematics": "cp -r ./projects/dev/src/schematics/* ./dist/dev/schematics",
-    "build": "ng build",
-    "build:schematics": "tsc -p ./projects/dev/src/schematics/.tsconfig.json && npm run copy:schematics",
-    "build:lib": "ng build dev && npm run build:schematics",
-    "test": "ng test",
+    "start": "ng serve dev-demo",
+    "build": "ng build dev-demo",
+    "build:lib": "ng build dev",
+    "build:schematics": "tsc -p ./projects/schematics/tsconfig.json",
+    "publish:lib": "npm run lint && npm run build:lib && npm publish ./dist/dev --access public",
+    "publish:schematics": "npm run build:schematics && npm publish ./projects/schematics --access public",
+    "test": "ng test && npm run test:schematics",
+    "test:schematics": "npm run build:schematics && jasmine ./projects/schematics/src/**/*_spec.js",
     "lint": "ng lint",
     "e2e": "ng e2e"
   },
diff --git a/projects/dev/.npmignore b/projects/dev/.npmignore
diff --git a/projects/dev/README.md b/projects/dev/README.md
@@ -0,0 +1,6 @@
+# DevIntent Application Development Library
+
+This library is still in the experimental phase.
+
+The goal is to compose lower level Angular Material components into higher level components that
+are built with a focus on rapid application development.
diff --git a/projects/dev/karma.conf.js b/projects/dev/karma.conf.js
@@ -24,8 +24,8 @@ module.exports = function(config) {
     port: 9876,
     colors: true,
     logLevel: config.LOG_INFO,
-    autoWatch: true,
+    autoWatch: false,
     browsers: ['Chrome'],
-    singleRun: false
+    singleRun: true
   });
 };
diff --git a/projects/dev/package.json b/projects/dev/package.json
@@ -1,13 +1,13 @@
 {
   "name": "@devintent/dev",
-  "version": "0.0.1",
-  "description": "Application Development Library and Schematics",
+  "version": "0.0.2",
+  "description": "Application Development Library",
   "keywords": [
-    "schematics", "material", "design", "angular", "material design", "components"
+    "material", "design", "angular", "material design", "components"
   ],
   "author": "Michael Prentice",
   "license": "MIT",
-  "schematics": "./schematics/collection.json",
+  "private": false,
   "dependencies": {
     "tslib": "^1.9.3"
   },
diff --git a/projects/dev/src/schematics/.tsconfig.json b/projects/dev/src/schematics/.tsconfig.json
diff --git a/projects/schematics/README.md b/projects/schematics/README.md
@@ -0,0 +1,7 @@
+# DevIntent Application Development Schematics
+
+These schematics are still in the experimental phase.
+
+These schematics generate code that leverages the components in the
+[@devintent/dev](https://www.npmjs.com/package/@devintent/dev) application development library.
+The goal is to increase developer productivity, especially when starting a new project.
diff --git a/projects/schematics/package.json b/projects/schematics/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "@devintent/schematics",
+  "version": "0.0.1",
+  "description": "Application Development Schematics",
+  "keywords": [
+    "schematics", "material", "design", "angular", "material design", "components"
+  ],
+  "author": "Michael Prentice",
+  "license": "MIT",
+  "private": false,
+  "schematics": "./src/collection.json"
+}
diff --git a/projects/schematics/src/blank/index.ts b/projects/schematics/src/blank/index.ts
@@ -1,6 +1,5 @@
 import {Rule, SchematicContext, Tree} from '@angular-devkit/schematics';
 
-
 // You don't have to export the function as default. You can also have more than one rule factory
 // per file.
 export default function blank(_options: any): Rule {
diff --git a/projects/schematics/src/blank/index_spec.ts b/projects/schematics/src/blank/index_spec.ts
diff --git a/projects/schematics/src/collection.json b/projects/schematics/src/collection.json
@@ -1,5 +1,5 @@
 {
-  "$schema": "../../../node_modules/@angular-devkit/schematics/collection-schema.json",
+  "$schema": "../node_modules/@angular-devkit/schematics/collection-schema.json",
   "schematics": {
     "blank": {
       "description": "A blank schematic.",
diff --git a/projects/schematics/tsconfig.json b/projects/schematics/tsconfig.json
@@ -0,0 +1,35 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "baseUrl": "tsconfig",
+    "lib": [
+      "es2018",
+      "dom"
+    ],
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "noEmitOnError": false,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "noUnusedParameters": true,
+    "noUnusedLocals": true,
+    "rootDir": "src/",
+    "skipDefaultLibCheck": true,
+    "strictNullChecks": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "target": "es6",
+    "types": [
+      "jasmine",
+      "node"
+    ]
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    // Exclude template files that will be copied by the schematics. Those are not valid TS.
+    "src/*/files/**/*"
+  ]
+}
diff --git a/src/app/app.component.spec.ts b/src/app/app.component.spec.ts
@@ -1,11 +1,13 @@
 import {async, TestBed} from '@angular/core/testing';
+import {DevComponent} from '../../projects/dev/src/lib/dev.component';
 import {AppComponent} from './app.component';
 
 describe('AppComponent', () => {
   beforeEach(async(() => {
     TestBed.configureTestingModule({
       declarations: [
-        AppComponent
+        AppComponent,
+        DevComponent
       ],
     }).compileComponents();
   }));
@@ -15,17 +17,4 @@ describe('AppComponent', () => {
     const app = fixture.debugElement.componentInstance;
     expect(app).toBeTruthy();
   });
-
-  it(`should have as title 'dev-demo'`, () => {
-    const fixture = TestBed.createComponent(AppComponent);
-    const app = fixture.debugElement.componentInstance;
-    expect(app.title).toEqual('dev-demo');
-  });
-
-  it('should render title in a h1 tag', () => {
-    const fixture = TestBed.createComponent(AppComponent);
-    fixture.detectChanges();
-    const compiled = fixture.debugElement.nativeElement;
-    expect(compiled.querySelector('h1').textContent).toContain('Welcome to dev-demo!');
-  });
 });
diff --git a/src/karma.conf.js b/src/karma.conf.js
@@ -24,8 +24,8 @@ module.exports = function(config) {
     port: 9876,
     colors: true,
     logLevel: config.LOG_INFO,
-    autoWatch: true,
+    autoWatch: false,
     browsers: ['Chrome'],
-    singleRun: false
+    singleRun: true
   });
 };
