@cparra/apexdocs 1.13.4 → 2.0.0-alpha.14

package/ROADMAP.md

@@ -0,0 +1,18 @@
+[] Automatic Resolution of links (@see and {@link FileName})
+
+[] Respect access modifiers where the properties/methods are different from the class declaration. For example,
+AuraEnabled properties do not live in an AuraEnabled class, so there's no way to just generate docs to showcase the
+AuraEnabled properties of a class without some sort of combination of also exposing other public/globals
+
+[] Versioning capabilities. When creating the doc you specify a version number, and a new directory is created for the
+files, instead of just overriding
+
+[] New generatortype: To JsDocs from AuraEnabled
+
+[] More unit tests
+
+[] config.js support to allow for injections, home header, etc.
+
+[] Add configuration setting that allows someone to set the "namespace"
+
+[] Homepage support similar to what docsify does

package/docs/Gemfile.lock

@@ -4,7 +4,7 @@ GEM
     activesupport (3.2.22.5)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     coffee-script (2.4.1)
       coffee-script-source

package/docs/Sample-Classes/SampleClass.md

@@ -1,30 +1,138 @@
-# SampleClass class
-
-`NamespaceAccessible`
-
-This is a class description.
-
----
-## Constructors
-### `SampleClass()`
-
-Constructs a SampleClass without any arguments.
-#### Example
-```
-<pre>
-SampleClass sampleInstance = new SampleClass();
-```
-
----
-## Methods
-### `testMethod(String argument)` → `String`
-
-Executes commands based on the passed in argument.
-#### Example
-```
-<pre>
-String result = SampleClass.testMethod();
-System.debug(result);
-```
-
----
+---
+layout: default
+---
+# SampleClass
+
+`NAMESPACEACCESSIBLE`
+
+This is a class description.
+
+
+**Group** Sample Classes
+
+
+**CustomAnnotation** A Custom annotation
+
+
+**Author** Cesar Parra
+
+## Constructors
+### `SampleClass()`
+
+`NAMESPACEACCESSIBLE`
+
+Constructs a SampleClass without any arguments.
+
+#### Throws
+|Exception|Description|
+|---|---|
+|`ExcName`|some exception|
+#### Example
+```apex
+<pre>
+// <strong>Example</strong>
+SampleClass sampleInstance = new SampleClass();
+</pre>
+```
+
+### `SampleClass(String argument)`
+
+Constructs a SampleClass with an argument.
+
+#### Parameters
+|Param|Description|
+|---|---|
+|`argument`|Argument definition|
+---
+## Properties
+
+### `AnotherProp` → `Decimal`
+
+`AURAENABLED`
+
+This is a Decimal property.
+
+### `MyProp` → `String`
+
+`AURAENABLED`
+
+This is a String property.
+
+---
+## Methods
+### `static sampleMethod(String argument)`
+
+`NAMESPACEACCESSIBLE`
+
+Executes commands based on the passed in argument.
+
+#### Parameters
+|Param|Description|
+|---|---|
+|`argument`|Argument to debug|
+#### Return
+
+**Type**
+
+String
+
+**Description**
+
+Empty string
+
+#### Example
+```apex
+<pre>
+String result = SampleClass.testMethod();
+System.debug(result);
+```
+
+### `static call()`
+
+Calls the method. This methods allows you to call it.
+
+---
+## Enums
+### InnerEnum
+
+`NAMESPACEACCESSIBLE`
+
+---
+## Classes
+### AnotherInnerClass
+
+Inner class belonging to SampleClass.
+
+#### Properties
+
+##### `InnerProp` → `String`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()`
+
+Executes from the inner class.
+
+---
+
+### InnerClass
+
+Inner class belonging to SampleClass.
+
+#### Properties
+
+##### `InnerProp` → `String`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()`
+
+Executes from the inner class.
+
+---
+
+---

package/docs/Sample-Interfaces/SampleInterface.md

@@ -1,13 +1,30 @@
-# SampleInterface interface
+---
+layout: default
+---
+# SampleInterface
 
 This is an interface description.
 
----
+
+**Group** Sample Interfaces
+
 ## Methods
-### `execute()` → `void`
+### `execute()`
 
 Executes the command.
-### `getValue()` → `String`
+
+### `getValue()`
 
 Returns a value based on the executed command.
+
+#### Return
+
+**Type**
+
+String
+
+**Description**
+
+The value
+
 ---

package/docs/index.md

@@ -4,17 +4,9 @@ layout: default
 # Classes
 ## Sample Classes
 
-### [SampleClass](/Sample-Classes/SampleClass.md)
+## [SampleClass](/Sample-Classes/SampleClass.md)
 
 
 This is a class description.
 
 
-## Sample Interfaces
-
-### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-
-This is an interface description.
-
-

package/examples/apex/SampleClass.cls

@@ -1,14 +1,27 @@
 /**
  * @description This is a class description.
  * @group Sample Classes
+ * @CustomAnnotation A Custom annotation
+ * @author Cesar Parra
  */
 @NamespaceAccessible
 public with sharing class SampleClass {
+    @NamespaceAccessible
+    public enum InnerEnum {
+        A,
+        B,
+        C
+    }
+
     /**
      * @description Constructs a SampleClass without any arguments.
+     * @throws ExcName some exception
+     * @CustomAnnotation A Custom annotation
      * @example
      * <pre>
+     * // <strong>Example</strong>
      * SampleClass sampleInstance = new SampleClass();
+     * </pre>
      */
     @NamespaceAccessible
     public SampleClass() {
@@ -17,6 +30,7 @@ public with sharing class SampleClass {
 
     /**
      * @description Constructs a SampleClass with an argument.
+     * @param argument Argument definition
      */
     public SampleClass(String argument) {
         System.debug('Constructor');
@@ -28,9 +42,11 @@ public with sharing class SampleClass {
      * <pre>
      * String result = SampleClass.testMethod();
      * System.debug(result);
+     * @param argument Argument to debug
+     * @return Empty string
      */
     @NamespaceAccessible
-    public static String testMethod(String argument) {
+    public static String sampleMethod(String argument) {
         System.debug('Execute');
         return '';
     }
@@ -40,16 +56,19 @@ public with sharing class SampleClass {
      * @description Calls the method.
      * This methods allows you to call it.
      */
-    public static void call() { }
+    public static void call() {
+    }
 
     /**
      * @description This is a String property.
      */
+    @AuraEnabled
     public String MyProp { get; set; }
 
     /**
      * @description This is a Decimal property.
      */
+    @AuraEnabled
     public Decimal AnotherProp { get; private set; }
 
     /**
@@ -59,7 +78,10 @@ public with sharing class SampleClass {
         /**
          * @description Description of the inner property.
          */
-        public InnerProp { get; set; }
+        public String InnerProp {
+            get;
+            set;
+        }
 
         /**
          * @description Executes from the inner class.
@@ -71,12 +93,15 @@ public with sharing class SampleClass {
 
     /**
      * @description Inner class belonging to SampleClass.
-    */
+     */
     public class AnotherInnerClass {
         /**
          * @description Description of the inner property.
          */
-        public InnerProp { get; set; }
+        public String InnerProp {
+            get;
+            set;
+        }
 
         /**
          * @description Executes from the inner class.
@@ -85,4 +110,4 @@ public with sharing class SampleClass {
             System.debug('Executing inner method.');
         }
     }
-}
+}

package/examples/apex/SampleInterface.cls

@@ -2,7 +2,7 @@
  * @description This is an interface description.
  * @group Sample Interfaces
  */
-public interface SampleInterface {
+global interface SampleInterface {
     /**
      * @description Executes the command.
      */
@@ -10,6 +10,7 @@ public interface SampleInterface {
 
     /**
      * @description Returns a value based on the executed command.
+     * @return The value
      */
     String getValue();
-}
+}

package/lib/application/Apexdocs.d.ts

@@ -0,0 +1,11 @@
+import { ReflectionResult } from '@cparra/apex-reflection/index';
+/**
+ * Application entry-point to generate documentation out of Apex source files.
+ */
+export declare class Apexdocs {
+    /**
+     * Generates documentation out of Apex source files.
+     */
+    static generate(): void;
+    static _reflectionWithLogger: (declarationBody: string) => ReflectionResult;
+}

package/lib/application/Apexdocs.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+const logger_1 = require("../util/logger");
+const manifest_factory_1 = require("../service/manifest-factory");
+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");
+/**
+ * Application entry-point to generate documentation out of Apex source files.
+ */
+class Apexdocs {
+    /**
+     * Generates documentation out of Apex source files.
+     */
+    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 processor = settings_1.Settings.getInstance().typeTranspiler;
+        transpiler_1.default.generate(filteredManifest, processor);
+        const generatedFiles = processor.fileBuilder().files();
+        file_writer_1.FileWriter.write(generatedFiles, (fileName) => {
+            logger_1.Logger.log(`${fileName} processed.`);
+        });
+    }
+}
+exports.Apexdocs = Apexdocs;
+Apexdocs._reflectionWithLogger = (declarationBody) => {
+    var _a;
+    const result = apex_reflection_1.reflect(declarationBody);
+    if (result.error) {
+        logger_1.Logger.log(`Parsing error ${(_a = result.error) === null || _a === void 0 ? void 0 : _a.message}`);
+    }
+    return result;
+};
+//# sourceMappingURL=Apexdocs.js.map

package/lib/application/Apexdocs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;AAAA,kEAA6D;AAC7D,wDAA2D;AAE3D,6DAAkD;AAClD,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"}

package/lib/cli/generate.js

@@ -2,8 +2,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const yargs = require("yargs");
-const Generate_1 = require("../command/Generate");
-const FileManager_1 = require("../FileManager");
+const settings_1 = require("../settings");
+const Apexdocs_1 = require("../application/Apexdocs");
 const argv = yargs.options({
     sourceDir: {
         type: 'string',
@@ -14,7 +14,7 @@ const argv = yargs.options({
     targetDir: {
         type: 'string',
         alias: 't',
-        default: 'docs',
+        default: './docs/',
         describe: 'The directory location where documentation will be generated to.',
     },
     recursive: {
@@ -26,28 +26,24 @@ const argv = yargs.options({
     scope: {
         type: 'array',
         alias: 'p',
-        default: ['global', 'public', 'namespaceaccessible'],
-        describe: 'A list of scopes to document. Values should be separated by a space, e.g --scope public private.',
+        default: ['global'],
+        describe: 'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
+            'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled',
     },
     targetGenerator: {
         type: 'string',
         alias: 'g',
         default: 'jekyll',
-        choices: ['jekyll', 'docsify', 'jsdoc'],
-        describe: 'Define the static file generator for which the documents will be created. Currently supports jekyll and docsify.',
-    },
-    configPath: {
-        type: 'string',
-        alias: 'c',
-        describe: 'The path to the JSON configuration file that defines the structure of the documents to generate.',
-    },
-    group: {
-        type: 'boolean',
-        alias: 'o',
-        default: true,
-        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.',
+        choices: ['jekyll', 'docsify'],
+        describe: 'Define the static file generator for which the documents will be created. Currently supports jekyll, and docsify.',
     },
 }).argv;
-const generatedClassModels = Generate_1.generate(argv.sourceDir, argv.recursive, argv.scope, argv.targetDir, argv.targetGenerator, argv.configPath, argv.group);
-new FileManager_1.default(generatedClassModels).generate();
+settings_1.Settings.build({
+    sourceDirectory: argv.sourceDir,
+    recursive: argv.recursive,
+    scope: argv.scope,
+    outputDir: argv.targetDir,
+    targetGenerator: argv.targetGenerator,
+});
+Apexdocs_1.Apexdocs.generate();
+//# sourceMappingURL=generate.js.map

package/lib/cli/generate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,0CAAyD;AACzD,sDAAmD;AAEnD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;IACzB,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,+DAA+D;KAC1E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,kEAAkE;KAC7E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,kFAAkF;KAC7F;IACD,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,CAAC,QAAQ,CAAC;QACnB,QAAQ,EACN,sHAAsH;YACtH,0HAA0H;KAC7H;IACD,eAAe,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,QAAQ;QACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;QAC9B,QAAQ,EACN,mHAAmH;KACtH;CACF,CAAC,CAAC,IAAI,CAAC;AAER,mBAAQ,CAAC,KAAK,CAAC;IACb,eAAe,EAAE,IAAI,CAAC,SAAS;IAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,KAAK,EAAE,IAAI,CAAC,KAAK;IACjB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;CAC1D,CAAC,CAAC;AAEH,mBAAQ,CAAC,QAAQ,EAAE,CAAC"}

package/lib/index.d.ts

@@ -1 +1 @@
-export * from './command/Generate';
+export * from './service/manifest-factory';

package/lib/index.js

@@ -3,4 +3,5 @@ function __export(m) {
     for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
 }
 Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./command/Generate"));
+__export(require("./service/manifest-factory"));
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

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

package/lib/model/file.d.ts

@@ -0,0 +1,10 @@
+export declare abstract class File {
+    fileName: string;
+    dir: string;
+    _contents: string;
+    constructor(fileName: string, dir: string);
+    abstract fileExtension(): string;
+    get body(): string;
+    addText(text: string, encodeHtml?: boolean): void;
+    addBlankLine(): void;
+}

package/lib/model/file.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const html_entities_1 = require("html-entities");
+class File {
+    constructor(fileName, dir) {
+        this.fileName = fileName;
+        this.dir = dir;
+        this._contents = '';
+    }
+    get body() {
+        return this._contents;
+    }
+    addText(text, encodeHtml = true) {
+        const textToAdd = encodeHtml ? html_entities_1.encode(text) : text;
+        this._contents += textToAdd;
+        this.addBlankLine();
+    }
+    addBlankLine() {
+        this._contents += '\n';
+    }
+}
+exports.File = File;
+//# sourceMappingURL=file.js.map

package/lib/model/file.js.map

@@ -0,0 +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"}

package/lib/model/manifest.d.ts

@@ -0,0 +1,22 @@
+import { Type } from '@cparra/apex-reflection';
+import { Annotation } from '@cparra/apex-reflection/index';
+declare type AccessAware = {
+    access_modifier: string;
+} & {
+    annotations: Annotation[];
+};
+/**
+ * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
+ */
+export default class Manifest {
+    types: Type[];
+    isForInnerTypes: boolean;
+    /**
+     * Constructs a new Manifest object.
+     * @param types List of types to be wrapped by this object.
+     */
+    constructor(types: Type[], isForInnerTypes?: boolean);
+    filteredByAccessModifierAndAnnotations(modifiers: string[]): Type[];
+    filterAccessibleModifier(accessAware: AccessAware[], modifiers: string[]): AccessAware[];
+}
+export {};

package/lib/model/manifest.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
+ */
+class Manifest {
+    /**
+     * Constructs a new Manifest object.
+     * @param types List of types to be wrapped by this object.
+     */
+    constructor(types, isForInnerTypes = false) {
+        this.types = types;
+        this.isForInnerTypes = isForInnerTypes;
+    }
+    filteredByAccessModifierAndAnnotations(modifiers) {
+        const filteredTypes = this.filterAccessibleModifier(this.types, modifiers);
+        const typesToReturn = [];
+        for (const filteredType of filteredTypes) {
+            const currentType = filteredType;
+            if (currentType.type_name !== 'class') {
+                typesToReturn.push(currentType);
+                continue;
+            }
+            const currentClass = currentType;
+            let filteredClass = Object.assign(Object.assign({}, currentType), { methods: this.filterAccessibleModifier(currentClass.methods, modifiers), properties: this.filterAccessibleModifier(currentClass.properties, modifiers), fields: this.filterAccessibleModifier(currentClass.fields, modifiers), constructors: this.filterAccessibleModifier(currentClass.constructors, modifiers) });
+            if (!this.isForInnerTypes) {
+                filteredClass = Object.assign(Object.assign({}, filteredClass), { enums: this.filterAccessibleModifier(currentClass.enums, modifiers), interfaces: this.filterAccessibleModifier(currentClass.interfaces, modifiers), classes: new Manifest(currentClass.classes, true).filteredByAccessModifierAndAnnotations(modifiers) });
+            }
+            typesToReturn.push(filteredClass);
+        }
+        return typesToReturn;
+    }
+    filterAccessibleModifier(accessAware, modifiers) {
+        return accessAware.filter((currentType) => {
+            return (modifiers.includes(currentType.access_modifier) ||
+                currentType.annotations.some((annotation) => modifiers.includes(annotation.type.toLowerCase())));
+        });
+    }
+}
+exports.default = Manifest;
+//# sourceMappingURL=manifest.js.map

package/lib/model/manifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../src/model/manifest.ts"],"names":[],"mappings":";;AAKA;;GAEG;AACH,MAAqB,QAAQ;IAC3B;;;OAGG;IACH,YAAmB,KAAa,EAAS,kBAA2B,KAAK;QAAtD,UAAK,GAAL,KAAK,CAAQ;QAAS,oBAAe,GAAf,eAAe,CAAiB;IAAG,CAAC;IAE7E,sCAAsC,CAAC,SAAmB;QACxD,MAAM,aAAa,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC3E,MAAM,aAAa,GAAW,EAAE,CAAC;QACjC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;YACxC,MAAM,WAAW,GAAG,YAAoB,CAAC;YACzC,IAAI,WAAW,CAAC,SAAS,KAAK,OAAO,EAAE;gBACrC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAChC,SAAS;aACV;YAED,MAAM,YAAY,GAAG,WAA0B,CAAC;YAChD,IAAI,aAAa,mCACZ,WAAW,KACd,OAAO,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EACvE,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC,EAC7E,MAAM,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,EACrE,YAAY,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,GAClF,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;gBACzB,aAAa,mCACR,aAAa,KAChB,KAAK,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,KAAK,EAAE,SAAS,CAAiB,EACnF,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAsB,EAClG,OAAO,EAAE,IAAI,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,sCAAsC,CACtF,SAAS,CACO,GACnB,CAAC;aACH;YAED,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACnC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,wBAAwB,CAAC,WAA0B,EAAE,SAAmB;QACtE,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE;YACxC,OAAO,CACL,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,eAAe,CAAC;gBAC/C,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAsB,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAC5G,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAnDD,2BAmDC"}

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

@@ -0,0 +1,10 @@
+import { File } from './file';
+export declare class MarkdownFile extends File {
+    fileExtension(): string;
+    addTitle(text: string, level?: number): void;
+    startCodeBlock(): void;
+    endCodeBlock(): void;
+    addHorizontalRule(): void;
+    initializeTable(...headers: string[]): void;
+    addTableRow(...columns: string[]): void;
+}