definition-generator-framework 1.12.5 → 1.12.7

package/dist/pipeline/1-select-definitions-helper.d.ts

@@ -1,20 +1,20 @@
 import { FileInfo, LocationInFile, ErrorLog } from '../framework/interfaces';
 export interface DefinitionPlaneText {
-    readonly type: string;
-    readonly content: string[];
-    readonly location: LocationInFile;
+  readonly type: string;
+  readonly content: string[];
+  readonly location: LocationInFile;
 }
 export interface SelectDefinitionsResult {
-    definitionPlaneTexts: DefinitionPlaneText[];
-    errorLogs: ErrorLog[];
+  definitionPlaneTexts: DefinitionPlaneText[];
+  errorLogs: ErrorLog[];
 }
 export declare class SelectDefinitionsHelper {
-    private definitionsStarted;
-    private currentItem;
-    private definitionPlaneTexts;
-    private errorLogs;
-    private currentFilePath;
-    process(file: FileInfo): SelectDefinitionsResult;
-    private flushCurrentItem;
-    private onDeclarationEncountered;
+  private definitionsStarted;
+  private currentItem;
+  private definitionPlaneTexts;
+  private errorLogs;
+  private currentFilePath;
+  process(file: FileInfo): SelectDefinitionsResult;
+  private flushCurrentItem;
+  private onDeclarationEncountered;
 }

package/dist/pipeline/1-select-definitions-helper.js

@@ -1,80 +1,76 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
 exports.SelectDefinitionsHelper = void 0;
-const common_functions_1 = require("../helpers/common-functions/common-functions");
-const definition_store_1 = require("../framework/definition-store");
+const common_functions_1 = require('../helpers/common-functions/common-functions');
+const definition_store_1 = require('../framework/definition-store');
 class SelectDefinitionsHelper {
-    constructor() {
-        this.definitionsStarted = false;
-        this.definitionPlaneTexts = [];
-        this.errorLogs = [];
-        this.currentFilePath = '';
-    }
-    process(file) {
-        this.definitionsStarted = false;
-        this.currentItem = undefined;
-        this.definitionPlaneTexts = [];
-        this.errorLogs = [];
-        this.currentFilePath = file.path;
-        file.content.split('\n').forEach((row, index) => {
-            let trimmedRow = common_functions_1.CommonFunctions.removeWhiteSpace(row);
-            if (this.definitionsStarted) {
-                if (trimmedRow.startsWith('###')) {
-                    this.flushCurrentItem();
-                    this.onDeclarationEncountered(row, index, trimmedRow.substring(4));
-                }
-                else if (this.currentItem && trimmedRow.length > 0) {
-                    this.currentItem.content.push(common_functions_1.CommonFunctions.removeComments(row));
-                }
-            }
-            else if (trimmedRow === '# DEFINITIONS') {
-                this.definitionsStarted = true;
-            }
-        });
-        this.flushCurrentItem();
-        return {
-            definitionPlaneTexts: this.definitionPlaneTexts,
-            errorLogs: this.errorLogs
-        };
-    }
-    flushCurrentItem() {
-        if (this.currentItem) {
-            if (this.currentItem.content.length > 0) {
-                this.definitionPlaneTexts.push(this.currentItem);
-            }
-            else {
-                let errorLog = {
-                    description: 'Definitions cannot be empty!',
-                    location: this.currentItem.location
-                };
-                this.errorLogs.push(errorLog);
-            }
+  constructor() {
+    this.definitionsStarted = false;
+    this.definitionPlaneTexts = [];
+    this.errorLogs = [];
+    this.currentFilePath = '';
+  }
+  process(file) {
+    this.definitionsStarted = false;
+    this.currentItem = undefined;
+    this.definitionPlaneTexts = [];
+    this.errorLogs = [];
+    this.currentFilePath = file.path;
+    file.content.split('\n').forEach((row, index) => {
+      let trimmedRow = common_functions_1.CommonFunctions.removeWhiteSpace(row);
+      if (this.definitionsStarted) {
+        if (trimmedRow.startsWith('###')) {
+          this.flushCurrentItem();
+          this.onDeclarationEncountered(row, index, trimmedRow.substring(4));
+        } else if (this.currentItem && trimmedRow.length > 0) {
+          this.currentItem.content.push(common_functions_1.CommonFunctions.removeComments(row));
         }
-        this.currentItem = undefined;
+      } else if (trimmedRow === '# DEFINITIONS') {
+        this.definitionsStarted = true;
+      }
+    });
+    this.flushCurrentItem();
+    return {
+      definitionPlaneTexts: this.definitionPlaneTexts,
+      errorLogs: this.errorLogs
+    };
+  }
+  flushCurrentItem() {
+    if (this.currentItem) {
+      if (this.currentItem.content.length > 0) {
+        this.definitionPlaneTexts.push(this.currentItem);
+      } else {
+        let errorLog = {
+          description: 'Definitions cannot be empty!',
+          location: this.currentItem.location
+        };
+        this.errorLogs.push(errorLog);
+      }
     }
-    onDeclarationEncountered(row, index, componentName) {
-        if (definition_store_1.DefinitionStore['isValidComponentName'](componentName)) {
-            this.currentItem = {
-                type: componentName,
-                location: {
-                    line: index + 1,
-                    path: this.currentFilePath
-                },
-                content: []
-            };
-        }
-        else {
-            let errorLog = {
-                description: `Invalid definition header: "${row.trim()}"`,
-                location: {
-                    line: index + 1,
-                    path: this.currentFilePath
-                }
-            };
-            this.errorLogs.push(errorLog);
-            this.currentItem = undefined;
+    this.currentItem = undefined;
+  }
+  onDeclarationEncountered(row, index, componentName) {
+    if (definition_store_1.DefinitionStore['isValidComponentName'](componentName)) {
+      this.currentItem = {
+        type: componentName,
+        location: {
+          line: index + 1,
+          path: this.currentFilePath
+        },
+        content: []
+      };
+    } else {
+      let errorLog = {
+        description: `Invalid definition header: "${row.trim()}"`,
+        location: {
+          line: index + 1,
+          path: this.currentFilePath
         }
+      };
+      this.errorLogs.push(errorLog);
+      this.currentItem = undefined;
     }
+  }
 }
 exports.SelectDefinitionsHelper = SelectDefinitionsHelper;
-//# sourceMappingURL=1-select-definitions-helper.js.map
+//# sourceMappingURL=1-select-definitions-helper.js.map

package/dist/pipeline/1-select-definitions.helper.test.js

@@ -19,12 +19,12 @@ definition_store_1.DefinitionStore['definitionsMap'].set(custom_validator_helper
         (0, vitest_1.expect)(result.errorLogs).toStrictEqual([]);
     });
     (0, vitest_1.test)('should handle files without definitions', () => {
-        let content = `
-      Explanation
-
-      ### ASSET
-      Name: singular name
-      Path: path to file
+        let content = `
+      Explanation
+
+      ### ASSET
+      Name: singular name
+      Path: path to file
     `;
         let fileInfo = (0, mocks_1.getMockFileInfo)(content);
         let result = selectDefinitionsHelper.process(fileInfo);
@@ -32,11 +32,11 @@ definition_store_1.DefinitionStore['definitionsMap'].set(custom_validator_helper
         (0, vitest_1.expect)(result.errorLogs).toStrictEqual([]);
     });
     (0, vitest_1.test)('should select definitions', () => {
-        let content = `
-      # DEFINITIONS
-      ### ASSET
-      Name: test
-      Path: test.png
+        let content = `
+      # DEFINITIONS
+      ### ASSET
+      Name: test
+      Path: test.png
     `;
         let fileInfo = (0, mocks_1.getMockFileInfo)(content);
         let result = selectDefinitionsHelper.process(fileInfo);
@@ -50,12 +50,12 @@ definition_store_1.DefinitionStore['definitionsMap'].set(custom_validator_helper
         (0, vitest_1.expect)(result.errorLogs).toStrictEqual([]);
     });
     (0, vitest_1.test)('should ignore comments', () => {
-        let content = `
-      # DEFINITIONS
-      ### ASSET
-      Name: test // comment
-      Path: test.png     // comment
-      // ----comment----\r
+        let content = `
+      # DEFINITIONS
+      ### ASSET
+      Name: test // comment
+      Path: test.png     // comment
+      // ----comment----\r
     `;
         let fileInfo = (0, mocks_1.getMockFileInfo)(content);
         let result = selectDefinitionsHelper.process(fileInfo);
@@ -69,9 +69,9 @@ definition_store_1.DefinitionStore['definitionsMap'].set(custom_validator_helper
         (0, vitest_1.expect)(result.errorLogs).toStrictEqual([]);
     });
     (0, vitest_1.test)('should not allow empty definitions', () => {
-        let content = `
-      # DEFINITIONS
-      ### ASSET
+        let content = `
+      # DEFINITIONS
+      ### ASSET
     `;
         let fileInfo = (0, mocks_1.getMockFileInfo)(content);
         let result = selectDefinitionsHelper.process(fileInfo);
@@ -84,14 +84,14 @@ definition_store_1.DefinitionStore['definitionsMap'].set(custom_validator_helper
         ]);
     });
     (0, vitest_1.test)('should not allow unknown definition header after the first valid definition', () => {
-        let content = `
-      # DEFINITIONS
-      ### ASSET
-      Name: test
-      Path: test.png
-
-      ### Some text
-      some text
+        let content = `
+      # DEFINITIONS
+      ### ASSET
+      Name: test
+      Path: test.png
+
+      ### Some text
+      some text
     `;
         let fileInfo = (0, mocks_1.getMockFileInfo)(content);
         let result = selectDefinitionsHelper.process(fileInfo);
@@ -103,18 +103,18 @@ definition_store_1.DefinitionStore['definitionsMap'].set(custom_validator_helper
         ]);
     });
     (0, vitest_1.test)('invalid definitions should not corrupt other definitions', () => {
-        let content = `
-      # DEFINITIONS
-      ### ASSET
-      Name: test
-      Path: test.png
-
-      ### Some text
-      some text
-
-      ### ASSET
-      Name: test2
-      Path: test2.png
+        let content = `
+      # DEFINITIONS
+      ### ASSET
+      Name: test
+      Path: test.png
+
+      ### Some text
+      some text
+
+      ### ASSET
+      Name: test2
+      Path: test2.png
     `;
         let fileInfo = (0, mocks_1.getMockFileInfo)(content);
         let result = selectDefinitionsHelper.process(fileInfo);

package/dist/pipeline/1-select-definitions.spec.js

@@ -1,140 +1,140 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1_select_definitions_helper_1 = require("./1-select-definitions-helper");
-const mocks_1 = require("../_mocks/mocks");
-const custom_validator_helper_spec_1 = require("../helpers/validator/custom-validator-helper/custom-validator.helper.spec");
-const definition_store_1 = require("../framework/definition-store");
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+const _1_select_definitions_helper_1 = require('./1-select-definitions-helper');
+const mocks_1 = require('../_mocks/mocks');
+const custom_validator_helper_spec_1 = require('../helpers/validator/custom-validator-helper/custom-validator.helper.spec');
+const definition_store_1 = require('../framework/definition-store');
 definition_store_1.DefinitionStore['definitionsMap'].set(custom_validator_helper_spec_1.AssetComponentName, new Map());
 describe('SELECT DEFINITIONS HELPER', () => {
-    let selectDefinitionsHelper;
-    beforeEach(() => {
-        selectDefinitionsHelper = new _1_select_definitions_helper_1.SelectDefinitionsHelper();
-    });
-    test('should handle empty files', () => {
-        let content = ``;
-        let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-        let result = selectDefinitionsHelper.process(fileInfo);
-        expect(result.definitionPlaneTexts).toStrictEqual([]);
-        expect(result.errorLogs).toStrictEqual([]);
-    });
-    test('should handle files without definitions', () => {
-        let content = `
-      Explanation
-
-      ### ASSET
-      Name: singular name
-      Path: path to file
+  let selectDefinitionsHelper;
+  beforeEach(() => {
+    selectDefinitionsHelper = new _1_select_definitions_helper_1.SelectDefinitionsHelper();
+  });
+  test('should handle empty files', () => {
+    let content = ``;
+    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
+    let result = selectDefinitionsHelper.process(fileInfo);
+    expect(result.definitionPlaneTexts).toStrictEqual([]);
+    expect(result.errorLogs).toStrictEqual([]);
+  });
+  test('should handle files without definitions', () => {
+    let content = `
+      Explanation
+
+      ### ASSET
+      Name: singular name
+      Path: path to file
     `;
-        let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-        let result = selectDefinitionsHelper.process(fileInfo);
-        expect(result.definitionPlaneTexts).toStrictEqual([]);
-        expect(result.errorLogs).toStrictEqual([]);
-    });
-    test('should select definitions', () => {
-        let content = `
-      # DEFINITIONS
-      ### ASSET
-      Name: test
-      Path: test.png
+    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
+    let result = selectDefinitionsHelper.process(fileInfo);
+    expect(result.definitionPlaneTexts).toStrictEqual([]);
+    expect(result.errorLogs).toStrictEqual([]);
+  });
+  test('should select definitions', () => {
+    let content = `
+      # DEFINITIONS
+      ### ASSET
+      Name: test
+      Path: test.png
     `;
-        let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-        let result = selectDefinitionsHelper.process(fileInfo);
-        expect(result.definitionPlaneTexts).toStrictEqual([
-            {
-                type: 'ASSET',
-                content: ['      Name: test', '      Path: test.png'],
-                location: { line: 3, path: fileInfo.path }
-            }
-        ]);
-        expect(result.errorLogs).toStrictEqual([]);
-    });
-    test('should ignore comments', () => {
-        let content = `
-      # DEFINITIONS
-      ### ASSET
-      Name: test // comment
-      Path: test.png     // comment
-      // ----comment----\r
+    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
+    let result = selectDefinitionsHelper.process(fileInfo);
+    expect(result.definitionPlaneTexts).toStrictEqual([
+      {
+        type: 'ASSET',
+        content: ['      Name: test', '      Path: test.png'],
+        location: { line: 3, path: fileInfo.path }
+      }
+    ]);
+    expect(result.errorLogs).toStrictEqual([]);
+  });
+  test('should ignore comments', () => {
+    let content = `
+      # DEFINITIONS
+      ### ASSET
+      Name: test // comment
+      Path: test.png     // comment
+      // ----comment----\r
     `;
-        let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-        let result = selectDefinitionsHelper.process(fileInfo);
-        expect(result.definitionPlaneTexts).toStrictEqual([
-            {
-                type: 'ASSET',
-                content: ['      Name: test', '      Path: test.png'],
-                location: { line: 3, path: fileInfo.path }
-            }
-        ]);
-        expect(result.errorLogs).toStrictEqual([]);
-    });
-    test('should not allow empty definitions', () => {
-        let content = `
-      # DEFINITIONS
-      ### ASSET
+    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
+    let result = selectDefinitionsHelper.process(fileInfo);
+    expect(result.definitionPlaneTexts).toStrictEqual([
+      {
+        type: 'ASSET',
+        content: ['      Name: test', '      Path: test.png'],
+        location: { line: 3, path: fileInfo.path }
+      }
+    ]);
+    expect(result.errorLogs).toStrictEqual([]);
+  });
+  test('should not allow empty definitions', () => {
+    let content = `
+      # DEFINITIONS
+      ### ASSET
     `;
-        let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-        let result = selectDefinitionsHelper.process(fileInfo);
-        expect(result.definitionPlaneTexts).toStrictEqual([]);
-        expect(result.errorLogs).toStrictEqual([
-            {
-                description: 'Definitions cannot be empty!',
-                location: { line: 3, path: fileInfo.path }
-            }
-        ]);
-    });
-    test('should not allow unknown definition header after the first valid definition', () => {
-        let content = `
-      # DEFINITIONS
-      ### ASSET
-      Name: test
-      Path: test.png
-
-      ### Some text
-      some text
+    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
+    let result = selectDefinitionsHelper.process(fileInfo);
+    expect(result.definitionPlaneTexts).toStrictEqual([]);
+    expect(result.errorLogs).toStrictEqual([
+      {
+        description: 'Definitions cannot be empty!',
+        location: { line: 3, path: fileInfo.path }
+      }
+    ]);
+  });
+  test('should not allow unknown definition header after the first valid definition', () => {
+    let content = `
+      # DEFINITIONS
+      ### ASSET
+      Name: test
+      Path: test.png
+
+      ### Some text
+      some text
     `;
-        let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-        let result = selectDefinitionsHelper.process(fileInfo);
-        expect(result.errorLogs).toStrictEqual([
-            {
-                description: 'Invalid definition header: "### Some text"',
-                location: { line: 7, path: fileInfo.path }
-            }
-        ]);
-    });
-    test('invalid definitions should not corrupt other definitions', () => {
-        let content = `
-      # DEFINITIONS
-      ### ASSET
-      Name: test
-      Path: test.png
-
-      ### Some text
-      some text
-
-      ### ASSET
-      Name: test2
-      Path: test2.png
+    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
+    let result = selectDefinitionsHelper.process(fileInfo);
+    expect(result.errorLogs).toStrictEqual([
+      {
+        description: 'Invalid definition header: "### Some text"',
+        location: { line: 7, path: fileInfo.path }
+      }
+    ]);
+  });
+  test('invalid definitions should not corrupt other definitions', () => {
+    let content = `
+      # DEFINITIONS
+      ### ASSET
+      Name: test
+      Path: test.png
+
+      ### Some text
+      some text
+
+      ### ASSET
+      Name: test2
+      Path: test2.png
     `;
-        let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-        let result = selectDefinitionsHelper.process(fileInfo);
-        expect(result.definitionPlaneTexts).toStrictEqual([
-            {
-                type: 'ASSET',
-                content: ['      Name: test', '      Path: test.png'],
-                location: { line: 3, path: fileInfo.path }
-            },
-            {
-                type: 'ASSET',
-                content: ['      Name: test2', '      Path: test2.png'],
-                location: { line: 10, path: fileInfo.path }
-            }
-        ]);
-        expect(result.errorLogs).toStrictEqual([
-            {
-                description: 'Invalid definition header: "### Some text"',
-                location: { line: 7, path: fileInfo.path }
-            }
-        ]);
-    });
+    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
+    let result = selectDefinitionsHelper.process(fileInfo);
+    expect(result.definitionPlaneTexts).toStrictEqual([
+      {
+        type: 'ASSET',
+        content: ['      Name: test', '      Path: test.png'],
+        location: { line: 3, path: fileInfo.path }
+      },
+      {
+        type: 'ASSET',
+        content: ['      Name: test2', '      Path: test2.png'],
+        location: { line: 10, path: fileInfo.path }
+      }
+    ]);
+    expect(result.errorLogs).toStrictEqual([
+      {
+        description: 'Invalid definition header: "### Some text"',
+        location: { line: 7, path: fileInfo.path }
+      }
+    ]);
+  });
 });
-//# sourceMappingURL=1-select-definitions.spec.js.map
+//# sourceMappingURL=1-select-definitions.spec.js.map