feat(schematics): add initial schematics utils #9451

amcdnl · 2018-01-18T02:46:53Z

This PR lays the foundation for schematics. #8975

The schematics will come in separate PRs resembling https://github.com/amcdnl/material-schematics which represent demos from https://github.com/amcdnl/material-example-schematics.

josephperrott · 2018-01-18T17:49:16Z

@amcdnl can you add /schematics/* to the CODEOWNERS file?

jelbourn · 2018-01-18T22:13:34Z

schematics/collection.json

@@ -0,0 +1,18 @@
+// By default, collection.json is a Loose-format JSON5 format, which means it's loaded using a


Add comment at the top that explains what this file is for / does?

Technically, json is not supposed to have comments. ;P

It has comments already?

jelbourn · 2018-01-18T22:14:23Z

.gitignore

+
+# schematics
+/schematics/**/*.js
+/schematics/**/*.map


Any reason not to put this under src?

Would you like to move all the code under src?

Nah, just curious; we can move them if we ever need to

jelbourn · 2018-01-18T22:32:21Z

schematics/utils/lib-versions.ts

@@ -0,0 +1,3 @@
+export const materialVersion = '^5.0.1';
+export const cdkVersion = '^5.0.1';
+export const angularVersion = '5.0.1';


Why 5.0.1 instead of 5.0.0?

jelbourn · 2018-01-18T22:33:19Z

schematics/utils/devkit-utils/ast-utils.ts

+ * @param max The maximum number of items to return.
+ * @return all nodes of kind, or [] if none is found
+ */
+export function findNodes(node: ts.Node, kind: ts.SyntaxKind, max = Infinity): ts.Node[] {


@Brocco @hansl will these functions (and other utils in the PR) be a part of the public schematics API? It's a pretty large amount of code that schematic creators are needing to copy now. Is this just a temporary thing we can get rid of eventually, or do we need to own this code forever?

@amcdnl is there anything that you needed to customize in these utils?

Nope, these are straight copies from that repo.

I chatted w/ Hans and these utils are eventually going to be a standalone thing, so in the meantime we can just treat them as an external library that happens to live in our source.

jelbourn · 2018-01-18T22:33:43Z

schematics/utils/ast.ts

+import { getAppModulePath } from './devkit-utils/ng-ast-utils';
+import { InsertChange } from './devkit-utils/change';
+import { getConfig, getAppFromConfig } from './devkit-utils/config';
+import { normalize } from '@angular-devkit/core';


Omit spaces in braces (WebStorm can be configured for this, not sure about VS Code)

(here and elsewhere)

jelbourn · 2018-01-18T22:36:59Z

schematics/utils/ast.ts

+/**
+ * Import and add module to root app module.
+ */
+export function addToRootModule(host: Tree, moduleName: string, src: string) {


addModuleImportToRootModule?

jelbourn · 2018-01-18T22:37:33Z

schematics/utils/ast.ts

+/**
+ * Import and add module to specific module path.
+ */
+export function addToModule(host: Tree, modulePath: string, moduleName: string, src: string) {


addModuleImportToModule?

jelbourn · 2018-01-18T22:37:50Z

schematics/utils/ast.ts

+/**
+ * Gets the app index.html file
+ */
+export function getIndexPath(host: Tree) {


getIndexHtmlPath?

jelbourn · 2018-01-18T22:41:04Z

schematics/utils/testing.ts

@@ -0,0 +1,25 @@
+import * as path from 'path';


You can do

import {join} from 'path';

We do this in most of our other tooling

jelbourn · 2018-01-18T22:41:35Z

schematics/utils/testing.ts

+/**
+ * Create a base app used for testing.
+ */
+export function baseApp() {


createTestApp?

amcdnl · 2018-01-18T23:23:43Z

@jelbourn - addressed feedback.

jelbourn · 2018-01-19T19:30:10Z

schematics/utils/html.ts

+ */
+export function getHeadTag(host: Tree, src: string) {
+  const document = parse5.parse(src,
+    { locationInfo: true }) as parse5.AST.Default.Document;


Omit spaces in braces

jelbourn · 2018-01-19T19:30:57Z

schematics/utils/html.ts

+  const src = buffer.toString();
+  if (src.indexOf(link) === -1) {
+    const node = getHeadTag(host, src);
+    const chng = new InsertChange(indexPath, node.position, link);


chng -> insertion?

jelbourn · 2018-01-19T19:32:05Z

schematics/utils/html.ts

+}
+
+/**
+ * Adds a link to the index.html head tag


Add @param JsDoc? (specifically it's not clear what link should look like)

jelbourn · 2018-01-19T19:32:24Z

schematics/utils/html.ts

+import {InsertChange} from './devkit-utils/change';
+
+/**
+ * Parses the index.html file to get the HEAD tag position.


Add @param JsDoc?

jelbourn · 2018-01-19T19:33:40Z

schematics/utils/ast.ts

+}
+
+/**
+ * Import and add module to specific module path.


Add @param JsDoc? This will help disambiguate which module mouldePath and moduleName are referring to

jelbourn · 2018-01-19T19:34:19Z

schematics/utils/html.ts

+  }
+
+  return {
+    position: head.__location.startTag.endOffset


Why does this need to use a __-prefixed member?

Unsure, this is just what the object looks like.

This is typically meant to communicate a private API; there might be a alternate public way to access this

Is there a reason you're using parse5 over domino? Domino might provide a more natural interface here since it more closely mirrors the DOM than parse5.

That is a good point, especially since Angular Universal has moved to Domino. For now we can continue with this, though, since our use of it is pretty minor.

amcdnl · 2018-01-21T17:01:31Z

@jelbourn - updated per feedback.

jelbourn · 2018-01-22T20:40:46Z

schematics/utils/ast.ts

+/**
+ * Import and add module to specific module path.
+ * @param host the tree we are updating
+ * @param modulePath src location of the module


Location of which module?

jelbourn · 2018-01-22T20:44:06Z

schematics/utils/html.ts

+  }
+
+  return {
+    position: head.__location.startTag.endOffset


This is typically meant to communicate a private API; there might be a alternate public way to access this

amcdnl · 2018-01-26T12:46:06Z

@jelbourn - re: private __location, I agree, but the docs don't indicate that to be true: http://inikulin.github.io/parse5/interfaces/options.parseroptions.html#locationinfo

jelbourn · 2018-01-26T22:18:37Z

@amcdnl just needs an entry in CODEOWNERS and it's good to go

amcdnl · 2018-02-04T15:39:34Z

@CaerusKaru correct me if im wrong but that is for creating/querying/manipulating elements. I need a DOM AST parser.

@jelbourn - Good to go.

CaerusKaru · 2018-02-05T00:21:49Z

@amcdnl You can initialize a Domino Document object with HTML input; it then constructs the AST from the input.

* feat(schematics): add initial schematics utils * chore: nit * chore: pr feedback * chore: pr feedback * chore: add code owner

This reverts commit b1b41c6.

angular-automatic-lock-bot · 2019-09-08T07:03:05Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

feat(schematics): add initial schematics utils

d93a5b7

amcdnl self-assigned this Jan 18, 2018

amcdnl requested a review from jelbourn January 18, 2018 02:46

googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Jan 18, 2018

jelbourn requested a review from devversion January 18, 2018 22:24

jelbourn reviewed Jan 18, 2018

View reviewed changes

chore: nit

418e049

jelbourn reviewed Jan 19, 2018

View reviewed changes

chore: pr feedback

ca0f821

jelbourn reviewed Jan 22, 2018

View reviewed changes

chore: pr feedback

2d2d562

chore: add code owner

5f000ea

jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker labels Feb 5, 2018

mmalerba merged commit 673d56e into master Feb 6, 2018

mmalerba pushed a commit that referenced this pull request Feb 8, 2018

feat(schematics): add initial schematics utils (#9451)

b1b41c6

* feat(schematics): add initial schematics utils * chore: nit * chore: pr feedback * chore: pr feedback * chore: add code owner

amcdnl deleted the schematics branch February 10, 2018 15:14

mmalerba added a commit that referenced this pull request Feb 12, 2018

Revert "feat(schematics): add initial schematics utils (#9451)"

fda65cc

This reverts commit b1b41c6.

mmalerba added the target: minor This PR is targeted for the next minor release label Feb 12, 2018

angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 8, 2019

		@@ -0,0 +1,18 @@
		// By default, collection.json is a Loose-format JSON5 format, which means it's loaded using a

feat(schematics): add initial schematics utils #9451

feat(schematics): add initial schematics utils #9451

Conversation

amcdnl commented Jan 18, 2018

josephperrott commented Jan 18, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amcdnl commented Jan 18, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amcdnl commented Jan 21, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amcdnl commented Jan 26, 2018

jelbourn commented Jan 26, 2018

amcdnl commented Feb 4, 2018

CaerusKaru commented Feb 5, 2018

angular-automatic-lock-bot bot commented Sep 8, 2019