@rxdi/schematics 0.7.124 → 0.7.128

package/lib/controller/schema.json

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

package/lib/decorator/decorator.factory.js

@@ -7,7 +7,7 @@ const name_parser_1 = require("../../utils/name.parser");
 const source_root_helpers_1 = require("../../utils/source-root.helpers");
 function main(options) {
     options = transform(options);
-    return schematics_1.chain([source_root_helpers_1.mergeSourceRoot(options), schematics_1.mergeWith(generate(options))]);
+    return (0, schematics_1.chain)([(0, source_root_helpers_1.mergeSourceRoot)(options), (0, schematics_1.mergeWith)(generate(options))]);
 }
 exports.main = main;
 function transform(options) {
@@ -21,12 +21,12 @@ function transform(options) {
     target.language = target.language !== undefined ? target.language : 'ts';
     target.path = target.flat
         ? target.path
-        : core_1.join(target.path, target.name);
+        : (0, core_1.join)(target.path, target.name);
     return target;
 }
 function generate(options) {
-    return (context) => schematics_1.apply(schematics_1.url(core_1.join('./files', options.language)), [
-        schematics_1.template(Object.assign(Object.assign({}, core_1.strings), options)),
-        schematics_1.move(options.path),
+    return (context) => (0, schematics_1.apply)((0, schematics_1.url)((0, core_1.join)('./files', options.language)), [
+        (0, schematics_1.template)(Object.assign(Object.assign({}, core_1.strings), options)),
+        (0, schematics_1.move)(options.path),
     ])(context);
 }

package/lib/decorator/decorator.factory.test.ts

@@ -0,0 +1,111 @@
+import {
+  SchematicTestRunner,
+  UnitTestTree,
+} from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+import { DecoratorOptions } from './decorator.schema';
+
+describe('Decorator Factory', () => {
+  const runner: SchematicTestRunner = new SchematicTestRunner(
+    '.',
+    path.join(process.cwd(), 'src/collection.json'),
+  );
+  it('should manage name only', () => {
+    const options: DecoratorOptions = {
+      name: 'foo',
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('decorator', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo/foo.decorator.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/foo/foo.decorator.ts')).toEqual(
+      "import { ReflectMetadata } from '@nestjs/common';\n" +
+        '\n' +
+        "export const Foo = (...args: string[]) => ReflectMetadata('foo', args);\n",
+    );
+  });
+  it('should manage name as a path', () => {
+    const options: DecoratorOptions = {
+      name: 'bar/foo',
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('decorator', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar/foo/foo.decorator.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/bar/foo/foo.decorator.ts')).toEqual(
+      "import { ReflectMetadata } from '@nestjs/common';\n" +
+        '\n' +
+        "export const Foo = (...args: string[]) => ReflectMetadata('foo', args);\n",
+    );
+  });
+  it('should manage name and path', () => {
+    const options: DecoratorOptions = {
+      name: 'foo',
+      path: 'baz',
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('decorator', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/baz/foo/foo.decorator.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/baz/foo/foo.decorator.ts')).toEqual(
+      "import { ReflectMetadata } from '@nestjs/common';\n" +
+        '\n' +
+        "export const Foo = (...args: string[]) => ReflectMetadata('foo', args);\n",
+    );
+  });
+  it('should manage name to dasherize', () => {
+    const options: DecoratorOptions = {
+      name: 'fooBar',
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('decorator', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo-bar/foo-bar.decorator.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/foo-bar/foo-bar.decorator.ts')).toEqual(
+      "import { ReflectMetadata } from '@nestjs/common';\n" +
+        '\n' +
+        "export const FooBar = (...args: string[]) => ReflectMetadata('foo-bar', args);\n",
+    );
+  });
+  it('should manage path to dasherize', () => {
+    const options: DecoratorOptions = {
+      name: 'barBaz/foo',
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('decorator', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar-baz/foo/foo.decorator.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/bar-baz/foo/foo.decorator.ts')).toEqual(
+      "import { ReflectMetadata } from '@nestjs/common';\n" +
+        '\n' +
+        "export const Foo = (...args: string[]) => ReflectMetadata('foo', args);\n",
+    );
+  });
+  it('should manage javascript file', () => {
+    const options: DecoratorOptions = {
+      name: 'foo',
+      language: 'js',
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('decorator', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo/foo.decorator.js'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/foo/foo.decorator.js')).toEqual(
+      "import { ReflectMetadata } from '@nestjs/common';\n" +
+        '\n' +
+        "export const Foo = (...args) => ReflectMetadata('foo', args);\n",
+    );
+  });
+});

package/lib/decorator/decorator.factory.ts

@@ -0,0 +1,48 @@
+import { join, Path, strings } from '@angular-devkit/core';
+import {
+  apply,
+  chain,
+  mergeWith,
+  move,
+  Rule,
+  SchematicContext,
+  SchematicsException,
+  Source,
+  template,
+  url,
+} from '@angular-devkit/schematics';
+import { Location, NameParser } from '../../utils/name.parser';
+import { mergeSourceRoot } from '../../utils/source-root.helpers';
+import { DecoratorOptions } from './decorator.schema';
+
+export function main(options: DecoratorOptions): Rule {
+  options = transform(options);
+  return chain([mergeSourceRoot(options), mergeWith(generate(options))]);
+}
+
+function transform(options: DecoratorOptions): DecoratorOptions {
+  const target: DecoratorOptions = Object.assign({}, options);
+  if (!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: DecoratorOptions): Source {
+  return (context: SchematicContext) =>
+    apply(url(join('./files' as Path, options.language)), [
+      template({
+        ...strings,
+        ...options,
+      }),
+      move(options.path),
+    ])(context);
+}

package/lib/decorator/decorator.schema.d.ts

@@ -0,0 +1,24 @@
+import { Path } from '@angular-devkit/core';
+
+export interface DecoratorOptions {
+  /**
+   * The name of the decorator.
+   */
+  name: string;
+  /**
+   * The path to create the decorator.
+   */
+  path?: string | Path;
+  /**
+   * Application language.
+   */
+  language?: string;
+  /**
+   * The source root path
+   */
+  sourceRoot?: string;
+  /**
+   * Flag to indicate if a directory is created.
+   */
+  flat?: boolean;
+}

package/lib/decorator/files/js/__name__.decorator.js

@@ -0,0 +1,3 @@
+import { ReflectMetadata } from '@nestjs/common';
+
+export const <%= classify(name) %> = (...args) => ReflectMetadata('<%= name %>', args);

package/lib/decorator/files/ts/__name__.decorator.ts

@@ -0,0 +1,3 @@
+import { ReflectMetadata } from '@nestjs/common';
+
+export const <%= classify(name) %> = (...args: string[]) => ReflectMetadata('<%= name %>', args);

package/lib/decorator/schema.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "SchematicsNestDecorator",
+  "title": "Nest Decorator Options Schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the decorator.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the decorator?"
+    },
+    "path": {
+      "type": "string",
+      "format": "path",
+      "description": "The path to create the decorator."
+    },
+    "language": {
+      "type": "string",
+      "description": "Nest decorator language (ts/js)."
+    },
+    "sourceRoot": {
+      "type": "string",
+      "description": "Nest decorator source root directory."
+    },
+    "flat": {
+      "default": true,
+      "description": "Flag to indicate if a directory is created."
+    }
+  },
+  "required": ["name"]
+}

package/lib/defaults.ts

@@ -0,0 +1,6 @@
+export const DEFAULT_AUTHOR = '';
+export const DEFAULT_DESCRIPTION = '';
+export const DEFAULT_LANGUAGE = 'ts';
+export const DEFAULT_VERSION = '0.0.1';
+export const DEFAULT_PATH_NAME = 'src';
+export const DEFAULT_LIB_PATH = 'libs';

package/lib/effect/effect.factory.js

@@ -11,10 +11,10 @@ const source_root_helpers_1 = require("../../utils/source-root.helpers");
 function main(options) {
     options = transform(options);
     return (tree, context) => {
-        return schematics_1.branchAndMerge(schematics_1.chain([
-            source_root_helpers_1.mergeSourceRoot(options),
+        return (0, schematics_1.branchAndMerge)((0, schematics_1.chain)([
+            (0, source_root_helpers_1.mergeSourceRoot)(options),
             addDeclarationToModule(options),
-            schematics_1.mergeWith(generate(options)),
+            (0, schematics_1.mergeWith)(generate(options)),
         ]))(tree, context);
     };
 }
@@ -23,7 +23,7 @@ function transform(source) {
     const target = Object.assign({}, source);
     target.metadata = 'effects';
     target.type = 'effect';
-    if (util_1.isNullOrUndefined(target.name)) {
+    if ((0, util_1.isNullOrUndefined)(target.name)) {
         throw new schematics_1.SchematicsException('Option (name) is required.');
     }
     const location = new name_parser_1.NameParser().parse(target);
@@ -32,14 +32,14 @@ function transform(source) {
     target.language = target.language !== undefined ? target.language : 'ts';
     target.path = target.flat
         ? target.path
-        : core_1.join(target.path, target.name);
+        : (0, core_1.join)(target.path, target.name);
     return target;
 }
 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.move(options.path),
+    return (context) => (0, schematics_1.apply)((0, schematics_1.url)((0, core_1.join)('./files', options.language)), [
+        options.spec ? (0, schematics_1.noop)() : (0, schematics_1.filter)(path => !path.endsWith('.spec.ts')),
+        (0, schematics_1.template)(Object.assign(Object.assign({}, core_1.strings), options)),
+        (0, schematics_1.move)(options.path),
     ])(context);
 }
 function addDeclarationToModule(options) {

package/lib/effect/effect.factory.test.ts

@@ -0,0 +1,190 @@
+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 { ServiceOptions } from './service.schema';
+
+describe('Service Factory', () => {
+  const runner: SchematicTestRunner = new SchematicTestRunner(
+    '.',
+    path.join(process.cwd(), 'src/collection.json'),
+  );
+  it('should manage name only', () => {
+    const options: ServiceOptions = {
+      name: 'foo',
+      skipImport: true,
+      flat: true,
+    };
+    const tree: UnitTestTree = runner.runSchematic('service', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo.service.ts'),
+    ).toBeDefined();
+    expect(
+      files.find(filename => filename === '/foo.service.spec.ts'),
+    ).toBeDefined();
+    expect(tree.readContent('/foo.service.ts')).toEqual(
+      "import { Injectable } from '@nestjs/common';\n" +
+        '\n' +
+        '@Injectable()\n' +
+        'export class FooService {}\n',
+    );
+  });
+  it('should manage name as a path', () => {
+    const options: ServiceOptions = {
+      name: 'bar/foo',
+      skipImport: true,
+      flat: true,
+    };
+    const tree: UnitTestTree = runner.runSchematic('service', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar/foo.service.ts'),
+    ).toBeDefined();
+    expect(
+      files.find(filename => filename === '/bar/foo.service.spec.ts'),
+    ).toBeDefined();
+    expect(tree.readContent('/bar/foo.service.ts')).toEqual(
+      "import { Injectable } from '@nestjs/common';\n" +
+        '\n' +
+        '@Injectable()\n' +
+        'export class FooService {}\n',
+    );
+  });
+  it('should manage name and path', () => {
+    const options: ServiceOptions = {
+      name: 'foo',
+      path: 'bar',
+      skipImport: true,
+      flat: true,
+    };
+    const tree: UnitTestTree = runner.runSchematic('service', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar/foo.service.ts'),
+    ).toBeDefined();
+    expect(
+      files.find(filename => filename === '/bar/foo.service.spec.ts'),
+    ).toBeDefined();
+    expect(tree.readContent('/bar/foo.service.ts')).toEqual(
+      "import { Injectable } from '@nestjs/common';\n" +
+        '\n' +
+        '@Injectable()\n' +
+        'export class FooService {}\n',
+    );
+  });
+  it('should manage name to dasherize', () => {
+    const options: ServiceOptions = {
+      name: 'fooBar',
+      skipImport: true,
+      flat: true,
+    };
+    const tree: UnitTestTree = runner.runSchematic('service', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo-bar.service.ts'),
+    ).toBeDefined();
+    expect(tree.readContent('/foo-bar.service.ts')).toEqual(
+      "import { Injectable } from '@nestjs/common';\n" +
+        '\n' +
+        '@Injectable()\n' +
+        'export class FooBarService {}\n',
+    );
+  });
+  it('should manage path to dasherize', () => {
+    const options: ServiceOptions = {
+      name: 'barBaz/foo',
+      skipImport: true,
+      flat: true,
+    };
+    const tree: UnitTestTree = runner.runSchematic('service', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar-baz/foo.service.ts'),
+    ).toBeDefined();
+    expect(
+      files.find(filename => filename === '/bar-baz/foo.service.spec.ts'),
+    ).toBeDefined();
+    expect(tree.readContent('/bar-baz/foo.service.ts')).toEqual(
+      "import { Injectable } from '@nestjs/common';\n" +
+        '\n' +
+        '@Injectable()\n' +
+        'export class FooService {}\n',
+    );
+  });
+  it('should manage javascript file', () => {
+    const options: ServiceOptions = {
+      name: 'foo',
+      skipImport: true,
+      language: 'js',
+      flat: true,
+    };
+    const tree: UnitTestTree = runner.runSchematic('service', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo.service.js'),
+    ).toBeDefined();
+    expect(
+      files.find(filename => filename === '/foo.service.spec.js'),
+    ).toBeDefined();
+    expect(tree.readContent('/foo.service.js')).toEqual(
+      "import { Injectable } from '@nestjs/common';\n" +
+        '\n' +
+        '@Injectable()\n' +
+        'export class FooService {}\n',
+    );
+  });
+  it('should manage declaration in app module', () => {
+    const app: ApplicationOptions = {
+      name: '',
+    };
+    let tree: UnitTestTree = runner.runSchematic('application', app);
+    const options: ServiceOptions = {
+      name: 'foo',
+      flat: true,
+    };
+    tree = runner.runSchematic('service', 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 { FooService } from './foo.service';\n" +
+        '\n' +
+        '@Module({\n' +
+        '  imports: [],\n' +
+        '  controllers: [AppController],\n' +
+        '  providers: [AppService, FooService],\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: ServiceOptions = {
+      name: 'foo',
+      path: 'foo',
+      flat: true,
+    };
+    tree = runner.runSchematic('service', options, tree);
+    expect(tree.readContent(normalize('/src/foo/foo.module.ts'))).toEqual(
+      "import { Module } from '@nestjs/common';\n" +
+        "import { FooService } from './foo.service';\n" +
+        '\n' +
+        '@Module({\n' +
+        '  providers: [FooService]\n' +
+        '})\n' +
+        'export class FooModule {}\n',
+    );
+  });
+});

package/lib/effect/effect.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 './effect.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 = 'effects';
+  target.type = 'effect';
+
+  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/effect/effect.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;
+}