@cparra/apexdocs 2.25.0-alpha.0 → 2.25.0-alpha.2

package/src/transpiler/markdown/plain-markdown/interface-template.ts

@@ -1,16 +1,16 @@
 export const interfaceMarkdownTemplate = `
-# {{name}} Interface
+{{ heading headingLevel heading }}
 
-{{> typeLevelApexDocPartialTemplate}}
+{{> typeDocumentation }}
 
 {{#if extends}}
 **Extends**
 {{#each extends}}
-{{this}}{{#unless @last}}, {{/unless}}
+{{link this}}{{#unless @last}}, {{/unless}}
 {{/each}}
 {{/if}}
 
 {{#if methods}}
-{{> methodsPartialTemplate}}
+{{> methodsPartialTemplate methods}}
 {{/if}}
 `.trim();

package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts

@@ -1,39 +1,37 @@
 export const methodsPartialTemplate = `
-## Methods
-{{#each methods}}
-### \`{{title}}\`
+{{ heading headingLevel heading }}
+{{#each value}}
+{{{ heading headingLevel (inlineCode heading) }}}
 
 {{#if inherited}}
 *Inherited*
 {{/if}}
 
-{{#> documentablePartialTemplate isInner=true}}
+{{#> documentablePartialTemplate}}
 
-### Signature
-\`\`\`apex
-{{signature}}
-\`\`\` 
+{{ heading signature.headingLevel signature.heading }}
+{{ code "apex" signature.value }}
 
-{{#if parameters}}
-### Parameters
+{{#if parameters.value}}
+{{ heading parameters.headingLevel parameters.heading }}
 | Name | Type | Description |
 |------|------|-------------|
-{{#each parameters}}
-| {{name}} | {{type}} | {{description}} |
+{{#each parameters.value}}
+| {{name}} | {{link type}} | {{withLinks description}} |
 {{/each}}
 {{/if}}
 
-{{#if returnType}}
-### Returns
-**{{returnType.type}}**
+{{ heading returnType.headingLevel returnType.heading }}
+**{{link returnType.value.type}}**
 
-{{returnType.description}}
+{{#if returnType.value.description}}
+{{returnType.value.description}}
 {{/if}}
 
-{{#if throws}}
-### Throws
-{{#each throws}}
-{{this.type}}: {{this.description}}
+{{#if throws.value}}
+{{ heading throws.headingLevel throws.heading }}
+{{#each throws.value}}
+{{link this.type}}: {{this.description}}
 
 {{/each}}
 {{/if}}

package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts

@@ -1,34 +1,16 @@
 import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
 import { LinkingStrategy } from '../../processor-type-transpiler';
-import { ClassMirror, EnumMirror, InterfaceMirror, Type } from '@cparra/apex-reflection';
+import { Type } from '@cparra/apex-reflection';
 import { OutputFile } from '../../../model/outputFile';
 import { Settings } from '../../../settings';
 import ClassFileGeneratorHelper from '../class-file-generatorHelper';
-import { enumMarkdownTemplate } from './enum-template';
-import { compile } from '../../../templating/compile';
-import { ClassSource, EnumSource, InterfaceSource, Link, RenderableContent } from '../../../templating/types';
-import { interfaceMarkdownTemplate } from './interface-template';
-import { classMarkdownTemplate } from './class-template';
-import { isEmptyLine } from '../../../adapters/type-utils';
-import {
-  classTypeToClassSource,
-  enumTypeToEnumSource,
-  interfaceTypeToInterfaceSource,
-} from '../../../adapters/apex-types';
 import { MarkdownHomeFile } from '../../../model/markdown-home-file';
-import { MarkdownFile } from '../../../model/markdown-file';
-import Handlebars from 'handlebars';
-import fs from 'fs';
-import path from 'path';
+import { documentType } from '../../../core/generate-docs';
+import { linkFromTypeNameGenerator } from '../../../adapters/references';
 
 export class PlainMarkdownDocsProcessor extends MarkdownTranspilerBase {
-  _fileContents: string[] = [];
   onBeforeProcess = (types: Type[]) => {
-    if (Settings.getInstance().shouldOutputSingleFile()) {
-      return;
-    } else {
-      this._fileContainer.pushFile(new MarkdownHomeFile(this.homeFileName(), types));
-    }
+    this._fileContainer.pushFile(new MarkdownHomeFile(this.homeFileName(), types));
   };
 
   homeFileName(): string {
@@ -40,95 +22,21 @@ export class PlainMarkdownDocsProcessor extends MarkdownTranspilerBase {
   }
 
   onProcess(type: Type): void {
-    if (Settings.getInstance().shouldOutputSingleFile()) {
-      this._fileContents.push(this._generateOutputFile(type).body);
-    } else {
-      this._fileContainer.pushFile(this._generateOutputFile(type));
-    }
-  }
-
-  onAfterProcess: (types: Type[]) => void = () => {
-    if (Settings.getInstance().shouldOutputSingleFile()) {
-      const file = new MarkdownFile(Settings.getInstance().getSingleFileName(), '');
-
-      let contents;
-      if (Settings.getInstance().getTemplateFilePath()) {
-        const filePath = path.resolve(Settings.getInstance().getTemplateFilePath()!);
-        const templateFileContents = fs.readFileSync(filePath, {
-          encoding: 'utf-8',
-        });
-        const handlebars = Handlebars.compile(templateFileContents);
-        contents = handlebars({ api_docs: this._fileContents.join('\n\n---\n\n') });
-      } else {
-        contents = this._fileContents.join('\n\n---\n\n');
-      }
-      file.addText(contents);
-      this._fileContainer.pushFile(file);
-    }
-  };
-
-  _generateOutputFile(type: Type): OutputFile {
-    if (type.type_name === 'enum') {
-      return new GenericFile<EnumMirror>(type as EnumMirror, enumTypeToEnumSource, enumMarkdownTemplate);
-    } else if (type.type_name === 'interface') {
-      return new GenericFile<InterfaceMirror>(
-        type as InterfaceMirror,
-        interfaceTypeToInterfaceSource,
-        interfaceMarkdownTemplate,
-      );
-    } else {
-      return new GenericFile<ClassMirror>(type as ClassMirror, classTypeToClassSource, classMarkdownTemplate);
-    }
+    this._fileContainer.pushFile(new GenericFile(type));
   }
 }
 
-class GenericFile<T extends Type> extends OutputFile {
-  constructor(private type: T, toSource: (type: T) => EnumSource | InterfaceSource | ClassSource, template: string) {
+class GenericFile extends OutputFile {
+  constructor(private type: Type) {
     super(
       `${Settings.getInstance().getNamespacePrefix()}${type.name}`,
       ClassFileGeneratorHelper.getSanitizedGroup(type),
     );
 
-    const source = toSource(type);
-    this.addText(
-      compile(template, source, {
-        renderableContentConverter: prepareDescription,
-        codeBlockConverter: convertCodeBlock,
-      }),
-    );
+    this.addText(documentType(type, linkFromTypeNameGenerator, Settings.getInstance().getNamespace()));
   }
 
   fileExtension(): string {
     return '.md';
   }
 }
-
-function prepareDescription(description?: RenderableContent[]) {
-  if (!description) {
-    return '';
-  }
-
-  function reduceDescription(acc: string, curr: RenderableContent) {
-    if (typeof curr === 'string') {
-      return acc + curr.trim() + ' ';
-    } else if (isEmptyLine(curr)) {
-      return acc + '\n\n';
-    } else {
-      return acc + linkToMarkdown(curr) + ' ';
-    }
-  }
-
-  function linkToMarkdown(link: Link) {
-    return `[${link.title}](${link.url})`;
-  }
-
-  return description.reduce(reduceDescription, '').trim();
-}
-
-function convertCodeBlock(language: string, lines: string[]): string {
-  return `
-\`\`\`${language}
-${lines.join('\n')}
-\`\`\`
-  `.trim();
-}

package/src/transpiler/markdown/plain-markdown/type-doc-partial.ts

@@ -0,0 +1,27 @@
+export const typeDocPartial = `
+{{#> documentablePartialTemplate}}
+
+{{#if doc.group}}
+**Group** {{doc.group}}
+{{/if}}
+
+{{#if doc.author}}
+**Author** {{doc.author}}
+{{/if}}
+
+{{#if doc.date}}
+**Date** {{doc.date}}
+{{/if}}
+
+{{#each doc.sees}}
+**See** {{link this}}
+
+{{/each}}
+
+{{#if namespace}}
+## Namespace
+{{namespace}}
+{{/if}}
+
+{{/documentablePartialTemplate}}
+`.trim();

package/src/transpiler/openapi/parsers/ReferenceBuilder.ts

@@ -227,7 +227,7 @@ export class ReferenceBuilder {
         return { schema: { type: 'object' }, referenceComponents: [] };
       case 'object':
         return { schema: { type: 'object' }, referenceComponents: [] };
-      default:
+      default: {
         // If we got here we are dealing with a non-primitive (most likely a custom class or an SObject).
         const referencedType = TypesRepository.getInstance().getFromAllByName(typeName);
         if (!referencedType) {
@@ -243,6 +243,7 @@ export class ReferenceBuilder {
           schema: reference.entrypointReferenceObject,
           referenceComponents: [...reference.referenceComponents],
         };
+      }
     }
   }
 
@@ -266,7 +267,7 @@ type SchemaObjectReferencePair = {
 
 class ReferenceOverrides {
   static build(referenceAsString: string): ReferenceOverride[] {
-    const cleanedUpReference = referenceAsString.replace(/[\[\]]/g, '');
+    const cleanedUpReference = referenceAsString.replace(/[[\]]/g, '');
     const referenceStrings = cleanedUpReference.split(',').map((item) => item.replace(/\s/g, ''));
     return referenceStrings.map((item) => {
       const [propertyName, referenceName] = item.split(':');

package/src/util/logger.ts

@@ -5,7 +5,7 @@ import logUpdate from 'log-update';
  * Logs messages to the console.
  */
 export class Logger {
-  static currentFrame = -1;
+  static currentFrame = 0;
 
   static frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
 

package/tsconfig.json

@@ -12,7 +12,7 @@
     ]
   },
   "include": [
-    "src"
+    "src", "jest.d.ts"
   ],
   "exclude": [
     "node_modules",

package/.eslintrc.js

@@ -1,12 +0,0 @@
-module.exports = {
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    ecmaVersion: 2020,
-    sourceType: 'module',
-  },
-  extends: [
-    'plugin:@typescript-eslint/recommended',
-    'plugin:prettier/recommended',
-  ],
-  rules: {},
-};

package/examples/plain-markdown/README.md

@@ -1,301 +0,0 @@
-# Template file
-
-# BaseClass Class
-`abstract`
-
-## Namespace
-ns
-
-## Fields
-### `sampleEnumFromBase`
-
-#### Type
-[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
-
-
----
-
-# ParentInterface Interface
-
-## Namespace
-ns
-
-## Methods
-### `sampleParentMethod()`
-
-### Signature
-```apex
-public void sampleParentMethod()
-``` 
-
-### Returns
-**void**
-
-
----
-
-# ReferencedEnum Enum
-
-## Namespace
-ns
-
-## Enum Values
-
-
----
-
-# SampleClass Class
-`virtual`
-
-aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex 
-
-deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
-
-**Group** SampleGroup
-
-## Namespace
-ns
-
-## Example
-```apex
-SampleClass sample = new SampleClass();
-sample.doSomething();
-```
-
-**Extends**
-[ns.BaseClass](../Miscellaneous/ns.BaseClass.md)
-
-**Implements**
-[ns.SampleInterface](../Miscellaneous/ns.SampleInterface.md), 
-[ns.ParentInterface](../Miscellaneous/ns.ParentInterface.md)
-
-## Fields
-### `name`
-
-This is a sample field.
-
-#### Type
-String
-
----
-
-### `sampleEnumFromBase`
-
-*Inherited*
-
-#### Type
-[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
-
-## Constructors
-### `SampleClass()`
-
-This is a sample constructor.
-
-### Signature
-```apex
-public SampleClass()
-``` 
-
----
-### `SampleClass(name)`
-
-### Signature
-```apex
-public SampleClass(String name)
-``` 
-
-### Parameters
-| Name | Type | Description |
-|------|------|-------------|
-| name | String |  |
-
-## Methods
-### `sayHello()`
-
-`DEPRECATED`
-
-This is a sample method.
-
-### Signature
-```apex
-public virtual String sayHello()
-``` 
-
-### Returns
-**String**
-
-A string value.
-
-### Example
-```apex
-SampleClass sample = new SampleClass();
-sample.doSomething();
-```
-
-
----
-
-# SampleEnum Enum
-
-`NAMESPACEACCESSIBLE`
-
-This is a sample enum. This references [ns.ReferencedEnum](../Miscellaneous/ns.ReferencedEnum.md) . 
-
-This description has several lines
-
-**Some Custom** 
-
-**Group** Sample Enums
-
-**Author** John Doe
-
-**Date** 2022-01-01
-
-**See** [ns.ReferencedEnum](../Miscellaneous/ns.ReferencedEnum.md)
-
-## Namespace
-ns
-
-```mermaid
-graph TD
- A[SampleEnum] -->|references| B[ReferencedEnum]
- B -->|referenced by| A
-```
-
-## Enum Values
-### VALUE1
-This is value 1
-### VALUE2
-This is value 2
-### VALUE3
-This is value 3
-
-
----
-
-# SampleException Class
-
-## Namespace
-ns
-
-**Extends**
-Exception
-
-
----
-
-# SampleInterface Interface
-
-`NAMESPACEACCESSIBLE`
-
-This is a sample interface
-
-**Author** John Doe
-
-**Date** 2020-01-01
-
-**See** [ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
-
-**See** [ns.ReferencedEnum](./ns.ReferencedEnum.md)
-
-## Namespace
-ns
-
-```mermaid
-graph TD
-   A[SampleInterface] -->|extends| B[ParentInterface]
-   B -->|extends| C[GrandParentInterface]
-   C -->|extends| D[GreatGrandParentInterface]
-```
-
-## Example
-```apex
-SampleInterface sampleInterface = new SampleInterface();
-sampleInterface.sampleMethod();
-```
-
-**Extends**
-[ns.ParentInterface](./ns.ParentInterface.md)
-
-## Methods
-### `sampleMethod()`
-
-`NAMESPACEACCESSIBLE`
-
-This is a sample method
-
-**Custom Tag** 
-
-**Another Custom Tag** 
-
-### Signature
-```apex
-public String sampleMethod()
-``` 
-
-### Returns
-**String**
-
-Some return value
-
-### Throws
-[ns.SampleException](./ns.SampleException.md): This is a sample exception
-
-AnotherSampleException: This is another sample exception
-
-```mermaid
-graph TD
-  A[SampleInterface] -->|extends| B[ParentInterface]
-  B -->|extends| C[GrandParentInterface]
-  C -->|extends| D[GreatGrandParentInterface]
-```
-
-### Example
-```apex
-SampleInterface sampleInterface = new SampleInterface();
-sampleInterface.sampleMethod();
-```
-
----
-
-### `sampleMethodWithParams(param1, param2, theEnum)`
-
-`NAMESPACEACCESSIBLE`
-`DEPRECATED`
-
-This is a sample method with parameters 
-
-Sometimes it won't be possible to find a NonExistent link.
-
-### Signature
-```apex
-public SampleEnum sampleMethodWithParams(String param1, Integer param2, SampleEnum theEnum)
-``` 
-
-### Parameters
-| Name | Type | Description |
-|------|------|-------------|
-| param1 | String | This is the first parameter |
-| param2 | Integer | This is the second parameter |
-| theEnum | [ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md) | This is an enum parameter |
-
-### Returns
-**[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)**
-
-Some return value
-
----
-
-### `sampleParentMethod()`
-
-*Inherited*
-
-### Signature
-```apex
-public void sampleParentMethod()
-``` 
-
-### Returns
-**void**
-
-

package/lib/templating/compile.d.ts

@@ -1,7 +0,0 @@
-import { EnumSource, ConvertRenderableContentsToString, InterfaceSource, ClassSource } from './types';
-type CompileOptions = {
-    renderableContentConverter: ConvertRenderableContentsToString;
-    codeBlockConverter: (language: string, lines: string[]) => string;
-};
-export declare function compile(template: string, source: EnumSource | InterfaceSource | ClassSource, options: CompileOptions): string;
-export {};