@rxdi/schematics 0.7.124 → 0.7.128

package/lib/service/service.factory.ts

@@ -0,0 +1,91 @@
+import { join, Path, strings } from '@angular-devkit/core';
+import {
+  apply,
+  branchAndMerge,
+  chain,
+  filter,
+  mergeWith,
+  move,
+  noop,
+  Rule,
+  SchematicContext,
+  SchematicsException,
+  template,
+  Tree,
+  url,
+} from '@angular-devkit/schematics';
+import { isNullOrUndefined } from 'util';
+import {
+  DeclarationOptions,
+  ModuleDeclarator,
+} from '../../utils/module.declarator';
+import { ModuleFinder } from '../../utils/module.finder';
+import { Location, NameParser } from '../../utils/name.parser';
+import { mergeSourceRoot } from '../../utils/source-root.helpers';
+import { ServiceOptions } from './service.schema';
+
+export function main(options: ServiceOptions): Rule {
+  options = transform(options);
+  return (tree: Tree, context: SchematicContext) => {
+    return branchAndMerge(
+      chain([
+        mergeSourceRoot(options),
+        addDeclarationToModule(options),
+        mergeWith(generate(options)),
+      ]),
+    )(tree, context);
+  };
+}
+
+function transform(source: ServiceOptions): ServiceOptions {
+  const target: ServiceOptions = Object.assign({}, source);
+  target.metadata = 'providers';
+  target.type = 'service';
+
+  if (isNullOrUndefined(target.name)) {
+    throw new SchematicsException('Option (name) is required.');
+  }
+  const location: Location = new NameParser().parse(target);
+  target.name = strings.dasherize(location.name);
+  target.path = strings.dasherize(location.path);
+  target.language = target.language !== undefined ? target.language : 'ts';
+
+  target.path = target.flat
+    ? target.path
+    : join(target.path as Path, target.name);
+  return target;
+}
+
+function generate(options: ServiceOptions) {
+  return (context: SchematicContext) =>
+    apply(url(join('./files' as Path, options.language)), [
+      options.spec ? noop() : filter(path => !path.endsWith('.spec.ts')),
+      template({
+        ...strings,
+        ...options,
+      }),
+      move(options.path),
+    ])(context);
+}
+
+function addDeclarationToModule(options: ServiceOptions): Rule {
+  return (tree: Tree) => {
+    if (options.skipImport !== undefined && options.skipImport) {
+      return tree;
+    }
+    options.module = new ModuleFinder(tree).find({
+      name: options.name,
+      path: options.path as Path,
+    });
+    if (!options.module) {
+      return tree;
+    }
+    const content = tree.read(options.module).toString();
+    const declarator: ModuleDeclarator = new ModuleDeclarator();
+    tree.overwrite(
+      options.module,
+      declarator.declare(content, options as DeclarationOptions),
+    );
+    return tree;
+  };
+}

package/lib/service/service.schema.d.ts

@@ -0,0 +1,44 @@
+import { Path } from '@angular-devkit/core';
+
+export interface ServiceOptions {
+  /**
+   * The name of the service.
+   */
+  name: string;
+  /**
+   * The path to create the service.
+   */
+  path?: string;
+  /**
+   * The path to insert the service declaration.
+   */
+  module?: Path;
+  /**
+   * Directive to insert declaration in module.
+   */
+  skipImport?: boolean;
+  /**
+   * Metadata name affected by declaration insertion.
+   */
+  metadata?: string;
+  /**
+   * Nest element type name
+   */
+  type?: string;
+  /**
+   * Application language.
+   */
+  language?: string;
+  /**
+   * The source root path
+   */
+  sourceRoot?: string;
+  /**
+   * Specifies if a spec file is generated.
+   */
+  spec?: boolean;
+  /**
+   * Flag to indicate if a directory is created.
+   */
+  flat?: boolean;
+}

package/lib/type/files/js/__name__.type.js

@@ -0,0 +1,10 @@
+import { GraphQLString, GraphQLObjectType } from '@gapi/core';
+
+export const <%= classify(name) %>Type = new GraphQLObjectType({
+    name: '<%= classify(name) %>Type',
+    fields: {
+        init: {
+            type: GraphQLString
+        }
+    }
+});

package/lib/type/files/ts/__name__.type.ts

@@ -0,0 +1,10 @@
+import { GraphQLString, GraphQLObjectType } from '@gapi/core';
+
+export const <%= classify(name) %>Type = new GraphQLObjectType({
+    name: '<%= classify(name) %>Type',
+    fields: {
+        init: {
+            type: GraphQLString
+        }
+    }
+});

package/lib/type/schema.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "SchematicsGapiType",
+  "title": "Gapi Type Options Schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the type.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the type?"
+    },
+    "path": {
+      "type": "string",
+      "format": "path",
+      "description": "The path to create the type."
+    },
+    "language": {
+      "type": "string",
+      "description": "Gapi type language (ts/js)."
+    },
+    "sourceRoot": {
+      "type": "string",
+      "description": "Gapi type source root directory."
+    },
+    "skipImport": {
+      "description": "Flag to skip the module import.",
+      "default": true
+    },
+    "flat": {
+      "default": true,
+      "description": "Flag to indicate if a directory is created."
+    },
+    "spec": {
+      "default": false,
+      "description": "Specifies if a spec file is generated."
+    }
+  },
+  "required": ["name"]
+}

package/lib/type/type.factory.d.ts

@@ -1,3 +1,3 @@
 import { Rule } from '@angular-devkit/schematics';
-import { ControllerOptions } from './type.schema';
+import { ControllerOptions } from './controller.schema';
 export declare function main(options: ControllerOptions): Rule;

package/lib/type/type.factory.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = void 0;
 const core_1 = require("@angular-devkit/core");
 const schematics_1 = require("@angular-devkit/schematics");
 const module_declarator_1 = require("../../utils/module.declarator");
@@ -38,7 +37,7 @@ function transform(source) {
 function generate(options) {
     return (context) => schematics_1.apply(schematics_1.url(core_1.join('./files', options.language)), [
         options.spec ? schematics_1.noop() : schematics_1.filter(path => !path.endsWith('.spec.ts')),
-        schematics_1.template(Object.assign(Object.assign({}, core_1.strings), options)),
+        schematics_1.template(Object.assign({}, core_1.strings, options)),
         schematics_1.move(options.path),
     ])(context);
 }

package/lib/type/type.factory.test.ts

@@ -0,0 +1,191 @@
+import { normalize } from '@angular-devkit/core';
+import {
+  SchematicTestRunner,
+  UnitTestTree,
+} from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+import { ApplicationOptions } from '../application/application.schema';
+import { ModuleOptions } from '../module/module.schema';
+import { ControllerOptions } from './controller.schema';
+
+describe('Controller Factory', () => {
+  const runner: SchematicTestRunner = new SchematicTestRunner(
+    '.',
+    path.join(process.cwd(), 'src/collection.json'),
+  );
+  it('should manage name only', () => {
+    const options: ControllerOptions = {
+      name: 'foo',
+      skipImport: true,
+      spec: false,
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('controller', options);
+    const files: string[] = tree.files;
+
+    expect(
+      files.find(filename => filename === '/foo/foo.controller.ts'),
+    ).toBeDefined();
+    expect(
+      files.find(filename => filename === '/foo/foo.controller.spec.ts'),
+    ).not.toBeDefined();
+    expect(tree.readContent('/foo/foo.controller.ts')).toEqual(
+      "import { Controller } from '@nestjs/common';\n" +
+        '\n' +
+        "@Controller('foo')\n" +
+        'export class FooController {}\n',
+    );
+  });
+  it('should manage name has a path', () => {
+    const options: ControllerOptions = {
+      name: 'bar/foo',
+      skipImport: true,
+    };
+    const tree: UnitTestTree = runner.runSchematic('controller', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar/foo/foo.controller.ts'),
+    ).toBeDefined();
+    expect(
+      files.find(filename => filename === '/bar/foo/foo.controller.spec.ts'),
+    ).toBeDefined();
+    expect(tree.readContent('/bar/foo/foo.controller.ts')).toEqual(
+      "import { Controller } from '@nestjs/common';\n" +
+        '\n' +
+        "@Controller('foo')\n" +
+        'export class FooController {}\n',
+    );
+  });
+  it('should manage name and path', () => {
+    const options: ControllerOptions = {
+      name: 'foo',
+      path: 'bar',
+      skipImport: true,
+    };
+    const tree: UnitTestTree = runner.runSchematic('controller', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar/foo/foo.controller.ts'),
+    ).toBeDefined();
+    expect(
+      files.find(filename => filename === '/bar/foo/foo.controller.spec.ts'),
+    ).toBeDefined();
+    expect(tree.readContent('/bar/foo/foo.controller.ts')).toEqual(
+      "import { Controller } from '@nestjs/common';\n" +
+        '\n' +
+        "@Controller('foo')\n" +
+        'export class FooController {}\n',
+    );
+  });
+  it('should manage name to dasherize', () => {
+    const options: ControllerOptions = {
+      name: 'fooBar',
+      skipImport: true,
+    };
+    const tree: UnitTestTree = runner.runSchematic('controller', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo-bar/foo-bar.controller.ts'),
+    ).toBeDefined();
+    expect(
+      files.find(
+        filename => filename === '/foo-bar/foo-bar.controller.spec.ts',
+      ),
+    ).toBeDefined();
+    expect(tree.readContent('/foo-bar/foo-bar.controller.ts')).toEqual(
+      "import { Controller } from '@nestjs/common';\n" +
+        '\n' +
+        "@Controller('foo-bar')\n" +
+        'export class FooBarController {}\n',
+    );
+  });
+  it('should manage path to dasherize', () => {
+    const options: ControllerOptions = {
+      name: 'barBaz/foo',
+      skipImport: true,
+    };
+    const tree: UnitTestTree = runner.runSchematic('controller', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar-baz/foo/foo.controller.ts'),
+    ).toBeDefined();
+    expect(
+      files.find(
+        filename => filename === '/bar-baz/foo/foo.controller.spec.ts',
+      ),
+    ).toBeDefined();
+    expect(tree.readContent('/bar-baz/foo/foo.controller.ts')).toEqual(
+      "import { Controller } from '@nestjs/common';\n" +
+        '\n' +
+        "@Controller('foo')\n" +
+        'export class FooController {}\n',
+    );
+  });
+  it('should manage javascript file', () => {
+    const options: ControllerOptions = {
+      name: 'foo',
+      language: 'js',
+      skipImport: true,
+    };
+    const tree: UnitTestTree = runner.runSchematic('controller', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo/foo.controller.js'),
+    ).toBeDefined();
+    expect(
+      files.find(filename => filename === '/foo/foo.controller.spec.js'),
+    ).toBeDefined();
+    expect(tree.readContent('/foo/foo.controller.js')).toEqual(
+      "import { Controller } from '@nestjs/common';\n" +
+        '\n' +
+        "@Controller('foo')\n" +
+        'export class FooController {}\n',
+    );
+  });
+  it('should manage declaration in app module', () => {
+    const app: ApplicationOptions = {
+      name: '',
+    };
+    let tree: UnitTestTree = runner.runSchematic('application', app);
+    const options: ControllerOptions = {
+      name: 'foo',
+    };
+    tree = runner.runSchematic('controller', options, tree);
+    expect(tree.readContent(normalize('/src/app.module.ts'))).toEqual(
+      "import { Module } from '@nestjs/common';\n" +
+        "import { AppController } from './app.controller';\n" +
+        "import { AppService } from './app.service';\n" +
+        "import { FooController } from './foo/foo.controller';\n" +
+        '\n' +
+        '@Module({\n' +
+        '  imports: [],\n' +
+        '  controllers: [AppController, FooController],\n' +
+        '  providers: [AppService],\n' +
+        '})\n' +
+        'export class AppModule {}\n',
+    );
+  });
+  it('should manage declaration in foo module', () => {
+    const app: ApplicationOptions = {
+      name: '',
+    };
+    let tree: UnitTestTree = runner.runSchematic('application', app);
+    const module: ModuleOptions = {
+      name: 'foo',
+    };
+    tree = runner.runSchematic('module', module, tree);
+    const options: ControllerOptions = {
+      name: 'foo',
+    };
+    tree = runner.runSchematic('controller', options, tree);
+    expect(tree.readContent(normalize('/src/foo/foo.module.ts'))).toEqual(
+      "import { Module } from '@nestjs/common';\n" +
+        "import { FooController } from './foo.controller';\n" +
+        '\n' +
+        '@Module({\n' +
+        '  controllers: [FooController]\n' +
+        '})\n' +
+        'export class FooModule {}\n',
+    );
+  });
+});

package/lib/type/type.factory.ts

@@ -0,0 +1,91 @@
+import { join, Path, strings } from '@angular-devkit/core';
+import {
+  apply,
+  branchAndMerge,
+  chain,
+  filter,
+  mergeWith,
+  move,
+  noop,
+  Rule,
+  SchematicContext,
+  template,
+  Tree,
+  url,
+} from '@angular-devkit/schematics';
+import {
+  DeclarationOptions,
+  ModuleDeclarator,
+} from '../../utils/module.declarator';
+import { ModuleFinder } from '../../utils/module.finder';
+import { Location, NameParser } from '../../utils/name.parser';
+import { mergeSourceRoot } from '../../utils/source-root.helpers';
+import { DEFAULT_LANGUAGE } from '../defaults';
+import { ControllerOptions } from './type.schema';
+
+const ELEMENT_METADATA = 'controllers';
+const ELEMENT_TYPE = 'controller';
+
+export function main(options: ControllerOptions): Rule {
+  options = transform(options);
+  return (tree: Tree, context: SchematicContext) => {
+    return branchAndMerge(
+      chain([
+        mergeSourceRoot(options),
+        mergeWith(generate(options)),
+        addDeclarationToModule(options),
+      ]),
+    )(tree, context);
+  };
+}
+
+function transform(source: ControllerOptions): ControllerOptions {
+  const target: ControllerOptions = Object.assign({}, source);
+  target.metadata = ELEMENT_METADATA;
+  target.type = ELEMENT_TYPE;
+
+  const location: Location = new NameParser().parse(target);
+  target.name = strings.dasherize(location.name);
+  target.path = strings.dasherize(location.path);
+  target.language =
+    target.language !== undefined ? target.language : DEFAULT_LANGUAGE;
+
+  target.path = target.flat
+    ? target.path
+    : join(target.path as Path, target.name);
+  return target;
+}
+
+function generate(options: ControllerOptions) {
+  return (context: SchematicContext) =>
+    apply(url(join('./files' as Path, options.language)), [
+      options.spec ? noop() : filter(path => !path.endsWith('.spec.ts')),
+      template({
+        ...strings,
+        ...options,
+      }),
+      move(options.path),
+    ])(context);
+}
+
+function addDeclarationToModule(options: ControllerOptions): Rule {
+  return (tree: Tree) => {
+    if (options.skipImport !== undefined && options.skipImport) {
+      return tree;
+    }
+    options.module = new ModuleFinder(tree).find({
+      name: options.name,
+      path: options.path as Path,
+    });
+    if (!options.module) {
+      return tree;
+    }
+    const content = tree.read(options.module).toString();
+    const declarator: ModuleDeclarator = new ModuleDeclarator();
+    tree.overwrite(
+      options.module,
+      declarator.declare(content, options as DeclarationOptions),
+    );
+    return tree;
+  };
+}

package/lib/type/type.schema.d.ts

@@ -0,0 +1,44 @@
+import { Path } from '@angular-devkit/core';
+
+export interface ControllerOptions {
+  /**
+   * The name of the controller.
+   */
+  name: string;
+  /**
+   * The path to create the controller.
+   */
+  path?: string | Path;
+  /**
+   * The path to insert the controller declaration.
+   */
+  module?: Path;
+  /**
+   * Directive to insert declaration in module.
+   */
+  skipImport?: boolean;
+  /**
+   * Metadata name affected by declaration insertion.
+   */
+  metadata?: string;
+  /**
+   * Nest element type name
+   */
+  type?: string;
+  /**
+   * Application language.
+   */
+  language?: string;
+  /**
+   * The source root path
+   */
+  sourceRoot?: string;
+  /**
+   * Specifies if a spec file is generated.
+   */
+  spec?: boolean;
+  /**
+   * Flag to indicate if a directory is created.
+   */
+  flat?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rxdi/schematics",
-  "version": "0.7.124",
+  "version": "0.7.128",
   "description": "",
   "scripts": {
     "build": "rm -rf utils lib && tsc && cp -r ./src/* .",
@@ -18,6 +18,6 @@
   "schematics": "./collection.json",
   "devDependencies": {
     "@types/node": "^12.0.10",
-    "typescript": "^3.9.3"
+    "typescript": "^4.3.5"
   }
 }

package/utils/metadata.manager.js

@@ -7,7 +7,7 @@ class MetadataManager {
         this.content = content;
     }
     insert(metadata, symbol, staticOptions) {
-        const source = typescript_1.createSourceFile('filename.ts', this.content, typescript_1.ScriptTarget.ES2017);
+        const source = (0, typescript_1.createSourceFile)('filename.ts', this.content, typescript_1.ScriptTarget.ES2017);
         const decoratorNodes = this.getDecoratorMetadata(source, '@Module');
         const node = decoratorNodes[0];
         const matchingProperties = node.properties