Schematics/markdown folder (#3)

jorgeucano · web-flow · commit d8944103a9f0 · 2019-12-13T11:51:11.000-03:00
* schematics(markdown): add new schematics for support new markdown module/component

* schematics(fix): fix merge error

* schematics(chore): change changelog
diff --git a/changelog.md b/changelog.md
@@ -1,11 +1,11 @@
-# Coulson
+# scully
 
 1.  plugin system is there.
 2.  you can register a new plugin.
 3.  plugins are responsible for validating their on part of the config
 4.  using zonejs to detect page -ready in pupeteer.
-5.  possibilty to provide your own plugins using coulson.custom.ts (not working yet!)
-6.  coulson.custom.ts to provide plugins, and mapping/reducers in config
+5.  possibilty to provide your own plugins using scully.custom.ts (not working yet!)
+6.  scully.custom.ts to provide plugins, and mapping/reducers in config
 7.  parallel generation of pages. (will be batched in future, now everything is generated at once)
 8.  fully automated worflow. end user needs only 1 command.
 9.  easy generating of content (like blogs) traversing folders.
@@ -16,29 +16,26 @@
 
 # Schematics 
 
-------
-working in some issues in rc3
-------
 
-1. ng add @herodevs/coulson-generate
+1. ng add @herodevs/scully-generate
          --blog => create a blog folder with 1 example of md(example with step to step)
-	                add blog module with blog component with coulsonComponent
+	                add blog module with blog component with scullyComponent
 	 
-2. ng add @herodevs/coulson-generate --blog=blog_name
-2. ng add @herodevs/coulson-generate:add-blog 
+2. ng add @herodevs/scully-generate --blog=blog_name
+2. ng add @herodevs/scully-generate:add-blog 
             add new blog post in blog folder
 
 
-3. ng g @herodevs/coulson-generate:add-component
-4. ng g @herodevs/coulson-generate:add-blog blog_name
-5. ng g @herodevs/coulson-generate:blog blog_name
-6. Add coulson to angular.json for add commands into the CLI 
+3. ng g @herodevs/scully-generate:add-component
+4. ng g @herodevs/scully-generate:add-blog blog_name
+5. ng g @herodevs/scully-generate:blog blog_name
+6. Add scully to angular.json for add commands into the CLI 
 
 NEXT:
 - write more commands for 
 - add @latest @next
 
-# Coulson DX
+# scully DX
 
 1. Run with Bazel
 2. Run with node and recreate servers
diff --git a/schematics/scully/scully-init-0.0.0.tgz b/schematics/scully/scully-init-0.0.0.tgz
diff --git a/schematics/scully/src/add-blog/schema.json b/schematics/scully/src/add-blog/schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/schema",
   "id": "add-component",
-  "title": "Coulson add component schematic",
+  "title": "Scully add component schematic",
   "type": "object",
   "properties": {
     "routingScope": {
diff --git a/schematics/scully/src/add-markdown/index.ts b/schematics/scully/src/add-markdown/index.ts
@@ -0,0 +1,22 @@
+import {
+  Rule, Tree, SchematicContext, externalSchematic, chain,
+} from '@angular-devkit/schematics';
+import {RunSchematicTask} from '@angular-devkit/schematics/tasks';
+import { Schema as MyServiceSchema } from './schema';
+// @ts-ignore
+export default function(options: MyServiceSchema): Rule {
+  return (host: Tree, context: SchematicContext) => {
+    return chain([
+      externalSchematic('@schematics/angular', 'module', {
+        name: options.name,
+        route: options.name,
+        routing: true,
+        module: 'app.module.ts'
+      }),
+      // tslint:disable-next-line:no-shadowed-variable
+      (host: Tree, context: SchematicContext) => {
+        context.addTask(new RunSchematicTask('create-markdown', options), []);
+      }]);
+  };
+}
+
diff --git a/schematics/scully/src/add-markdown/schema.json b/schematics/scully/src/add-markdown/schema.json
@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "add-markdown",
+  "title": "Scully add markdown schematic",
+  "type": "object",
+  "properties": {
+    "routingScope": {
+      "enum": ["Child", "Root"],
+      "type": "string",
+      "description": "The scope for the new routing module.",
+      "default": "Child"
+    },
+    "name": {
+      "type": "string",
+      "description": "add the name for the folder and module"
+    }
+  },
+  "required": []
+}
diff --git a/schematics/scully/src/add-markdown/schema.ts b/schematics/scully/src/add-markdown/schema.ts
@@ -0,0 +1,3 @@
+export interface Schema {
+  name: string;
+}
diff --git a/schematics/scully/src/add-post/schema.json b/schematics/scully/src/add-post/schema.json
@@ -1,8 +1,8 @@
 
 {
     "$schema": "http://json-schema.org/schema",
-    "id": "coulson-ng-add-blog",
-    "title": "Coulson ng-add-blog schematic",
+    "id": "Scully-ng-add-blog",
+    "title": "Scully ng-add-blog schematic",
     "type": "object",
     "properties": { },
     "required": []
diff --git a/schematics/scully/src/collection.json b/schematics/scully/src/collection.json
@@ -29,6 +29,18 @@
       "factory": "./add-post/index",
       "schema": "./add-post/schema.json",
       "aliases": ["post"]
+    },
+    "add-markdown": {
+      "description": "Add new markdown folder and module",
+      "factory": "./add-markdown/index",
+      "schema": "./add-markdown/schema.json",
+      "aliases": ["markdown"]
+    },
+    "create-markdown": {
+      "description": "Add create markdown folder and module",
+      "factory": "./create-markdown/index",
+      "schema": "./create-markdown/schema.json",
+      "aliases": ["c-markdown"]
     }
   }
 }
diff --git a/schematics/scully/src/create-blog/index.ts b/schematics/scully/src/create-blog/index.ts
@@ -19,6 +19,25 @@ publish: false
         context.logger.info(`✅️Blog ${fullDay}-${name} file created`);
       }
 
+      context.logger.info(`start json scully`);
+      // add into scully config
+      try {
+        const content: Buffer | null = host.read(`/scully.json`);
+        let jsonContent;
+        if (content) { jsonContent = JSON.parse(content.toString()); }
+        /* tslint:disable:no-string-literal */
+        jsonContent.routes['/blog/:slug'] = {
+          type: 'contentFolder',
+            slug: {
+              folder: './blog'
+          }
+        };
+        host.overwrite(`/scully.json`, JSON.stringify(jsonContent, undefined, 2));
+        context.logger.info('✅️ Update scully.json');
+      } catch (e) {
+        context.logger.error('Cant update scully.json');
+      }
+
       // test schematics
       let path = './src/files/blog-module/';
       if (!host.getDir('./src').subdirs.find(x => x === 'add-component')) {
diff --git a/schematics/scully/src/create-blog/schema.json b/schematics/scully/src/create-blog/schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/schema",
   "id": "add-component",
-  "title": "Coulson add component schematic",
+  "title": "Scully add component schematic",
   "type": "object",
   "properties": {
     "routingScope": {
diff --git a/schematics/scully/src/create-markdown/index.ts b/schematics/scully/src/create-markdown/index.ts
@@ -0,0 +1,86 @@
+import {
+  Rule, Tree,
+  apply, url, applyTemplates, move,
+  chain, mergeWith, SchematicContext, forEach, Source,
+} from '@angular-devkit/schematics';
+
+import { strings, normalize } from '@angular-devkit/core';
+import {Schema as MyServiceSchema} from './schema';
+
+export default function(options: MyServiceSchema): Rule {
+  return (host: Tree, context: SchematicContext) => {
+    try {
+      options.name = options.name ? options.name : 'blog';
+      const name = options.name;
+      const date = new Date();
+      const fullDay = `${date.getMonth() + 1}-${date.getDate()}-${date.getFullYear()}`;
+      const path = `./${name}/${fullDay}-${name}.md`;
+      if (!host.exists(path)) {
+        host.create(path, `---
+title: This is the ${name}
+description: ${name} description
+publish: false
+---
+
+# Page ${name} example
+`);
+        context.logger.info(`✅ ${fullDay}-${name} file created`);
+      }
+      context.logger.info(`start json scully`);
+      // add into scully config
+      try {
+        const content: Buffer | null = host.read(`/scully.json`);
+        let jsonContent;
+        if (content) { jsonContent = JSON.parse(content.toString()); }
+        /* tslint:disable:no-string-literal */
+        jsonContent.routes[`${name}/:id`] = {
+          type: 'contentFolder',
+            id: {
+            folder: './${name}'
+          }
+        };
+        host.overwrite(`/scully.json`, JSON.stringify(jsonContent, undefined, 2));
+        context.logger.info('✅️ Update scully.json');
+      } catch (e) {
+        context.logger.error('Cant update scully.json');
+      }
+
+      options.path = options.path ? options.path : strings.dasherize(`./src/app/${name}`);
+
+      const templateSource = applyWithOverwrite(url('../files/markdown-module'), [
+        applyTemplates({
+          classify: strings.classify,
+          dasherize: strings.dasherize,
+          name: options.name
+        }),
+        move(normalize(options.path as string))
+      ]);
+
+      return chain([
+        templateSource
+      ]);
+
+    } catch (e) { }
+  };
+}
+
+function applyWithOverwrite(source: Source, rules: Rule[]): Rule {
+  return (tree: Tree, context: SchematicContext) => {
+    const rule = mergeWith(
+      apply(source, [
+        ...rules,
+        forEach((fileEntry) => {
+          if (tree.exists(fileEntry.path)) {
+            tree.overwrite(fileEntry.path, fileEntry.content);
+            return null;
+          }
+          return fileEntry;
+        }),
+
+      ]),
+    );
+
+    return rule(tree, context);
+  };
+}
+
diff --git a/schematics/scully/src/create-markdown/schema.json b/schematics/scully/src/create-markdown/schema.json
@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "add-component",
+  "title": "scully create markdown module schematic",
+  "type": "object",
+  "properties": {
+    "routingScope": {
+      "enum": ["Child", "Root"],
+      "type": "string",
+      "description": "The scope for the new routing module.",
+      "default": "Child"
+    },
+    "name": {
+      "type": "string",
+      "description": "add the name for the folder and module"
+    }
+  },
+  "required": []
+}
diff --git a/schematics/scully/src/create-markdown/schema.ts b/schematics/scully/src/create-markdown/schema.ts
@@ -0,0 +1,4 @@
+export interface Schema {
+  name: string;
+  path?: string;
+}
diff --git a/schematics/scully/src/files/markdown-module/__name@dasherize__-routing.module.ts.template b/schematics/scully/src/files/markdown-module/__name@dasherize__-routing.module.ts.template
@@ -0,0 +1,22 @@
+import {NgModule} from '@angular/core';
+import {Routes, RouterModule, Route} from '@angular/router';
+
+import {<%= classify(name) %>Component} from './<%= dasherize(name) %>.component';
+
+interface HeroRoute extends Route {
+  hero?: {path: string};
+}
+type HeroRoutes = HeroRoute[];
+
+const routes: HeroRoutes = [
+  {
+    path: ':id',
+    component: <%= classify(name) %>Component,
+  }
+];
+
+@NgModule({
+  imports: [RouterModule.forChild(routes)],
+  exports: [RouterModule],
+})
+export class <%= classify(name) %>RoutingModule {}
diff --git a/schematics/scully/src/files/markdown-module/__name@dasherize__.component.css.template b/schematics/scully/src/files/markdown-module/__name@dasherize__.component.css.template
@@ -0,0 +1,10 @@
+
+
+ ::slotted(h1)  {
+  color:rgb(51, 6, 37);
+  background-color: rgb(248, 211, 236);
+  padding: 5px;
+  border-radius: 5px;
+  width: fit-content;
+}
+
diff --git a/schematics/scully/src/files/markdown-module/__name@dasherize__.component.html.template b/schematics/scully/src/files/markdown-module/__name@dasherize__.component.html.template
@@ -0,0 +1,7 @@
+<h3>ScullyIo content</h3>
+<hr>
+
+<!-- This is where Scully will inject the static HTML -->
+<scully-content></scully-content>
+<hr>
+<h4>End of content</h4>
diff --git a/schematics/scully/src/files/markdown-module/__name@dasherize__.component.spec.ts.template b/schematics/scully/src/files/markdown-module/__name@dasherize__.component.spec.ts.template
@@ -0,0 +1,25 @@
+import { async, ComponentFixture, TestBed } from '@angular/core/testing';
+
+import { <%= classify(name) %>Component } from './<%= classify(name) %>.component';
+
+describe('<%= classify(name) %>Component', () => {
+  let component: <%= classify(name) %>Component;
+  let fixture: ComponentFixture<<%= classify(name) %>Component>;
+
+  beforeEach(async(() => {
+    TestBed.configureTestingModule({
+      declarations: [ <%= classify(name) %>Component ]
+    })
+    .compileComponents();
+  }));
+
+  beforeEach(() => {
+    fixture = TestBed.createComponent(<%= classify(name) %>Component);
+    component = fixture.componentInstance;
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+});
diff --git a/schematics/scully/src/files/markdown-module/__name@dasherize__.component.ts.template b/schematics/scully/src/files/markdown-module/__name@dasherize__.component.ts.template
@@ -0,0 +1,19 @@
+import {Component, OnInit, ViewEncapsulation} from '@angular/core';
+import {ActivatedRoute, Router, ROUTES} from '@angular/router';
+
+declare var ng: any;
+
+@Component({
+  selector: 'app-<%= dasherize(name) %>',
+  templateUrl: './<%= dasherize(name) %>.component.html',
+  styleUrls: ['./<%= dasherize(name) %>.component.css'],
+  preserveWhitespaces: true,
+  encapsulation: ViewEncapsulation.Emulated
+
+})
+export class <%= classify(name) %>Component implements OnInit {
+  ngOnInit() {}
+
+  constructor(private router: Router, private route: ActivatedRoute) {
+  }
+}
diff --git a/schematics/scully/src/files/markdown-module/__name@dasherize__.module.ts.template b/schematics/scully/src/files/markdown-module/__name@dasherize__.module.ts.template
@@ -0,0 +1,11 @@
+import {CommonModule} from '@angular/common';
+import {NgModule} from '@angular/core';
+import {ComponentsModule} from '@scullyio/ng-lib';
+import {<%= classify(name) %>RoutingModule} from './<%= dasherize(name) %>-routing.module';
+import {<%= classify(name) %>Component} from './<%= dasherize(name) %>.component';
+
+@NgModule({
+  declarations: [<%= classify(name) %>Component],
+  imports: [CommonModule, <%= classify(name) %>RoutingModule, ComponentsModule],
+})
+export class <%= classify(name) %>Module {}
diff --git a/schematics/scully/src/scully/index.ts b/schematics/scully/src/scully/index.ts

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "http://json-schema.org/schema",`
`3`	`3`	`"id": "add-component",`
`4`		`- "title": "Coulson add component schematic",`
	`4`	`+ "title": "Scully add component schematic",`
`5`	`5`	`"type": "object",`
`6`	`6`	`"properties": {`
`7`	`7`	`"routingScope": {`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export interface Schema {`
	`2`	`+ name: string;`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,18 @@`
`29`	`29`	`"factory": "./add-post/index",`
`30`	`30`	`"schema": "./add-post/schema.json",`
`31`	`31`	`"aliases": ["post"]`
	`32`	`+ },`
	`33`	`+ "add-markdown": {`
	`34`	`+ "description": "Add new markdown folder and module",`
	`35`	`+ "factory": "./add-markdown/index",`
	`36`	`+ "schema": "./add-markdown/schema.json",`
	`37`	`+ "aliases": ["markdown"]`
	`38`	`+ },`
	`39`	`+ "create-markdown": {`
	`40`	`+ "description": "Add create markdown folder and module",`
	`41`	`+ "factory": "./create-markdown/index",`
	`42`	`+ "schema": "./create-markdown/schema.json",`
	`43`	`+ "aliases": ["c-markdown"]`
`32`	`44`	`}`
`33`	`45`	`}`
`34`	`46`	`}`