@gapi/schematics 1.8.122

package/src/lib/library/library.factory.test.ts

@@ -0,0 +1,68 @@
+import {
+  SchematicTestRunner,
+  UnitTestTree,
+} from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+import { LibraryOptions } from './library.schema';
+
+describe('Library Factory', () => {
+  const runner: SchematicTestRunner = new SchematicTestRunner(
+    '.',
+    path.join(process.cwd(), 'src/collection.json'),
+  );
+  it('should manage name only', () => {
+    const options: LibraryOptions = {
+      name: 'project',
+      prefix: 'app',
+    };
+    const tree: UnitTestTree = runner.runSchematic('library', options);
+    const files: string[] = tree.files;
+    expect(files).toEqual([
+      '/libs/project/.gitignore',
+      '/libs/project/package.json',
+      '/libs/project/tsconfig.lib.json',
+      '/libs/project/tslint.json',
+      '/libs/project/src/index.ts',
+      '/libs/project/src/project.module.ts',
+      '/libs/project/src/project.service.spec.ts',
+      '/libs/project/src/project.service.ts',
+    ]);
+  });
+  it('should manage name to dasherize', () => {
+    const options: LibraryOptions = {
+      name: 'awesomeProject',
+      prefix: 'app',
+    };
+    const tree: UnitTestTree = runner.runSchematic('library', options);
+    const files: string[] = tree.files;
+    expect(files).toEqual([
+      '/libs/awesome-project/.gitignore',
+      '/libs/awesome-project/package.json',
+      '/libs/awesome-project/tsconfig.lib.json',
+      '/libs/awesome-project/tslint.json',
+      '/libs/awesome-project/src/index.ts',
+      '/libs/awesome-project/src/awesome-project.module.ts',
+      '/libs/awesome-project/src/awesome-project.service.spec.ts',
+      '/libs/awesome-project/src/awesome-project.service.ts',
+    ]);
+  });
+  it('should manage javascript files', () => {
+    const options: LibraryOptions = {
+      name: 'project',
+      language: 'js',
+      prefix: 'app',
+    };
+    const tree: UnitTestTree = runner.runSchematic('library', options);
+    const files: string[] = tree.files;
+    expect(files).toEqual([
+      '/libs/project/.babelrc',
+      '/libs/project/.gitignore',
+      '/libs/project/jsconfig.json',
+      '/libs/project/package.json',
+      '/libs/project/src/index.js',
+      '/libs/project/src/project.module.js',
+      '/libs/project/src/project.service.js',
+      '/libs/project/src/project.service.spec.js',
+    ]);
+  });
+});

package/src/lib/library/library.factory.ts

@@ -0,0 +1,158 @@
+import {
+  join,
+  normalize,
+  parseJson,
+  Path,
+  strings,
+} from '@angular-devkit/core';
+import {
+  apply,
+  branchAndMerge,
+  chain,
+  mergeWith,
+  move,
+  Rule,
+  SchematicsException,
+  Source,
+  template,
+  Tree,
+  url,
+} from '@angular-devkit/schematics';
+import { DEFAULT_LANGUAGE, DEFAULT_LIB_PATH } from '../defaults';
+import { LibraryOptions } from './library.schema';
+
+type UpdateJsonFn<T> = (obj: T) => T | void;
+interface TsConfigPartialType {
+  compilerOptions: {
+    baseUrl: string;
+    paths: {
+      [key: string]: string[];
+    };
+  };
+}
+
+export function main(options: LibraryOptions): Rule {
+  options = transform(options);
+  return chain([
+    updateTsConfig(options.name, options.prefix, options.path),
+    addLibraryToCliOptions(options.path, options.name),
+    branchAndMerge(mergeWith(generate(options))),
+  ]);
+}
+
+function transform(options: LibraryOptions): LibraryOptions {
+  const target: LibraryOptions = Object.assign({}, options);
+  const defaultSourceRoot =
+    options.rootDir !== undefined ? options.rootDir : DEFAULT_LIB_PATH;
+
+  if (!target.name) {
+    throw new SchematicsException('Option (name) is required.');
+  }
+  target.language = !!target.language ? target.language : DEFAULT_LANGUAGE;
+  target.name = strings.dasherize(target.name);
+  target.path =
+    target.path !== undefined
+      ? join(normalize(defaultSourceRoot), target.path)
+      : normalize(defaultSourceRoot);
+
+  target.prefix = target.prefix || '@app';
+  return target;
+}
+
+function updateJsonFile<T>(
+  host: Tree,
+  path: string,
+  callback: UpdateJsonFn<T>,
+): Tree {
+  const source = host.read(path);
+  if (source) {
+    const sourceText = source.toString('utf-8');
+    const json = parseJson(sourceText);
+    callback((json as {}) as T);
+    host.overwrite(path, JSON.stringify(json, null, 2));
+  }
+
+  return host;
+}
+
+function updateTsConfig(
+  packageName: string,
+  packagePrefix: string,
+  root: string,
+) {
+  return (host: Tree) => {
+    if (!host.exists('tsconfig.json')) {
+      return host;
+    }
+    const distRoot = join(root as Path, packageName, 'src');
+    const packageKey = packagePrefix
+      ? packagePrefix + '/' + packageName
+      : packageName;
+
+    return updateJsonFile(
+      host,
+      'tsconfig.json',
+      (tsconfig: TsConfigPartialType) => {
+        if (!tsconfig.compilerOptions) {
+          tsconfig.compilerOptions = {} as any;
+        }
+        if (!tsconfig.compilerOptions.baseUrl) {
+          tsconfig.compilerOptions.baseUrl = './';
+        }
+        if (!tsconfig.compilerOptions.paths) {
+          tsconfig.compilerOptions.paths = {};
+        }
+        if (!tsconfig.compilerOptions.paths[packageKey]) {
+          tsconfig.compilerOptions.paths[packageKey] = [];
+        }
+        tsconfig.compilerOptions.paths[packageKey].push(distRoot);
+
+        const deepPackagePath = packageKey + '/*';
+        if (!tsconfig.compilerOptions.paths[deepPackagePath]) {
+          tsconfig.compilerOptions.paths[deepPackagePath] = [];
+        }
+        tsconfig.compilerOptions.paths[deepPackagePath].push(distRoot + '/*');
+      },
+    );
+  };
+}
+
+function addLibraryToCliOptions(
+  projectRoot: string,
+  projectName: string,
+): Rule {
+  const project = {
+    root: join(projectRoot as Path, projectName),
+    sourceRoot: join(projectRoot as Path, projectName, 'src'),
+  };
+  return (host: Tree) => {
+    const nestCliFileExists = host.exists('nest-cli.json');
+    const nestFileExists = host.exists('nest.json');
+
+    if (!nestCliFileExists && !nestFileExists) {
+      return host;
+    }
+    return updateJsonFile(
+      host,
+      nestCliFileExists ? 'nest-cli.json' : 'nest.json',
+      (optionsFile: Record<string, any>) => {
+        if (!optionsFile.projects) {
+          optionsFile.projects = {} as any;
+        }
+        optionsFile.projects[projectName] = project;
+      },
+    );
+  };
+}
+
+function generate(options: LibraryOptions): Source {
+  const path = join(options.path as Path, options.name);
+
+  return apply(url(join('./files' as Path, options.language)), [
+    template({
+      ...strings,
+      ...options,
+    }),
+    move(path),
+  ]);
+}

package/src/lib/library/library.schema.d.ts

@@ -0,0 +1,24 @@
+import { Path } from '@angular-devkit/core';
+
+export interface LibraryOptions {
+  /**
+   * Nest library name.
+   */
+  name: string;
+  /**
+   * Prefix (scope)
+   */
+  prefix?: string;
+  /**
+   * Application language.
+   */
+  language?: string;
+  /**
+   * The path to create the library.
+   */
+  path?: string | Path;
+  /**
+   * The libraries root directory
+   */
+  rootDir?: string | Path;
+}

package/src/lib/library/schema.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "SchematicsNestLibrary",
+  "title": "Nest Library Options Schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the library.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the library?"
+    },
+    "prefix": {
+      "type": "string",
+      "description": "The prefix of the library.",
+      "x-prompt": "What prefix would you like to use for the library (default: @app)?"
+    },
+    "language": {
+      "type": "string",
+      "description": "Nest library language."
+    },
+    "path": {
+      "type": "string",
+      "format": "path",
+      "description": "The path to create the library."
+    },
+    "rootDir": {
+      "type": "string",
+      "format": "path",
+      "description": "The libraries root directory."
+    }
+  },
+  "required": ["name", "prefix"]
+}

package/src/lib/module/files/js/__name__.module.js

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

package/src/lib/module/files/ts/__name__.module.ts

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

package/src/lib/module/module.factory.test.ts

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