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

package/src/templating/compile.ts

@@ -1,187 +0,0 @@
-import Handlebars from 'handlebars';
-import {
-  EnumSource,
-  ConvertRenderableContentsToString,
-  InterfaceSource,
-  ClassSource,
-  MethodSource,
-  RenderableContent,
-  DocumentableSource,
-} from './types';
-import { namespace, splitAndCapitalize } from './helpers';
-import { typeLevelApexDocPartialTemplate } from '../transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template';
-import { methodsPartialTemplate } from '../transpiler/markdown/plain-markdown/methods-partial-template';
-import { constructorsPartialTemplate } from '../transpiler/markdown/plain-markdown/constructors-partial-template';
-import { fieldsPartialTemplate } from '../transpiler/markdown/plain-markdown/fieldsPartialTemplate';
-import { documentablePartialTemplate } from '../transpiler/markdown/plain-markdown/documentable-partial-template';
-
-type CompileOptions = {
-  renderableContentConverter: ConvertRenderableContentsToString;
-  codeBlockConverter: (language: string, lines: string[]) => string;
-};
-
-export function compile(template: string, source: EnumSource | InterfaceSource | ClassSource, options: CompileOptions) {
-  Handlebars.registerPartial('typeLevelApexDocPartialTemplate', typeLevelApexDocPartialTemplate);
-  Handlebars.registerPartial('documentablePartialTemplate', documentablePartialTemplate);
-  Handlebars.registerPartial('methodsPartialTemplate', methodsPartialTemplate);
-  Handlebars.registerPartial('constructorsPartialTemplate', constructorsPartialTemplate);
-  Handlebars.registerPartial('fieldsPartialTemplate', fieldsPartialTemplate);
-
-  Handlebars.registerHelper('splitAndCapitalize', splitAndCapitalize);
-
-  const prepared = { ...prepare(source, options), namespace: namespace() };
-  const compiled = Handlebars.compile(template);
-  return (
-    compiled(prepared)
-      .trim()
-      // clean up extra newlines
-      .replace(/\n{3,}/g, '\n\n')
-  );
-}
-
-function prepare(
-  source: EnumSource | InterfaceSource | ClassSource,
-  { renderableContentConverter, codeBlockConverter }: CompileOptions,
-) {
-  const base = {
-    ...source,
-    ...prepareDocumentable(source, renderableContentConverter, codeBlockConverter),
-    ...prepareBaseType(source, renderableContentConverter),
-  };
-  if (isEnumSource(source)) {
-    return {
-      ...base,
-      ...prepareEnum(source, renderableContentConverter),
-    };
-  } else if (isInterfaceSource(source)) {
-    return {
-      ...base,
-      ...prepareInterface(source, renderableContentConverter, codeBlockConverter),
-    };
-  } else {
-    return {
-      ...base,
-      ...prepareClass(source, renderableContentConverter, codeBlockConverter),
-    };
-  }
-}
-
-function prepareDocumentable(
-  source: DocumentableSource,
-  renderableContentConverter: ConvertRenderableContentsToString,
-  codeBlockConverter: (language: string, lines: string[]) => string,
-) {
-  return {
-    description: renderableContentConverter(source.description),
-    mermaid: source.mermaid ? codeBlockConverter('mermaid', source.mermaid) : undefined,
-    example: source.example ? codeBlockConverter('apex', source.example) : undefined,
-    customTags: source.customTags?.map((tag) => ({
-      name: tag.name,
-      value: renderableContentConverter(tag.description),
-    })),
-  };
-}
-
-function prepareBaseType(
-  source: EnumSource | InterfaceSource | ClassSource,
-  renderableContentConverter: ConvertRenderableContentsToString,
-) {
-  return {
-    sees: source.sees?.map((see) => renderableContentConverter([see])),
-  };
-}
-
-function prepareEnum(source: EnumSource, renderableContentConverter: ConvertRenderableContentsToString) {
-  return {
-    values: source.values.map((value) => ({
-      value: value.value,
-      description: renderableContentConverter(value.description),
-    })),
-  };
-}
-
-function prepareInterface(
-  source: InterfaceSource,
-  renderableContentConverter: ConvertRenderableContentsToString,
-  codeBlockConverter: (language: string, lines: string[]) => string,
-) {
-  return {
-    extends: source.extends?.map((ext) => renderableContentConverter([ext])),
-    methods: source.methods?.map((method) => mapMethod(method, renderableContentConverter, codeBlockConverter)),
-  };
-}
-
-function prepareClass(
-  source: ClassSource,
-  renderableContentConverter: ConvertRenderableContentsToString,
-  codeBlockConverter: (language: string, lines: string[]) => string,
-) {
-  return {
-    implements: source.implements?.map((impl) => renderableContentConverter([impl])),
-    extends: source.extends ? renderableContentConverter([source.extends]) : undefined,
-    constructors: source.constructors?.map((constructor) =>
-      mapConstructor(constructor, renderableContentConverter, codeBlockConverter),
-    ),
-    methods: source.methods?.map((method) => mapMethod(method, renderableContentConverter, codeBlockConverter)),
-    fields: source.fields?.map((field) => ({
-      ...field,
-      ...prepareDocumentable(field, renderableContentConverter, codeBlockConverter),
-      type: renderableContentConverter([field.type]),
-    })),
-  };
-}
-
-function mapMethod(
-  method: MethodSource,
-  renderableContentConverter: (content?: RenderableContent[]) => string,
-  codeBlockConverter: (language: string, lines: string[]) => string,
-) {
-  return {
-    ...method,
-    ...prepareDocumentable(method, renderableContentConverter, codeBlockConverter),
-    returnType: {
-      ...method,
-      type: method.returnType?.type ? renderableContentConverter([method.returnType.type]) : undefined,
-      description: renderableContentConverter(method.returnType?.description),
-    },
-    throws: method.throws?.map((thrown) => ({
-      ...thrown,
-      type: renderableContentConverter([thrown.type]),
-      description: renderableContentConverter(thrown.description),
-    })),
-    parameters: method.parameters?.map((param) => ({
-      ...param,
-      type: renderableContentConverter([param.type]),
-      description: renderableContentConverter(param.description),
-    })),
-  };
-}
-
-function mapConstructor(
-  constructor: MethodSource,
-  renderableContentConverter: (content?: RenderableContent[]) => string,
-  codeBlockConverter: (language: string, lines: string[]) => string,
-) {
-  return {
-    ...constructor,
-    ...prepareDocumentable(constructor, renderableContentConverter, codeBlockConverter),
-    parameters: constructor.parameters?.map((param) => ({
-      ...param,
-      type: renderableContentConverter([param.type]),
-      description: renderableContentConverter(param.description),
-    })),
-    throws: constructor.throws?.map((thrown) => ({
-      ...thrown,
-      type: renderableContentConverter([thrown.type]),
-      description: renderableContentConverter(thrown.description),
-    })),
-  };
-}
-
-function isEnumSource(source: { __type: string }): source is EnumSource {
-  return source.__type === 'enum';
-}
-
-function isInterfaceSource(source: { __type: string }): source is InterfaceSource {
-  return source.__type === 'interface';
-}

package/src/templating/helpers.ts

@@ -1,14 +0,0 @@
-import { Settings } from '../settings';
-
-export const splitAndCapitalize = (text: string) => {
-  const words = text.split(/[-_]+/);
-  const capitalizedWords = [];
-  for (const word of words) {
-    capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
-  }
-  return capitalizedWords.join(' ');
-};
-
-export const namespace = () => {
-  return Settings.getInstance().getNamespace();
-};

package/src/templating/types.d.ts

@@ -1,104 +0,0 @@
-export type Link = {
-  title: string;
-  url: string;
-};
-
-export type EmptyLine = {
-  type: 'empty-line';
-};
-
-export type StringOrLink = string | Link;
-
-export type RenderableContent = StringOrLink | EmptyLine;
-
-export type ConvertRenderableContentsToString = (content?: RenderableContent[]) => string;
-
-type EnumValue = {
-  value: string;
-  description?: RenderableContent[];
-};
-
-type CustomTag = {
-  name: string;
-  description?: RenderableContent[];
-};
-
-/**
- * Represents an annotation to a top-level type. For example @NamespaceAccessible.
- */
-type Annotation = string;
-
-type CodeBlock = string[];
-
-type DocumentableSource = {
-  annotations?: Annotation[];
-  description?: RenderableContent[];
-  customTags?: CustomTag[];
-  mermaid?: CodeBlock;
-  example?: CodeBlock;
-};
-
-type BaseTypeSource = DocumentableSource & {
-  name: string;
-  accessModifier: string;
-  group?: string;
-  author?: string;
-  date?: string;
-  sees?: StringOrLink[];
-};
-
-type MethodParameterSource = {
-  name: string;
-  type: StringOrLink;
-  description?: RenderableContent[];
-};
-
-type TypeSource = {
-  type: StringOrLink;
-  description?: RenderableContent[];
-};
-
-type ConstructorSource = DocumentableSource & {
-  title: string;
-  signature: string;
-  parameters?: MethodParameterSource[];
-  throws?: TypeSource[];
-};
-
-type MethodSource = DocumentableSource & {
-  title: string;
-  signature: string;
-  parameters?: MethodParameterSource[];
-  returnType?: TypeSource;
-  throws?: TypeSource[];
-  inherited?: boolean;
-};
-
-type FieldSource = DocumentableSource & {
-  name: string;
-  type: StringOrLink;
-  accessModifier: string;
-  inherited?: boolean;
-};
-
-export type ClassSource = BaseTypeSource & {
-  __type: 'class';
-  extends?: StringOrLink;
-  implements?: StringOrLink[];
-  constructors?: ConstructorSource[];
-  methods?: MethodSource[];
-  classModifier?: string;
-  sharingModifier?: string;
-  fields?: FieldSource[];
-};
-
-export type InterfaceSource = BaseTypeSource & {
-  __type: 'interface';
-  extends?: StringOrLink[];
-  methods?: MethodSource[];
-};
-
-export type EnumSource = BaseTypeSource & {
-  __type: 'enum';
-  values: EnumValue[];
-};

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

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