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

package/src/service/file-writer.ts

@@ -1,34 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import { OutputFile } from '../model/outputFile';
-import { OnBeforeFileWrite, Settings, TargetFile } from '../settings';
-
-export class FileWriter {
-  static write(files: OutputFile[], onWriteCallback: (file: TargetFile) => void) {
-    const onBeforeFileWrite: OnBeforeFileWrite = (file: TargetFile) => Settings.getInstance().onBeforeFileWrite(file);
-    files.forEach((file) => {
-      const resolvedFile = this.getTargetLocation(file, onBeforeFileWrite);
-      const fullDir = path.join(resolvedFile.dir.baseDir, resolvedFile.dir.fileDir);
-      if (!fs.existsSync(fullDir)) {
-        fs.mkdirSync(fullDir, { recursive: true });
-      }
-
-      const filePath = path.join(fullDir, `${resolvedFile.name}${resolvedFile.extension}`);
-      fs.writeFileSync(filePath, file.body, 'utf8');
-      onWriteCallback(resolvedFile);
-    });
-  }
-
-  private static getTargetLocation(file: OutputFile, onBeforeFileWrite: OnBeforeFileWrite): TargetFile {
-    const targetFile: TargetFile = {
-      name: file.fileName,
-      extension: file.fileExtension(),
-      dir: {
-        baseDir: Settings.getInstance().outputDir,
-        fileDir: file.dir,
-      },
-    };
-
-    return onBeforeFileWrite(targetFile);
-  }
-}

package/src/service/metadata-processor.ts

@@ -1,16 +0,0 @@
-import { XMLParser } from 'fast-xml-parser';
-
-export default class MetadataProcessor {
-  public static process(input: string) {
-    const map = new Map<string, string>();
-    const xml = new XMLParser().parse(input);
-
-    map.set('apiVersion', xml.ApexClass.apiVersion ?? '');
-
-    if (xml.ApexClass.status) {
-      map.set('status', xml.ApexClass.status);
-    }
-
-    return map;
-  }
-}

package/src/service/state.ts

@@ -1,24 +0,0 @@
-import { Type } from '@cparra/apex-reflection';
-
-export default class State {
-  private static instance: State;
-  private typeBeingProcessed?: Type;
-
-  // eslint-disable-next-line @typescript-eslint/no-empty-function
-  private constructor() {}
-
-  public static getInstance(): State {
-    if (!State.instance) {
-      State.instance = new State();
-    }
-    return State.instance;
-  }
-
-  public setTypeBeingProcessed(typeToSet: Type): void {
-    this.typeBeingProcessed = typeToSet;
-  }
-
-  public getTypeBeingProcessed(): Type | undefined {
-    return this.typeBeingProcessed;
-  }
-}

package/src/service/walkers/class-walker.ts

@@ -1,30 +0,0 @@
-import { Walker, WalkerListener } from './walker';
-import { ClassMirror } from '@cparra/apex-reflection';
-
-export class ClassWalker extends Walker {
-  walk(listener: WalkerListener): void {
-    listener.onTypeDeclaration(this.type);
-    const classMirror = this.type as ClassMirror;
-    if (classMirror.constructors.length) {
-      listener.onConstructorDeclaration(this.type.name, classMirror.constructors);
-    }
-    if (classMirror.fields.length) {
-      listener.onFieldsDeclaration(this.sortType(classMirror.fields));
-    }
-    if (classMirror.properties.length) {
-      listener.onPropertiesDeclaration(this.sortType(classMirror.properties));
-    }
-    if (classMirror.methods.length) {
-      listener.onMethodsDeclaration(this.sortType(classMirror.methods));
-    }
-    if (classMirror.enums.length) {
-      listener.onInnerEnumsDeclaration(this.sortType(classMirror.enums));
-    }
-    if (classMirror.classes.length) {
-      listener.onInnerClassesDeclaration(this.sortType(classMirror.classes));
-    }
-    if (classMirror.interfaces.length) {
-      listener.onInnerInterfacesDeclaration(this.sortType(classMirror.interfaces));
-    }
-  }
-}

package/src/service/walkers/enum-walker.ts

@@ -1,7 +0,0 @@
-import { Walker, WalkerListener } from './walker';
-
-export class EnumWalker extends Walker {
-  walk(listener: WalkerListener): void {
-    listener.onTypeDeclaration(this.type);
-  }
-}

package/src/service/walkers/interface-walker.ts

@@ -1,12 +0,0 @@
-import { Walker, WalkerListener } from './walker';
-import { InterfaceMirror } from '@cparra/apex-reflection';
-
-export class InterfaceWalker extends Walker {
-  walk(listener: WalkerListener): void {
-    listener.onTypeDeclaration(this.type);
-    const interfaceMirror = this.type as InterfaceMirror;
-    if (interfaceMirror.methods.length) {
-      listener.onMethodsDeclaration(this.sortType(interfaceMirror.methods));
-    }
-  }
-}

package/src/service/walkers/walker-factory.ts

@@ -1,19 +0,0 @@
-import { Type } from '@cparra/apex-reflection';
-import { Walker } from './walker';
-import { ClassWalker } from './class-walker';
-import { EnumWalker } from './enum-walker';
-import { InterfaceWalker } from './interface-walker';
-
-export class WalkerFactory {
-  static get(type: Type): Walker {
-    switch (type.type_name) {
-      case 'class':
-        return new ClassWalker(type);
-      case 'enum':
-        return new EnumWalker(type);
-      case 'interface':
-        return new InterfaceWalker(type);
-    }
-    throw Error('Walker not found for type.');
-  }
-}

package/src/service/walkers/walker.ts

@@ -1,42 +0,0 @@
-import {
-  ClassMirror,
-  ConstructorMirror,
-  EnumMirror,
-  FieldMirror,
-  InterfaceMirror,
-  MethodMirror,
-  PropertyMirror,
-  Type,
-} from '@cparra/apex-reflection';
-import { Settings } from '../../settings';
-
-export interface WalkerListener {
-  onTypeDeclaration(typeMirror: Type): void;
-
-  onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void;
-
-  onFieldsDeclaration(fields: FieldMirror[]): void;
-
-  onPropertiesDeclaration(properties: PropertyMirror[]): void;
-
-  onMethodsDeclaration(methods: MethodMirror[]): void;
-
-  onInnerEnumsDeclaration(enums: EnumMirror[]): void;
-
-  onInnerClassesDeclaration(classes: ClassMirror[]): void;
-
-  onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
-}
-
-export abstract class Walker {
-  constructor(public type: Type) {}
-
-  abstract walk(listener: WalkerListener): void;
-
-  protected sortType<T extends { name: string }>(types: T[]): T[] {
-    if (Settings.getInstance().sortMembersAlphabetically()) {
-      return types.sort((a, b) => a.name.localeCompare(b.name));
-    }
-    return types;
-  }
-}

package/src/settings.ts

@@ -1,162 +0,0 @@
-import { GeneratorChoices } from './transpiler/generator-choices';
-
-export type OnBeforeFileWrite = (file: TargetFile) => TargetFile;
-
-export type TargetFile = {
-  name: string;
-  extension: string;
-  dir: OutputDir;
-};
-
-export type OutputDir = {
-  baseDir: string;
-  fileDir: string;
-};
-
-export type TargetType = {
-  name: string;
-  typeName: 'class' | 'interface' | 'enum';
-  accessModifier: string;
-  description?: string;
-  group?: string;
-};
-
-export interface SettingsConfig {
-  sourceDirectory: string;
-  recursive: boolean;
-  scope: string[];
-  outputDir: string;
-  targetGenerator: GeneratorChoices;
-  indexOnly: boolean;
-  defaultGroupName: string;
-  sanitizeHtml: boolean;
-  openApiTitle?: string;
-  title: string;
-  namespace?: string;
-  openApiFileName: string;
-  includeMetadata: boolean;
-  rootDir?: string;
-  sortMembersAlphabetically?: boolean;
-  onAfterProcess?: (files: TargetFile[]) => void;
-  onBeforeFileWrite?: (file: TargetFile) => TargetFile;
-  frontMatterHeader?: (file: TargetType) => string[];
-  singleFile?: boolean;
-  fileName?: string;
-  templateFilePath?: string;
-}
-
-export class Settings {
-  private static instance: Settings;
-
-  private constructor(public config: SettingsConfig) {}
-
-  public static build(config: SettingsConfig) {
-    Settings.instance = new Settings(config);
-  }
-
-  public static getInstance(): Settings {
-    if (!Settings.instance) {
-      throw new Error('Settings has not been initialized');
-    }
-    return Settings.instance;
-  }
-
-  get sourceDirectory(): string {
-    return this.config.sourceDirectory;
-  }
-
-  get recursive(): boolean {
-    return this.config.recursive;
-  }
-
-  get scope(): string[] {
-    return this.config.scope;
-  }
-
-  get outputDir(): string {
-    return this.config.outputDir;
-  }
-
-  get targetGenerator(): GeneratorChoices {
-    return this.config.targetGenerator;
-  }
-
-  get indexOnly(): boolean {
-    return this.config.indexOnly;
-  }
-
-  get sanitizeHtml(): boolean {
-    return this.config.sanitizeHtml;
-  }
-
-  public getDefaultGroupName(): string {
-    return this.config.defaultGroupName;
-  }
-
-  public getOpenApiTitle(): string | undefined {
-    return this.config.openApiTitle ?? this.config.title;
-  }
-
-  public getTitle(): string {
-    return this.config.title;
-  }
-
-  public getNamespace(): string | undefined {
-    return this.config.namespace;
-  }
-
-  public getNamespacePrefix(): string {
-    if (!this.config.namespace) {
-      return '';
-    }
-    return `${this.config.namespace}.`;
-  }
-
-  public openApiFileName(): string {
-    return this.config.openApiFileName;
-  }
-
-  public includeMetadata(): boolean {
-    return this.config.includeMetadata;
-  }
-
-  public sortMembersAlphabetically(): boolean {
-    return this.config.sortMembersAlphabetically ?? false;
-  }
-
-  public getRootDir(): string | undefined {
-    return this.config.rootDir;
-  }
-
-  public onAfterProcess(files: TargetFile[]): void {
-    if (this.config.onAfterProcess) {
-      this.config.onAfterProcess(files);
-    }
-  }
-
-  public onBeforeFileWrite(file: TargetFile): TargetFile {
-    if (this.config.onBeforeFileWrite) {
-      return this.config.onBeforeFileWrite(file);
-    }
-    return file;
-  }
-
-  public frontMatterHeader(file: TargetType): string[] {
-    if (this.config.frontMatterHeader) {
-      return this.config.frontMatterHeader(file);
-    }
-    return [];
-  }
-
-  public shouldOutputSingleFile(): boolean {
-    return this.config.singleFile ?? false;
-  }
-
-  public getSingleFileName(): string {
-    return this.config.fileName ?? 'README';
-  }
-
-  public getTemplateFilePath(): string | undefined {
-    return this.config.templateFilePath;
-  }
-}