@cparra/apexdocs 2.25.0-alpha.9 → 2.25.0

package/src/core/shared/types.d.ts

@@ -1,130 +0,0 @@
-import { Type } from '@cparra/apex-reflection';
-
-export type Generator = 'markdown' | 'openapi';
-
-/**
- * The configurable hooks that can be used to modify the output of the generator.
- */
-export type ConfigurableHooks = {
-  transformReferenceGuide: TransformReferenceGuide;
-  transformDocs: TransformDocs;
-  transformDocPage: TransformDocPage;
-  transformReference: TransformReference;
-};
-
-export type UserDefinedMarkdownConfig = {
-  targetGenerator: 'markdown';
-  sourceDir: string;
-  targetDir: string;
-  scope: string[];
-  defaultGroupName: string;
-  namespace?: string;
-  sortMembersAlphabetically: boolean;
-  includeMetadata: boolean;
-} & Partial<ConfigurableHooks>;
-
-export type UserDefinedOpenApiConfig = {
-  targetGenerator: 'openapi';
-  sourceDir: string;
-  targetDir: string;
-  includeMetadata: boolean;
-};
-
-export type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig;
-
-export type UnparsedSourceFile = {
-  filePath: string;
-  content: string;
-  metadataContent: string | null;
-};
-
-export type SourceFileMetadata = {
-  filePath: string;
-  name: string;
-  type: 'interface' | 'class' | 'enum';
-};
-
-export type ParsedFile = {
-  source: SourceFileMetadata;
-  type: Type;
-};
-
-export type DocPageReference = {
-  source: SourceFileMetadata;
-  // The name under which the type should be displayed in the documentation.
-  // By default, this will match the source.name, but it can be configured by the user.
-  displayName: string;
-  // The location of the file relative to the root of the documentation.
-  pathFromRoot: string;
-};
-
-type Frontmatter = string | Record<string, unknown> | null;
-
-export type ReferenceGuidePageData = {
-  frontmatter: Frontmatter;
-  content: string;
-  filePath: string;
-};
-
-export type DocPageData = {
-  source: SourceFileMetadata;
-  group: string | null;
-  filePath: string;
-  frontmatter: Frontmatter;
-  content: string;
-};
-
-export type OpenApiPageData = Omit<DocPageData, 'source'>;
-
-export type PageData = DocPageData | OpenApiPageData | ReferenceGuidePageData;
-
-export type DocumentationBundle = {
-  referenceGuide: ReferenceGuidePageData;
-  docs: DocPageData[];
-};
-
-/**
- * Represents a file to be skipped.
- */
-export type Skip = {
-  readonly _tag: 'Skip';
-};
-
-export type PostHookDocumentationBundle = {
-  referenceGuide: ReferenceGuidePageData | Skip;
-  docs: DocPageData[];
-};
-
-// Configurable Hooks
-
-type ConfigurableDocPageReference = Omit<DocPageReference, 'source'>;
-
-type ConfigurableDocPageData = Omit<DocPageData, 'source' | 'filePath'>;
-
-/**
- * Allows changing where the files are written to.
- */
-export type TransformReference = (
-  reference: DocPageReference,
-) => Partial<ConfigurableDocPageReference> | Promise<ConfigurableDocPageReference>;
-
-/**
- * Allows changing the frontmatter and content of the reference guide, or even if creating a reference
- * guide will be skipped altogether.
- */
-export type TransformReferenceGuide = (
-  referenceGuide: ReferenceGuidePageData,
-) => Partial<ReferenceGuidePageData> | Skip | Promise<Partial<ReferenceGuidePageData> | Skip>;
-
-/**
- * The main purpose if for allowing for doc pages to be skipped, but it can also be used to change the frontmatter
- * and content of the doc pages.
- */
-export type TransformDocs = (docs: DocPageData[]) => DocPageData[] | Promise<DocPageData[]>;
-
-/**
- * Allows changing the frontmatter and content of the doc pages.
- */
-export type TransformDocPage = (
-  doc: DocPageData,
-) => Partial<ConfigurableDocPageData> | Promise<Partial<ConfigurableDocPageData>>;

package/src/core/shared/utils.ts

@@ -1,5 +0,0 @@
-import { Skip } from './types';
-
-export function isSkip(value: unknown): value is Skip {
-  return Object.prototype.hasOwnProperty.call(value, '_tag') && (value as Skip)._tag === 'Skip';
-}

package/src/defaults.ts

@@ -1,8 +0,0 @@
-export const defaults = {
-  targetGenerator: 'markdown' as const,
-  targetDir: './docs/',
-  scope: ['global'],
-  defaultGroupName: 'Miscellaneous',
-  includeMetadata: false,
-  sortMembersAlphabetically: false,
-};

package/src/test-helpers/InterfaceMirrorBuilder.ts

@@ -1,39 +0,0 @@
-import { Annotation, DocComment, InterfaceMirror, MethodMirror } from '@cparra/apex-reflection';
-
-/**
- * Builder class to create Interface objects.
- * For testing purposes only.
- */
-export class InterfaceMirrorBuilder {
-  private name = 'SampleClass';
-  private annotations: Annotation[] = [];
-  private docComment?: DocComment;
-  private methods: MethodMirror[] = [];
-
-  withName(name: string): InterfaceMirrorBuilder {
-    this.name = name;
-    return this;
-  }
-
-  addAnnotation(annotation: Annotation): InterfaceMirrorBuilder {
-    this.annotations.push(annotation);
-    return this;
-  }
-
-  addMethod(method: MethodMirror): InterfaceMirrorBuilder {
-    this.methods.push(method);
-    return this;
-  }
-
-  build(): InterfaceMirror {
-    return {
-      annotations: this.annotations,
-      name: this.name,
-      type_name: 'interface',
-      methods: this.methods,
-      access_modifier: 'public',
-      docComment: this.docComment,
-      extended_interfaces: [],
-    };
-  }
-}

package/src/util/fp.ts

@@ -1,3 +0,0 @@
-export function apply<T extends unknown[], U extends unknown[], R>(fn: (...args: [...T, ...U]) => R, ...front: T) {
-  return (...tailArgs: U) => fn(...front, ...tailArgs);
-}