Merge pull request #18 from kaltepeter/feature/schemas

feat(schemas): extend schema and split builders
angular-extensions · Nov 3, 2020 · f67f917 · f67f917
2 parents 0615740 + 4d3171b
commit f67f917
Show file tree

Hide file tree

Showing 12 changed files with 512 additions and 144 deletions.
diff --git a/README.md b/README.md
@@ -19,10 +19,16 @@ Angular CLI: `ng add @angular-extensions/svg-icons-builder`
 
 ### Configuring the builder
 
-To use the builder you need to add a new entry to your `architect` object inside your `angular.json`. In our example we call it `generate-icons`. You then need to specify the following properties:
+To use the builder you need to add a new entry to your `architect` object inside your `angular.json`. 
 
-- **Builder**: `"@angular-extensions/svg-icons-builder:svg-icons-builder"`
-- **Config**: A valid [svg-to-ts configuration](https://github.com/kreuzerk/svg-to-ts). ⚠️ the options depend on the `conversionType` and may therefore vary. Means, a configuration for the `convesionType: "files"` will look different than configuration for the `conversionType: "constants"`
+A valid [svg-to-ts configuration](https://github.com/kreuzerk/svg-to-ts). ⚠️ the options depend on the `conversionType` and may therefore vary. Means, a configuration for the `convesionType: "files"` will look different than configuration for the `conversionType: "constants"`. Each `conversionType` has it's own builder.
+
+In our example we call it `generate-icons`. You then need to specify the following properties:
+
+## `conversionType: constants`
+
+- **Builder**: `"@angular-extensions/svg-icons-builder:svg-icons-constants-builder"`
+- **Config**: [svg-to-ts constants config](https://github.com/kreuzerk/svg-to-ts#2-multiple-constants---treeshakable-and-typesafe-with-one-file-conversiontypeconstants)
 
 ```json
 "generate-icons": {
@@ -48,6 +54,68 @@ To use the builder you need to add a new entry to your `architect` object inside
 }
 ```
 
+## `conversionType: files`
+
+- **Builder**: `"@angular-extensions/svg-icons-builder:svg-icons-files-builder"`
+- **Config**: [svg-to-ts files config](https://github.com/kreuzerk/svg-to-ts#3-tree-shakable-and-optimized-for-lazy-loading-conversiontypefiles)
+
+```json
+  "generate-icons": {
+    "builder": "@angular-extensions/svg-icons-builder:svg-icons-files-builder",
+    "options": {
+      "conversionType": "files",
+      "srcFiles": ["./projects/dinosaur-icons/icons/**/*.svg"],
+      "outputDirectory": "./projects/dinosaur-icons/icons",
+      "interfaceName": "DinosaurIcon",
+      "generateType": false,
+      "generateTypeObject": false,
+      "generateCompleteIconSet": false,
+      "exportCompleteIconSet": false,
+      "fileName": "dinosaur-icons",
+      "iconsFolderName": "dinosaur-icons",
+      "objectName": "dinosaur-icons",
+      "typeName": "dinosaurIcon",
+      "prefix": "dinosaurIcon",
+      "modelFileName": "dinosaur-icons",
+      "barrelFileName": "index",
+      "svgoConfig": {
+        "plugins": [
+          {
+            "cleanupAttrs": true
+          }
+        ]
+      },
+      "compileSources": true
+    }
+  }
+```
+
+## `conversionType: object`
+
+- **Builder**: `"@angular-extensions/svg-icons-builder:svg-icons-object-builder"`
+- **Config**: [svg-to-ts object config](https://github.com/kreuzerk/svg-to-ts#1-converting-to-a-single-object-conversiontypeobject)
+
+```json
+  "generate-icons": {
+    "builder": "@angular-extensions/svg-icons-builder:svg-icons-object-builder",
+    "options": {
+      "conversionType": "object",
+      "srcFiles": ["./projects/dinosaur-icons/icons/**/*.svg"],
+      "outputDirectory": "./projects/dinosaur-icons/icons",
+      "fileName": "dinosaur-icons",
+      "objectName": "dinosaur-icons",
+      "svgoConfig": {
+        "plugins": [
+          {
+            "cleanupAttrs": true
+          }
+        ]
+      },
+      "compileSources": true
+    }
+  }
+```
+
 ### Run the builder
 
 In order to run the builder you have to add a new npm script to your `package.json`. Replace `name-of-your-app` with the name of your application 😉.

diff --git a/builders.json b/builders.json
@@ -1,9 +1,20 @@
 {
+  "$schema": "@angular-devkit/architect/src/builders-schema.json",
   "builders": {
-    "svg-icons-builder": {
-      "implementation": "./svg-icons-builder",
+    "svg-icons-constants-builder": {
+      "implementation": "./svg-icons-builder/constants",
       "schema": "./svg-icons-builder/schema.json",
-      "description": "Build SVG icons."
+      "description": "Build SVG icons using `constants` conversion type."
+    },
+    "svg-icons-object-builder": {
+      "implementation": "./svg-icons-builder/object",
+      "schema": "./svg-icons-builder/schema.json",
+      "description": "Build SVG icons using `objects` conversion type."
+    },
+    "svg-icons-files-builder": {
+      "implementation": "./svg-icons-builder/files",
+      "schema": "./svg-icons-builder/schema.json",
+      "description": "Build SVG icons using `files` conversion type."
     }
   }
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/svg-icons-builder/constants/index.spec.ts b/svg-icons-builder/constants/index.spec.ts
@@ -0,0 +1,54 @@
+import { Architect } from '@angular-devkit/architect';
+import { TestingArchitectHost } from '@angular-devkit/architect/testing';
+import { logging, schema } from '@angular-devkit/core';
+import { ConversionType } from 'svg-to-ts';
+import { defaultCommonOptions } from '../test-helpers';
+const { join } = require('path');
+
+describe('svg-icons-builder', () => {
+  let architect: Architect;
+  let architectHost: TestingArchitectHost;
+
+  beforeEach(async () => {
+    const registry = new schema.CoreSchemaRegistry();
+    registry.addPostTransform(schema.transforms.addUndefinedDefaults);
+    const workspaceRoot = join(__dirname, '..', '..');
+
+    architectHost = new TestingArchitectHost('/root', '/root');
+    architect = new Architect(architectHost, registry);
+
+    await architectHost.addBuilderFromPackage(workspaceRoot);
+  });
+
+  it('generates `constants` for icons', async () => {
+    const logger = new logging.Logger('');
+    const logs: string[] = [];
+    logger.subscribe((ev) => logs.push(ev.message));
+
+    const run = await architect.scheduleBuilder(
+      '@angular-extensions/svg-icons-builder:svg-icons-constants-builder',
+      {
+        ...defaultCommonOptions(),
+        conversionType: ConversionType.CONSTANTS,
+        fileName: 'dinosaur-icons',
+        typeName: 'dinosaurIcon',
+        generateType: true,
+        generateTypeObject: true,
+        generateCompleteIconSet: true,
+        prefix: 'dinosaurIcon',
+        interfaceName: 'DinosaurIcon',
+      },
+      { logger }
+    );
+
+    expect(await run.result).toEqual(
+      expect.objectContaining({
+        success: true,
+      })
+    );
+
+    await run.stop();
+
+    expect(logs).toContain('We are using the conversion type "constants"');
+  });
+});
diff --git a/svg-icons-builder/constants/index.ts b/svg-icons-builder/constants/index.ts
@@ -0,0 +1,28 @@
+import { BuilderContext, BuilderOutput, createBuilder } from '@angular-devkit/architect';
+import { JsonObject } from '@angular-devkit/core';
+import { ConstantsConversionOptions, ConversionType, convertToConstants, mergeWithDefaults } from 'svg-to-ts';
+
+interface Options extends ConstantsConversionOptions {}
+
+// Using `Options & JsonObject` instead of extending JsonObject because of optional boolean
+export default createBuilder<Options & JsonObject>((options: Options, context: BuilderContext) => {
+  return new Promise<BuilderOutput>(async (resolve, reject) => {
+    try {
+      if (options.conversionType !== ConversionType.CONSTANTS) {
+        reject(new Error(`This builder only supports '${ConversionType.CONSTANTS}' conversionType.`));
+      }
+
+      const conversionOptions = await mergeWithDefaults(options);
+      context.logger.info('We are using the conversion type "constants"');
+      await convertToConstants((conversionOptions as unknown) as ConstantsConversionOptions);
+
+      resolve({ success: true });
+      context.reportStatus(`Done.`);
+    } catch (error) {
+      context.reportStatus(`Error: ${error.message}`);
+      reject(error);
+      process.disconnect();
+      process.exit(1);
+    }
+  });
+});
diff --git a/svg-icons-builder/files/index.spec.ts b/svg-icons-builder/files/index.spec.ts
@@ -0,0 +1,57 @@
+import { Architect } from '@angular-devkit/architect';
+import { TestingArchitectHost } from '@angular-devkit/architect/testing';
+import { logging, schema } from '@angular-devkit/core';
+import { defaultCommonOptions } from '../test-helpers';
+const { join } = require('path');
+
+describe('svg-icons-builder', () => {
+  let architect: Architect;
+  let architectHost: TestingArchitectHost;
+
+  beforeEach(async () => {
+    const registry = new schema.CoreSchemaRegistry();
+    registry.addPostTransform(schema.transforms.addUndefinedDefaults);
+    const workspaceRoot = join(__dirname, '..', '..');
+
+    architectHost = new TestingArchitectHost('/root', '/root');
+    architect = new Architect(architectHost, registry);
+
+    await architectHost.addBuilderFromPackage(workspaceRoot);
+    console.log('#', Array.from((architectHost as any)._builderMap.keys()));
+  });
+
+  it('generates `files` for icons', async () => {
+    const logger = new logging.Logger('');
+    const logs: string[] = [];
+    logger.subscribe((ev) => logs.push(ev.message));
+
+    const run = await architect.scheduleBuilder(
+      '@angular-extensions/svg-icons-builder:svg-icons-files-builder',
+      {
+        ...defaultCommonOptions(),
+        conversionType: 'files',
+        typeName: 'dinosaurIcon',
+        generateType: true,
+        generateTypeObject: true,
+        exportCompleteIconSet: true,
+        prefix: 'dinosaurIcon',
+        interfaceName: 'DinosaurIcon',
+        modelFileName: 'dinosaur-icons.model',
+        iconsFolderName: 'build',
+        compileSources: true,
+        barrelFileName: 'index',
+      },
+      { logger }
+    );
+
+    expect(await run.result).toEqual(
+      expect.objectContaining({
+        success: true,
+      })
+    );
+
+    await run.stop();
+
+    expect(logs).toContain('We are using the conversion type "files"');
+  });
+});
diff --git a/svg-icons-builder/files/index.ts b/svg-icons-builder/files/index.ts
@@ -0,0 +1,33 @@
+import { BuilderContext, BuilderOutput, createBuilder } from '@angular-devkit/architect';
+import { JsonObject } from '@angular-devkit/core';
+import {
+  ConversionType,
+  FileConversionOptions,
+  convertToFiles,
+  mergeWithDefaults,
+} from 'svg-to-ts';
+
+interface Options extends FileConversionOptions {}
+
+// Using `Options & JsonObject` instead of extending JsonObject because of optional boolean
+export default createBuilder<Options & JsonObject>((options: Options, context: BuilderContext) => {
+  return new Promise<BuilderOutput>(async (resolve, reject) => {
+    try {
+      if (options.conversionType !== ConversionType.FILES) {
+        reject(new Error(`This builder only supports '${ConversionType.FILES}' conversionType.`));
+      }
+
+      const conversionOptions = await mergeWithDefaults(options);
+      context.logger.info('We are using the conversion type "files"');
+      await convertToFiles((conversionOptions as unknown) as FileConversionOptions);
+
+      resolve({ success: true });
+      context.reportStatus(`Done.`);
+    } catch (error) {
+      context.reportStatus(`Error: ${error.message}`);
+      reject(error);
+      process.disconnect();
+      process.exit(1);
+    }
+  });
+});
diff --git a/svg-icons-builder/index.ts b/svg-icons-builder/index.ts