@rxdi/schematics 0.7.124 → 0.7.128

package/lib/plugin/plugin.schema.d.ts

@@ -0,0 +1,44 @@
+import { Path } from '@angular-devkit/core';
+
+export interface PluginOptions {
+  /**
+   * 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/lib/plugin/schema.json

@@ -0,0 +1,52 @@
+{
+  "$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."
+    },
+    "method": {
+      "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/provider/files/js/__name__.js

@@ -0,0 +1,4 @@
+import { Injectable } from '@rxdi/core';
+
+@Injectable()
+export class <%= classify(name) %> {}

package/lib/provider/files/js/__name__.spec.js

@@ -0,0 +1,17 @@
+import 'jest';
+import { Container, createTestBed } from '@gapi/core';
+import { <%= classify(name) %> } from './<%= name %>';
+
+describe('<%= classify(name) %> Injectable', () => {
+  beforeAll(async () => {
+    await createTestBed({
+      imports: [],
+      providers: [<%= classify(name) %>]
+    }).toPromise();
+  });
+
+  it('should be defined', done => {
+    expect(Container.has(<%= classify(name) %>)).toBeTruthy();
+    done();
+  });
+});

package/lib/provider/files/ts/__name__.spec.ts

@@ -0,0 +1,17 @@
+import 'jest';
+import { Container, createTestBed } from '@gapi/core';
+import { <%= classify(name) %> } from './<%= name %>';
+
+describe('<%= classify(name) %> Injectable', () => {
+  beforeAll(async () => {
+    await createTestBed({
+      imports: [],
+      providers: [<%= classify(name) %>]
+    }).toPromise();
+  });
+
+  it('should be defined', done => {
+    expect(Container.has(<%= classify(name) %>)).toBeTruthy();
+    done();
+  });
+});

package/lib/provider/files/ts/__name__.ts

@@ -0,0 +1,4 @@
+import { Injectable } from '@rxdi/core';
+
+@Injectable()
+export class <%= classify(name) %> {}

package/lib/provider/provider.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");
@@ -36,7 +35,7 @@ function transform(options) {
 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/provider/provider.factory.test.ts

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

package/lib/provider/provider.factory.ts

@@ -0,0 +1,89 @@
+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 {
+  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 { ProviderOptions } from './provider.schema';
+
+export function main(options: ProviderOptions): Rule {
+  options = transform(options);
+  return (tree: Tree, context: SchematicContext) => {
+    return branchAndMerge(
+      chain([
+        mergeSourceRoot(options),
+        addDeclarationToModule(options),
+        mergeWith(generate(options)),
+      ]),
+    )(tree, context);
+  };
+}
+
+function transform(options: ProviderOptions): ProviderOptions {
+  const target: ProviderOptions = Object.assign({}, options);
+  target.metadata = 'providers';
+
+  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: ProviderOptions) {
+  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: ProviderOptions): 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/provider/provider.schema.d.ts

@@ -0,0 +1,44 @@
+import { Path } from '@angular-devkit/core';
+
+export interface ProviderOptions {
+  /**
+   * The name of the provider.
+   */
+  name: string;
+  /**
+   * The path to create the provider.
+   */
+  path?: string;
+  /**
+   * The path to insert the provider 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/provider/schema.json

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

package/lib/resolver/files/js/__name__.resolver.js

@@ -0,0 +1,4 @@
+import { Resolver } from '@nestjs/graphql';
+
+@Resolver('<%= classify(name) %>')
+export class <%= classify(name) %>Resolver {}

package/lib/resolver/files/js/__name__.resolver.spec.js

@@ -0,0 +1,18 @@
+import { Test } from '@nestjs/testing';
+import { <%= classify(name) %>Resolver } from './<%= name %>.resolver';
+
+describe('<%= classify(name) %>Resolver', () => {
+  let resolver;
+
+  beforeEach(async () => {
+    const module = await Test.createTestingModule({
+      providers: [<%= classify(name) %>Resolver],
+    }).compile();
+
+    resolver = module.get(<%= classify(name) %>Resolver);
+  });
+
+  it('should be defined', () => {
+    expect(resolver).toBeDefined();
+  });
+});

package/lib/resolver/files/ts/__name__.resolver.spec.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { <%= classify(name) %>Resolver } from './<%= name %>.resolver';
+
+describe('<%= classify(name) %>Resolver', () => {
+  let resolver: <%= classify(name) %>Resolver;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [<%= classify(name) %>Resolver],
+    }).compile();
+
+    resolver = module.get<<%= classify(name) %>Resolver>(<%= classify(name) %>Resolver);
+  });
+
+  it('should be defined', () => {
+    expect(resolver).toBeDefined();
+  });
+});

package/lib/resolver/files/ts/__name__.resolver.ts

@@ -0,0 +1,4 @@
+import { Resolver } from '@nestjs/graphql';
+
+@Resolver('<%= classify(name) %>')
+export class <%= classify(name) %>Resolver {}

package/lib/resolver/resolver.factory.js

@@ -10,10 +10,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);
     };
 }
@@ -31,14 +31,14 @@ 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)), [
-        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) {