chore(generators): wip: NgModule manip

Author: imhoffd

src/deep-linking/util.ts

@@ -19,7 +19,16 @@ import * as Constants from '../util/constants';
 import { FileCache } from '../util/file-cache';
 import { changeExtension, getStringPropertyValue, replaceAll } from '../util/helpers';
 import { BuildContext, ChangedFile, DeepLinkConfigEntry, DeepLinkDecoratorAndClass, DeepLinkPathInfo, File } from '../util/interfaces';
-import { appendAfter, getNgModuleClassName, getNgModuleDecorator, getClassDeclarations, getTypescriptSourceFile, getNodeStringContent, replaceNode } from '../util/typescript-utils';
+import {
+  appendAfter,
+  getClassDeclarations,
+  getNgModuleClassName,
+  getNgModuleDecorator,
+  getNgModuleObjectLiteralArg,
+  getTypescriptSourceFile,
+  getNodeStringContent,
+  replaceNode,
+} from '../util/typescript-utils';
 
 import { transpileTsString } from '../transpile';
 
@@ -188,14 +197,6 @@ export function hasExistingDeepLinkConfig(appNgModuleFilePath: string, appNgModu
   return deepLinkConfigArg.kind === SyntaxKind.ObjectLiteralExpression;
 }
 
-function getNgModuleObjectLiteralArg(decorator: Decorator) {
-  const ngModuleArgs = (decorator.expression as CallExpression).arguments;
-  if (!ngModuleArgs || ngModuleArgs.length === 0 || ngModuleArgs.length > 1) {
-    throw new Error(`Invalid NgModule Argument`);
-  }
-  return ngModuleArgs[0] as ObjectLiteralExpression;
-}
-
 function getIonicModuleForRootCall(decorator: Decorator) {
   const argument = getNgModuleObjectLiteralArg(decorator);
   const properties = argument.properties.filter((property: PropertyAssignment) => {

src/generators.ts

@@ -2,6 +2,8 @@ import { Logger} from './logger/logger';
 import { generateContext } from './util/config';
 import * as Constants from './util/constants';
 import { BuildContext } from './util/interfaces';
+import { readFileAsync } from './util/helpers';
+import { getTypescriptSourceFile, appendNgModuleDeclaration, insertNamedImportIfNeeded } from './util/typescript-utils';
 import { applyTemplates, filterOutTemplates, getNgModules, GeneratorOption, GeneratorRequest, hydrateRequest, readTemplates, writeGeneratedFiles } from './generators/util';
 
 export { getNgModules, GeneratorOption, GeneratorRequest };
@@ -15,9 +17,17 @@ export function processPageRequest(context: BuildContext, name: string) {
   return processNonTabRequest(context, { type: 'page', name });
 }
 
-export function processPipeRequest(context: BuildContext, name: string, ngModulePaths: string[]) {
-  return processNonTabRequest(context, { type: 'pipe', name }).then(() => {
-    // TODO
+export function processPipeRequest(context: BuildContext, name: string, ngModulePath: string) {
+  const hydratedRequest = hydrateRequest(context, { type: 'pipe', name });
+
+  return readFileAsync(ngModulePath).then((fileContent: string) => {
+    fileContent = insertNamedImportIfNeeded(ngModulePath, fileContent, name, `./${name}`);
+    fileContent = appendNgModuleDeclaration(ngModulePath, fileContent, name);
+    // TODO: write file
+
+    return processNonTabRequest(context, hydratedRequest).then(() => {
+      // TODO
+    });
   });
 }
 

src/generators/util.spec.ts

@@ -341,12 +341,6 @@ export class $CLASSNAMEModule {}
       context = { componentsDir, directivesDir, pagesDir, pipesDir, providersDir };
     });
 
-    function genMockGlobResults(types: string[]): GlobResult[] {
-      return types.map((type) => {
-        return { absolutePath: `/path/to/${type}`, base: '/path' }
-      });
-    }
-
     it('should return an empty list of glob results', () => {
       const globAllSpy = spyOn(globUtils, globUtils.globAll.name);
       util.getNgModules(context, []);

src/util/config.ts

@@ -155,9 +155,9 @@ export function generateContext(context?: BuildContext): BuildContext {
   setProcessEnvVar(Constants.ENV_APP_ENTRY_POINT, appEntryPointPathValue);
   Logger.debug(`appEntryPoint set to ${appEntryPointPathValue}`);
 
-  const appNgModulePath = resolve(getConfigValue(context, '--appNgModulePath', null, Constants.ENV_APP_NG_MODULE_PATH, Constants.ENV_APP_NG_MODULE_PATH.toLowerCase(), join(context.srcDir, 'app', 'app.module.ts')));
-  setProcessEnvVar(Constants.ENV_APP_NG_MODULE_PATH, appNgModulePath);
-  Logger.debug(`appNgModulePath set to ${appNgModulePath}`);
+  context.appNgModulePath = resolve(getConfigValue(context, '--appNgModulePath', null, Constants.ENV_APP_NG_MODULE_PATH, Constants.ENV_APP_NG_MODULE_PATH.toLowerCase(), join(context.srcDir, 'app', 'app.module.ts')));
+  setProcessEnvVar(Constants.ENV_APP_NG_MODULE_PATH, context.appNgModulePath);
+  Logger.debug(`appNgModulePath set to ${context.appNgModulePath}`);
 
   const appNgModuleClass = getConfigValue(context, '--appNgModuleClass', null, Constants.ENV_APP_NG_MODULE_CLASS, Constants.ENV_APP_NG_MODULE_CLASS.toLowerCase(), 'AppModule');
   setProcessEnvVar(Constants.ENV_APP_NG_MODULE_CLASS, appNgModuleClass);

src/util/interfaces.ts

@@ -20,6 +20,7 @@ export interface BuildContext {
   nodeModulesDir?: string;
   ionicAngularDir?: string;
   moduleFiles?: string[];
+  appNgModulePath?: string;
   isProd?: boolean;
   isWatch?: boolean;
   runAot?: boolean;

src/util/typescript-utils.ts

@@ -1,23 +1,28 @@
-import { Logger } from '../logger/logger';
+import * as path from 'path';
 
 import {
   CallExpression,
   ClassDeclaration,
-  createSourceFile,
   Decorator,
   Identifier,
   ImportClause,
   ImportDeclaration,
   ImportSpecifier,
   NamedImports,
   Node,
+  NodeArray,
+  ObjectLiteralElement,
+  ObjectLiteralExpression,
+  PropertyAssignment,
   ScriptTarget,
   SourceFile,
   StringLiteral,
-  SyntaxKind
+  SyntaxKind,
+  createSourceFile,
 } from 'typescript';
 
 import { rangeReplace, stringSplice } from './helpers';
+import { Logger } from '../logger/logger';
 
 export function getTypescriptSourceFile(filePath: string, fileContent: string, languageVersion: ScriptTarget = ScriptTarget.Latest, setParentNodes: boolean = false): SourceFile {
   return createSourceFile(filePath, fileContent, languageVersion, setParentNodes);
@@ -215,4 +220,26 @@ export function getNgModuleDecorator(fileName: string, sourceFile: SourceFile) {
   return ngModuleDecorators[0];
 }
 
+export function getNgModuleObjectLiteralArg(decorator: Decorator) {
+  const ngModuleArgs = (decorator.expression as CallExpression).arguments;
+  if (!ngModuleArgs || ngModuleArgs.length === 0 || ngModuleArgs.length > 1) {
+    throw new Error(`Invalid NgModule Argument`);
+  }
+  return ngModuleArgs[0] as ObjectLiteralExpression;
+}
+
+export function findObjectLiteralElementByName(properties: NodeArray<ObjectLiteralElement>, identifierToLookFor: string) {
+  return properties.filter((propertyNode) => {
+    return propertyNode && (propertyNode as PropertyAssignment).name && ((propertyNode as PropertyAssignment).name as Identifier).text === identifierToLookFor;
+  })[0];
+}
+
+export function appendNgModuleDeclaration(filePath: string, fileContent: string, declaration: string): string {
+  const sourceFile = getTypescriptSourceFile(filePath, fileContent, ScriptTarget.Latest, false);
+  const decorator = getNgModuleDecorator(path.basename(filePath), sourceFile);
+  const obj = getNgModuleObjectLiteralArg(decorator);
+  const declarations = (findObjectLiteralElementByName(obj.properties, 'declarations') as PropertyAssignment).initializer.elements;
+  return appendAfter(fileContent, declarations[declarations.length - 1], `,\n    ${declaration}`);
+}
+
 const NG_MODULE_DECORATOR_TEXT = 'NgModule';