@cparra/apexdocs 2.25.0-alpha.1 → 2.25.0-alpha.3

package/src/adapters/documentables.ts

@@ -1,93 +0,0 @@
-import { CustomTag, RenderableDocumentation, RenderableContent } from '../core/renderable/types';
-import { Describable, Documentable } from './types';
-import { GetRenderableContentByTypeName, replaceInlineReferences } from './references';
-import { isEmptyLine } from './type-utils';
-
-export function adaptDescribable(
-  describable: Describable,
-  linkGenerator: GetRenderableContentByTypeName,
-): {
-  description?: RenderableContent[];
-} {
-  function describableToRenderableContent(describable: Describable): RenderableContent[] | undefined {
-    if (!describable) {
-      return;
-    }
-
-    return (
-      describable
-        .map<RenderableContent[]>((line) => [
-          ...replaceInlineReferences(line, linkGenerator),
-          {
-            type: 'empty-line',
-          },
-        ])
-        .flatMap((line) => line)
-        // If the last element is an empty line, remove it
-        .filter((line, index, lines) => !(isEmptyLine(line) && index === lines.length - 1))
-    );
-  }
-
-  return {
-    description: describableToRenderableContent(describable),
-  };
-}
-
-export function adaptDocumentable(
-  documentable: Documentable,
-  linkGenerator: GetRenderableContentByTypeName,
-  subHeadingLevel: number,
-): RenderableDocumentation {
-  function extractCustomTags(type: Documentable): CustomTag[] {
-    const baseTags = ['description', 'group', 'author', 'date', 'see', 'example', 'mermaid', 'throws', 'exception'];
-
-    return (
-      type.docComment?.annotations
-        .filter((currentAnnotation) => !baseTags.includes(currentAnnotation.name.toLowerCase()))
-        .map<CustomTag>((currentAnnotation) => ({
-          ...adaptDescribable(currentAnnotation.bodyLines, linkGenerator),
-          name: currentAnnotation.name,
-        })) ?? []
-    );
-  }
-
-  function extractAnnotationBodyLines(type: Documentable, annotationName: string): string[] | undefined {
-    return type.docComment?.annotations.find(
-      (currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName,
-    )?.bodyLines;
-  }
-
-  function extractAnnotationBody(type: Documentable, annotationName: string): string | undefined {
-    return type.docComment?.annotations.find(
-      (currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName,
-    )?.body;
-  }
-
-  function extractSeeAnnotations(type: Documentable): string[] {
-    return (
-      type.docComment?.annotations
-        .filter((currentAnnotation) => currentAnnotation.name.toLowerCase() === 'see')
-        .map((currentAnnotation) => currentAnnotation.body) ?? []
-    );
-  }
-
-  return {
-    ...adaptDescribable(documentable.docComment?.descriptionLines, linkGenerator),
-    annotations: documentable.annotations.map((annotation) => annotation.type.toUpperCase()),
-    customTags: extractCustomTags(documentable),
-    mermaid: {
-      headingLevel: subHeadingLevel,
-      heading: 'Diagram',
-      value: extractAnnotationBodyLines(documentable, 'mermaid'),
-    },
-    example: {
-      headingLevel: subHeadingLevel,
-      heading: 'Example',
-      value: documentable.docComment?.exampleAnnotation?.bodyLines,
-    },
-    group: extractAnnotationBody(documentable, 'group'),
-    author: extractAnnotationBody(documentable, 'author'),
-    date: extractAnnotationBody(documentable, 'date'),
-    sees: extractSeeAnnotations(documentable).map(linkGenerator),
-  };
-}

package/src/adapters/type-utils.ts

@@ -1,5 +0,0 @@
-import { EmptyLine, RenderableContent } from '../core/renderable/types';
-
-export function isEmptyLine(content: RenderableContent): content is EmptyLine {
-  return Object.keys(content).includes('type') && (content as { type: string }).type === 'empty-line';
-}

package/src/adapters/types.d.ts

@@ -1,8 +0,0 @@
-import { Annotation, DocComment } from '@cparra/apex-reflection';
-
-export type Describable = string[] | undefined;
-
-export type Documentable = {
-  annotations: Annotation[];
-  docComment?: DocComment;
-};

package/src/model/inheritance.ts

@@ -1,7 +0,0 @@
-import { FieldMirror, MethodMirror, PropertyMirror } from '@cparra/apex-reflection';
-
-export type InheritanceSupport = { inherited: boolean };
-export type FieldMirrorWithInheritance = FieldMirror & InheritanceSupport;
-export type PropertyMirrorWithInheritance = PropertyMirror & InheritanceSupport;
-export type MethodMirrorWithInheritance = MethodMirror & InheritanceSupport;
-export type FieldOrProperty = FieldMirrorWithInheritance | PropertyMirrorWithInheritance;

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

@@ -1,42 +0,0 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
-import { LinkingStrategy } from '../../processor-type-transpiler';
-import { Type } from '@cparra/apex-reflection';
-import { OutputFile } from '../../../model/outputFile';
-import { Settings } from '../../../settings';
-import ClassFileGeneratorHelper from '../class-file-generatorHelper';
-import { MarkdownHomeFile } from '../../../model/markdown-home-file';
-import { documentType } from '../../../core/generate-docs';
-import { linkFromTypeNameGenerator } from '../../../adapters/references';
-
-export class PlainMarkdownDocsProcessor extends MarkdownTranspilerBase {
-  onBeforeProcess = (types: Type[]) => {
-    this._fileContainer.pushFile(new MarkdownHomeFile(this.homeFileName(), types));
-  };
-
-  homeFileName(): string {
-    return 'index';
-  }
-
-  getLinkingStrategy(): LinkingStrategy {
-    return 'path-relative';
-  }
-
-  onProcess(type: Type): void {
-    this._fileContainer.pushFile(new GenericFile(type));
-  }
-}
-
-class GenericFile extends OutputFile {
-  constructor(private type: Type) {
-    super(
-      `${Settings.getInstance().getNamespacePrefix()}${type.name}`,
-      ClassFileGeneratorHelper.getSanitizedGroup(type),
-    );
-
-    this.addText(documentType(type, linkFromTypeNameGenerator, Settings.getInstance().getNamespace()));
-  }
-
-  fileExtension(): string {
-    return '.md';
-  }
-}