@cparra/apexdocs 1.15.0 → 1.16.0

package/docs/index.md

@@ -1,48 +1,48 @@
----
-layout: default
----
-# Classes
-## Sample Classes
-
-### [SampleClass](/Sample-Classes/SampleClass.md)
-
-
-This is a class description.
-
-
-
-### [SampleClass](/Sample-Classes/SampleClass.md)
-
-
-This is a class description.
-
-
-
-### [SampleClass2](/Sample-Classes/SampleClass2.md)
-
-
-This is a class description.
-
-
-
-### [SampleClassMultipleAuthorsAndDates](/Sample-Classes/SampleClassMultipleAuthorsAndDates.md)
-
-
-This is a class description.
-
-
-## Sample Interfaces
-
-### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-
-This is an interface description.
-
-
-
-### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-
-This is an interface description.
-
-
+---
+layout: default
+---
+# Classes
+## Sample Classes
+
+### [SampleClass](/Sample-Classes/SampleClass.md)
+
+
+This is a class description.
+
+
+
+### [SampleClass](/Sample-Classes/SampleClass.md)
+
+
+This is a class description.
+
+
+
+### [SampleClass2](/Sample-Classes/SampleClass2.md)
+
+
+This is a class description.
+
+
+
+### [SampleClassMultipleAuthorsAndDates](/Sample-Classes/SampleClassMultipleAuthorsAndDates.md)
+
+
+This is a class description.
+
+
+## Sample Interfaces
+
+### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+
+This is an interface description.
+
+
+
+### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+
+This is an interface description.
+
+

package/examples/apex/SampleClassMultipleAuthorsAndDates.cls

@@ -1,100 +1,100 @@
-/**
- * @description This is a class description.
- * @author John Doe
- * @date 1/1/2021
- * @author Jane Doe
- * @date 2/2/2022
- * @group Sample Classes
- * @see SampleInterface
- * @see SampleClass2
- */
-@NamespaceAccessible
-public with sharing class SampleClassMultipleAuthorsAndDates {
-    /**
-     * @description Constructs a SampleClassMultipleAuthorsAndDates without any arguments.
-     * @example
-     * <pre>
-     * SampleClassMultipleAuthorsAndDates sampleInstance = new SampleClassMultipleAuthorsAndDates();
-     */
-    @NamespaceAccessible
-    public SampleClassMultipleAuthorsAndDates() {
-        System.debug('Constructor');
-    }
-
-    /**
-     * @description Constructs a SampleClassMultipleAuthorsAndDates with an argument.
-     * @param argument Some argument
-     */
-    public SampleClassMultipleAuthorsAndDates(String argument) {
-        System.debug('Constructor');
-    }
-
-    /**
-     * @description Executes commands based on the passed in argument.
-     * @example
-     * <pre>
-     * String result = SampleClassMultipleAuthorsAndDates.testMethod();
-     * System.debug(result);
-     */
-    @NamespaceAccessible
-    public static String testMethod(String argument) {
-        System.debug('Execute');
-        return '';
-    }
-
-
-    /**
-     * @description Calls the method.
-     * This methods allows you to call it.
-     */
-    public static void call() {
-    }
-
-    /**
-     * @description This is a String property.
-     */
-    public String MyProp { get; set; }
-
-    /**
-     * @description This is a Decimal property.
-     */
-    public Decimal AnotherProp { get; private set; }
-
-    /**
-     * @description Inner class belonging to SampleClassMultipleAuthorsAndDates.
-     */
-    public class InnerClass {
-        /**
-         * @description Description of the inner property.
-         */
-        public InnerProp {
-            get; set;
-        }
-
-        /**
-         * @description Executes from the inner class.
-         */
-        public void innerMethod() {
-            System.debug('Executing inner method.');
-        }
-    }
-
-    /**
-     * @description Inner class belonging to SampleClassMultipleAuthorsAndDates.
-     */
-    public class AnotherInnerClass {
-        /**
-         * @description Description of the inner property.
-         */
-        public InnerProp {
-            get; set;
-        }
-
-        /**
-         * @description Executes from the inner class.
-         */
-        public void innerMethod() {
-            System.debug('Executing inner method.');
-        }
-    }
-}
+/**
+ * @description This is a class description.
+ * @author John Doe
+ * @date 1/1/2021
+ * @author Jane Doe
+ * @date 2/2/2022
+ * @group Sample Classes
+ * @see SampleInterface
+ * @see SampleClass2
+ */
+@NamespaceAccessible
+public with sharing class SampleClassMultipleAuthorsAndDates {
+    /**
+     * @description Constructs a SampleClassMultipleAuthorsAndDates without any arguments.
+     * @example
+     * <pre>
+     * SampleClassMultipleAuthorsAndDates sampleInstance = new SampleClassMultipleAuthorsAndDates();
+     */
+    @NamespaceAccessible
+    public SampleClassMultipleAuthorsAndDates() {
+        System.debug('Constructor');
+    }
+
+    /**
+     * @description Constructs a SampleClassMultipleAuthorsAndDates with an argument.
+     * @param argument Some argument
+     */
+    public SampleClassMultipleAuthorsAndDates(String argument) {
+        System.debug('Constructor');
+    }
+
+    /**
+     * @description Executes commands based on the passed in argument.
+     * @example
+     * <pre>
+     * String result = SampleClassMultipleAuthorsAndDates.testMethod();
+     * System.debug(result);
+     */
+    @NamespaceAccessible
+    public static String testMethod(String argument) {
+        System.debug('Execute');
+        return '';
+    }
+
+
+    /**
+     * @description Calls the method.
+     * This methods allows you to call it.
+     */
+    public static void call() {
+    }
+
+    /**
+     * @description This is a String property.
+     */
+    public String MyProp { get; set; }
+
+    /**
+     * @description This is a Decimal property.
+     */
+    public Decimal AnotherProp { get; private set; }
+
+    /**
+     * @description Inner class belonging to SampleClassMultipleAuthorsAndDates.
+     */
+    public class InnerClass {
+        /**
+         * @description Description of the inner property.
+         */
+        public InnerProp {
+            get; set;
+        }
+
+        /**
+         * @description Executes from the inner class.
+         */
+        public void innerMethod() {
+            System.debug('Executing inner method.');
+        }
+    }
+
+    /**
+     * @description Inner class belonging to SampleClassMultipleAuthorsAndDates.
+     */
+    public class AnotherInnerClass {
+        /**
+         * @description Description of the inner property.
+         */
+        public InnerProp {
+            get; set;
+        }
+
+        /**
+         * @description Executes from the inner class.
+         */
+        public void innerMethod() {
+            System.debug('Executing inner method.');
+        }
+    }
+}

package/lib/Command/Generate.d.ts

@@ -1,2 +1,2 @@
 import ClassModel from '../Model/ClassModel';
-export declare function generate(sourceDirectories: (string | number)[], recursive?: boolean, scope?: string[], outputDir?: string, targetGenerator?: string, configPath?: string, group?: boolean): ClassModel[];
+export declare function generate(sourceDirectories: (string | number)[], recursive?: boolean, scope?: string[], outputDir?: string, targetGenerator?: string, configPath?: string, group?: boolean, indexOnly?: boolean): ClassModel[];

package/lib/Command/Generate.js

@@ -7,9 +7,11 @@ const FileParser_1 = require("../Parser/FileParser");
 const DocsifyDocsProcessor_1 = require("../DocsifyDocsProcessor");
 const JekyllDocsProcessor_1 = require("../JekyllDocsProcessor");
 const AsJsDocsProcessor_1 = require("../AsJsDocsProcessor");
-function generate(sourceDirectories, recursive = true, scope = ['global', 'public', 'namespaceaccessible'], outputDir = 'docs', targetGenerator = 'jekyll', configPath, group) {
+const MetadataProcessor_1 = require("../MetadataProcessor");
+function generate(sourceDirectories, recursive = true, scope = ['global', 'public', 'namespaceaccessible'], outputDir = 'docs', targetGenerator = 'jekyll', configPath, group, indexOnly = false) {
     Settings_1.default.getInstance().setScope(scope);
     Settings_1.default.getInstance().setOutputDir(outputDir);
+    Settings_1.default.getInstance().setIndexOnly(indexOnly);
     if (targetGenerator === 'jekyll') {
         Settings_1.default.getInstance().setDocsProcessor(new JekyllDocsProcessor_1.default());
     }
@@ -47,6 +49,16 @@ function getClassesFromDirectory(sourceDirectories, recursive) {
             }
             const rawFile = fs.readFileSync(currentPath);
             const response = new FileParser_1.default().parseFileContents(rawFile.toString());
+            const rawFileMetadata = fs.existsSync(currentPath + '-meta.xml') ? fs.readFileSync(currentPath + '-meta.xml') : null;
+            if (!response) {
+                return;
+            }
+            if (rawFileMetadata != null && response != null) {
+                let metadataGenericParams = MetadataProcessor_1.default.process(rawFileMetadata.toString());
+                metadataGenericParams.forEach((value, key) => {
+                    response.setGeneric(key, value);
+                });
+            }
             if (!response) {
                 return;
             }

package/lib/MarkdownDocsProcessor.js

@@ -65,6 +65,9 @@ class MarkdownDocsProcessor extends DocsProcessor_1.default {
         var _a, _b;
         const generator = new MarkdownHelper_1.default(this.classes);
         this.onBeforeClassFileCreated(generator);
+        if (Settings_1.default.getInstance().getIndexOnly() === true) {
+            return;
+        }
         const startingHeadingLevel = ((_b = (_a = Configuration_1.default.getConfig()) === null || _a === void 0 ? void 0 : _a.content) === null || _b === void 0 ? void 0 : _b.startingHeadingLevel) || 1;
         this.generateDocsForClass(generator, classModel, startingHeadingLevel);
         if (!fs.existsSync(outputDir)) {

package/lib/MetadataProcessor.d.ts

@@ -0,0 +1,3 @@
+export default class MetadataProcessor {
+    static process(input: string): Map<string, string>;
+}

package/lib/MetadataProcessor.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fast_xml_parser_1 = require("fast-xml-parser");
+class MetadataProcessor {
+    static process(input) {
+        let map = new Map();
+        let xml = new fast_xml_parser_1.XMLParser().parse(input);
+        let apiVersion = xml.ApexClass.apiVersion;
+        map.set('apiVersion', apiVersion !== null ? apiVersion : '');
+        let status = xml.ApexClass.status;
+        map.set('status', status !== null ? status : '');
+        return map;
+    }
+}
+exports.default = MetadataProcessor;

package/lib/Parser/ClassParser.js

@@ -13,27 +13,30 @@ class ClassParser {
         cModel.setNameLine(name, iLine);
         if (name.toLowerCase().includes(' interface '))
             cModel.setIsInterface(true);
+        let multiline = false;
         let inDescription = false;
+        let inHistory = false;
         let i = 0;
+        let reAnyAnnotation = new RegExp('@([A-Za-z]*)\s*(.*)');
         for (let comment of lstComments) {
             i++;
             comment = comment.trim();
             let idxStart = comment.toLowerCase().indexOf('@author');
             if (idxStart !== -1) {
                 cModel.addAuthor(comment.substring(idxStart + 7).trim());
-                inDescription = false;
+                multiline = false;
                 continue;
             }
             idxStart = comment.toLowerCase().indexOf('@date');
             if (idxStart !== -1) {
                 cModel.addDate(comment.substring(idxStart + 5).trim());
-                inDescription = false;
+                multiline = false;
                 continue;
             }
             idxStart = comment.toLowerCase().indexOf('@see');
             if (idxStart !== -1) {
                 cModel.addSee(comment.substring(idxStart + 4).trim());
-                inDescription = false;
+                multiline = false;
                 continue;
             }
             idxStart = comment.toLowerCase().indexOf('@group '); // needed to include space to not match group-content.
@@ -42,38 +45,46 @@ class ClassParser {
                 if (group) {
                     cModel.setClassGroup(group);
                 }
-                inDescription = false;
+                multiline = false;
                 continue;
             }
             idxStart = comment.toLowerCase().indexOf('@group-content');
             if (idxStart !== -1) {
                 cModel.setClassGroupContent(comment.substring(idxStart + 14).trim());
-                inDescription = false;
+                multiline = false;
                 continue;
             }
             idxStart = comment.toLowerCase().indexOf('@description');
-            if (idxStart !== -1 || i === 1) {
-                if (idxStart !== -1 && comment.length > idxStart + 13)
-                    cModel.setDescription(comment.substring(idxStart + 12).trim());
-                else {
-                    const found = comment.match('\\s');
-                    if (found && found.index) {
-                        cModel.setDescription(comment.substring(found.index).trim());
-                    }
-                }
+            if (idxStart !== -1 || (i === 1 && !reAnyAnnotation.test(comment))) {
+                cModel.setDescription(comment.substring(idxStart + 12).trim());
+                multiline = true;
                 inDescription = true;
+                inHistory = false;
+                continue;
+            }
+            let anyStart = reAnyAnnotation.exec(comment);
+            idxStart = (typeof (anyStart === null || anyStart === void 0 ? void 0 : anyStart.index) !== 'undefined') ? anyStart.index : -1;
+            if (idxStart !== -1 && anyStart !== null) {
+                let genericName = anyStart[1];
+                let genericValue = anyStart[2];
+                cModel.setGeneric(genericName, genericValue);
+                multiline = false;
+                inDescription = false;
+                inHistory = false;
                 continue;
             }
             // handle multiple lines for description.
-            if (inDescription) {
+            if (multiline === true) {
                 let j;
                 for (j = 0; j < comment.length; j++) {
                     const ch = comment.charAt(j);
                     if (ch !== '*' && ch !== ' ')
                         break;
                 }
-                if (j < comment.length) {
-                    cModel.setDescription(cModel.getDescription() + ' ' + comment.substring(j));
+                if (j < comment.length && !reAnyAnnotation.test(comment)) {
+                    if (inDescription) {
+                        cModel.setDescription(cModel.getDescription() + ' ' + comment.substring(j));
+                    }
                 }
                 continue;
             }

package/lib/application/Apexdocs.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Apexdocs = void 0;
 const apex_file_reader_1 = require("../service/apex-file-reader");
 const file_system_1 = require("../service/file-system");
 const apex_reflection_1 = require("@cparra/apex-reflection");
@@ -9,6 +10,7 @@ const parser_1 = require("../service/parser");
 const settings_1 = require("../settings");
 const transpiler_1 = require("../transpiler/transpiler");
 const file_writer_1 = require("../service/file-writer");
+const types_repository_1 = require("../model/types-repository");
 /**
  * Application entry-point to generate documentation out of Apex source files.
  */
@@ -19,10 +21,11 @@ class Apexdocs {
     static generate() {
         const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
         const manifest = manifest_factory_1.createManifest(new parser_1.RawBodyParser(fileBodies), this._reflectionWithLogger);
-        const filteredManifest = manifest.filteredByAccessModifierAndAnnotations(settings_1.Settings.getInstance().scope);
-        logger_1.Logger.log(`Parsed ${filteredManifest.length} files`);
+        const filteredTypes = manifest.filteredByAccessModifierAndAnnotations(settings_1.Settings.getInstance().scope);
+        types_repository_1.TypesRepository.getInstance().populate(filteredTypes);
+        logger_1.Logger.log(`Parsed ${filteredTypes.length} files`);
         const processor = settings_1.Settings.getInstance().typeTranspiler;
-        transpiler_1.default.generate(filteredManifest, processor);
+        transpiler_1.default.generate(filteredTypes, processor);
         const generatedFiles = processor.fileBuilder().files();
         file_writer_1.FileWriter.write(generatedFiles, (fileName) => {
             logger_1.Logger.log(`${fileName} processed.`);

package/lib/application/Apexdocs.js.map

@@ -1 +1 @@
-{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAAoE;AACpE,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAuC;AACvC,yDAAkD;AAClD,wDAAoD;AAEpD;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,iCAAc,CAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAE3F,MAAM,gBAAgB,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;QAEvG,eAAM,CAAC,GAAG,CAAC,UAAU,gBAAgB,CAAC,MAAM,QAAQ,CAAC,CAAC;QACtD,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC;QACxD,oBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;QACjD,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QACvD,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,QAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,aAAa,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;;AAjBH,4BA0BC;AAPQ,8BAAqB,GAAG,CAAC,eAAuB,EAAoB,EAAE;;IAC3E,MAAM,MAAM,GAAG,yBAAO,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,GAAG,CAAC,iBAAiB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACtD;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
+{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAuC;AACvC,yDAAkD;AAClD,wDAAoD;AACpD,gEAA4D;AAE5D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,iCAAc,CAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAE3F,MAAM,aAAa,GAAW,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5G,kCAAe,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAEtD,eAAM,CAAC,GAAG,CAAC,UAAU,aAAa,CAAC,MAAM,QAAQ,CAAC,CAAC;QACnD,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC;QACxD,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QACvD,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,QAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,aAAa,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;;AAlBH,4BA2BC;AAPQ,8BAAqB,GAAG,CAAC,eAAuB,EAAoB,EAAE;;IAC3E,MAAM,MAAM,GAAG,yBAAO,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,GAAG,CAAC,iBAAiB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACtD;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/lib/cli/generate.js

@@ -48,6 +48,11 @@ const argv = yargs.options({
         describe: 'Define whether the generated files should be grouped by the @group tag on the top level classes.' +
             'If set to true, a sub directory will be created per group inside of the specified target directory.',
     },
+    indexOnly: {
+        type: 'boolean',
+        default: false,
+        describe: 'Defines whether only the index file should be generated.',
+    }
 }).argv;
-const generatedClassModels = Generate_1.generate(argv.sourceDir, argv.recursive, argv.scope, argv.targetDir, argv.targetGenerator, argv.configPath, argv.group);
+const generatedClassModels = Generate_1.generate(argv.sourceDir, argv.recursive, argv.scope, argv.targetDir, argv.targetGenerator, argv.configPath, argv.group, argv.indexOnly);
 new FileManager_1.default(generatedClassModels).generate();

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,gDAA2C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6DAA2C"}

package/lib/model/ApexModel.d.ts

@@ -8,6 +8,7 @@ export default class ApexModel {
     private example;
     private scope;
     private isNamespaceAccessible;
+    private generics;
     getNameLine(): string;
     getInameLine(): number | undefined;
     setNameLine(nameLine: string, iLine: number): void;
@@ -25,6 +26,8 @@ export default class ApexModel {
     setScope(scope: string): void;
     setIsNamespaceAccessible(isNamespaceAccessible: boolean): void;
     getIsNamespaceAccessible(): boolean;
+    setGeneric(name: string, value: string): void;
+    getGeneric(name: string): string;
     private parseScope;
     private getScopeFromSettings;
 }

package/lib/model/ApexModel.js

@@ -11,6 +11,7 @@ class ApexModel {
         this.example = '';
         this.scope = '';
         this.isNamespaceAccessible = false;
+        this.generics = new Map();
     }
     getNameLine() {
         return this.nameLine;
@@ -65,6 +66,13 @@ class ApexModel {
     getIsNamespaceAccessible() {
         return this.isNamespaceAccessible;
     }
+    setGeneric(name, value) {
+        this.generics.set(name, value);
+    }
+    getGeneric(name) {
+        let value = this.generics.get(name);
+        return value ? value : '';
+    }
     parseScope() {
         this.scope = '';
         const str = this.getScopeFromSettings(this.nameLine);

package/lib/model/file.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.File = void 0;
 const html_entities_1 = require("html-entities");
 class File {
     constructor(fileName, dir) {

package/lib/model/file.js.map

@@ -1 +1 @@
-{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/model/file.ts"],"names":[],"mappings":";;AAAA,iDAAuC;AAEvC,MAAsB,IAAI;IAGxB,YAAmB,QAAgB,EAAS,GAAW;QAApC,aAAQ,GAAR,QAAQ,CAAQ;QAAS,QAAG,GAAH,GAAG,CAAQ;QAFvD,cAAS,GAAG,EAAE,CAAC;IAE2C,CAAC;IAI3D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QACrC,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,sBAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACnD,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IACzB,CAAC;CACF;AApBD,oBAoBC"}
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/model/file.ts"],"names":[],"mappings":";;;AAAA,iDAAuC;AAEvC,MAAsB,IAAI;IAGxB,YAAmB,QAAgB,EAAS,GAAW;QAApC,aAAQ,GAAR,QAAQ,CAAQ;QAAS,QAAG,GAAH,GAAG,CAAQ;QAFvD,cAAS,GAAG,EAAE,CAAC;IAE2C,CAAC;IAI3D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QACrC,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,sBAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACnD,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IACzB,CAAC;CACF;AApBD,oBAoBC"}

package/lib/model/manifest-diff.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestDiff = void 0;
 class ManifestDiff {
     constructor() {
         this.added = [];

package/lib/model/manifest-diff.js.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-diff.js","sourceRoot":"","sources":["../../src/model/manifest-diff.ts"],"names":[],"mappings":";;AAIA,MAAa,YAAY;IAAzB;QACE,UAAK,GAAW,EAAE,CAAC;QACnB,YAAO,GAAW,EAAE,CAAC;QACrB,YAAO,GAAiB,EAAE,CAAC;IA6B7B,CAAC;IA3BC,MAAM,CAAC,KAAK,CAAC,gBAA0B,EAAE,WAAqB;QAC5D,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CACzC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,CAAC,CACxG,CAAC;QACF,MAAM,YAAY,GAAG,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAChD,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CACzF,CAAC;QAEF,MAAM,OAAO,GAAiB,EAAE,CAAC;QACjC,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE;YACvC,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;YACxF,IAAI,CAAC,OAAO,EAAE;gBACZ,SAAS;aACV;YAED,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAChD,IAAI,MAAM,CAAC,UAAU,EAAE,EAAE;gBACvB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACtB;SACF;QAED,MAAM,IAAI,GAAG,IAAI,YAAY,EAAE,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAhCD,oCAgCC;AAED,MAAM,UAAU;IAId,YAAmB,YAAkB,EAAS,OAAa;QAAxC,iBAAY,GAAZ,YAAY,CAAM;QAAS,YAAO,GAAP,OAAO,CAAM;QAF3D,sBAAiB,GAAuB,EAAE,CAAC;QAGzC,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAEM,UAAU;QACf,OAAO,CAAC,CAAC,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1E,CAAC;IAEO,KAAK;QACX,0BAA0B;QAC1B,IAAI,IAAI,CAAC,YAAY,CAAC,eAAe,KAAK,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;YACtE,IAAI,CAAC,oBAAoB,GAAG;gBAC1B,iBAAiB,EAAE,IAAI,CAAC,YAAY,CAAC,eAAe;gBACpD,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe;aAChD,CAAC;SACH;QAED,qBAAqB;QACrB,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CACtD,CAAC,iBAAiB,EAAE,EAAE,CACpB,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,CAAC,CAClH,CAAC;QACF,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM,CAC7D,CAAC,iBAAiB,EAAE,EAAE,CACpB,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,aAAa,CAAC,IAAI,CAAC,CACnG,CAAC;QACF,MAAM,sBAAsB,GAAG,CAAC,UAAsB,EAAE,UAA+B,EAAE,EAAE;YACzF,OAAO;gBACL,UAAU,EAAE,UAAU;gBACtB,IAAI,EAAE,UAAU;aACG,CAAC;QACxB,CAAC,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG;YACvB,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;gBACrC,OAAO,sBAAsB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YACrD,CAAC,CAAC;YACF,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;gBACvC,OAAO,sBAAsB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YACvD,CAAC,CAAC;SACH,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"manifest-diff.js","sourceRoot":"","sources":["../../src/model/manifest-diff.ts"],"names":[],"mappings":";;;AAIA,MAAa,YAAY;IAAzB;QACE,UAAK,GAAW,EAAE,CAAC;QACnB,YAAO,GAAW,EAAE,CAAC;QACrB,YAAO,GAAiB,EAAE,CAAC;IA6B7B,CAAC;IA3BC,MAAM,CAAC,KAAK,CAAC,gBAA0B,EAAE,WAAqB;QAC5D,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CACzC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,CAAC,CACxG,CAAC;QACF,MAAM,YAAY,GAAG,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAChD,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CACzF,CAAC;QAEF,MAAM,OAAO,GAAiB,EAAE,CAAC;QACjC,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE;YACvC,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;YACxF,IAAI,CAAC,OAAO,EAAE;gBACZ,SAAS;aACV;YAED,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAChD,IAAI,MAAM,CAAC,UAAU,EAAE,EAAE;gBACvB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACtB;SACF;QAED,MAAM,IAAI,GAAG,IAAI,YAAY,EAAE,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAhCD,oCAgCC;AAED,MAAM,UAAU;IAId,YAAmB,YAAkB,EAAS,OAAa;QAAxC,iBAAY,GAAZ,YAAY,CAAM;QAAS,YAAO,GAAP,OAAO,CAAM;QAF3D,sBAAiB,GAAuB,EAAE,CAAC;QAGzC,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAEM,UAAU;QACf,OAAO,CAAC,CAAC,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1E,CAAC;IAEO,KAAK;QACX,0BAA0B;QAC1B,IAAI,IAAI,CAAC,YAAY,CAAC,eAAe,KAAK,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;YACtE,IAAI,CAAC,oBAAoB,GAAG;gBAC1B,iBAAiB,EAAE,IAAI,CAAC,YAAY,CAAC,eAAe;gBACpD,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe;aAChD,CAAC;SACH;QAED,qBAAqB;QACrB,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CACtD,CAAC,iBAAiB,EAAE,EAAE,CACpB,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,CAAC,CAClH,CAAC;QACF,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM,CAC7D,CAAC,iBAAiB,EAAE,EAAE,CACpB,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,aAAa,CAAC,IAAI,CAAC,CACnG,CAAC;QACF,MAAM,sBAAsB,GAAG,CAAC,UAAsB,EAAE,UAA+B,EAAE,EAAE;YACzF,OAAO;gBACL,UAAU,EAAE,UAAU;gBACtB,IAAI,EAAE,UAAU;aACG,CAAC;QACxB,CAAC,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG;YACvB,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;gBACrC,OAAO,sBAAsB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YACrD,CAAC,CAAC;YACF,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;gBACvC,OAAO,sBAAsB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YACvD,CAAC,CAAC;SACH,CAAC;IACJ,CAAC;CACF"}

package/lib/model/markdown-file.d.ts

@@ -7,4 +7,6 @@ export declare class MarkdownFile extends File {
     addHorizontalRule(): void;
     initializeTable(...headers: string[]): void;
     addTableRow(...columns: string[]): void;
+    addListItem(text: string): void;
+    protected static replaceInlineLinks(text: string): string;
 }

package/lib/model/markdown-file.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownFile = void 0;
 const file_1 = require("./file");
+const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
 class MarkdownFile extends file_1.File {
     fileExtension() {
         return '.md';
@@ -46,6 +48,33 @@ class MarkdownFile extends file_1.File {
         columns.forEach((column) => {
             this._contents += column + '|';
         });
+        this.addBlankLine();
+    }
+    addListItem(text) {
+        this._contents += `* ${text}`;
+    }
+    static replaceInlineLinks(text) {
+        // Parsing text to extract possible linking classes.
+        const possibleLinks = text.match(/<<.*?>>/g);
+        possibleLinks === null || possibleLinks === void 0 ? void 0 : possibleLinks.forEach((currentMatch) => {
+            const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
+            text = text.replace(currentMatch, class_file_generatorHelper_1.default.getFileLinkByTypeName(classNameForMatch));
+        });
+        // Parsing links using {@link ClassName} format
+        const linkFormatRegEx = '{@link (.*?)}';
+        const expression = new RegExp(linkFormatRegEx, 'gi');
+        let match;
+        const matches = [];
+        do {
+            match = expression.exec(text);
+            if (match) {
+                matches.push(match);
+            }
+        } while (match);
+        for (const currentMatch of matches) {
+            text = text.replace(currentMatch[0], class_file_generatorHelper_1.default.getFileLinkByTypeName(currentMatch[1]));
+        }
+        return text;
     }
 }
 exports.MarkdownFile = MarkdownFile;