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

package/src/{transpiler → core}/openapi/__tests__/open-api-docs-processor.spec.ts

@@ -1,5 +1,5 @@
 import { OpenApiDocsProcessor } from '../open-api-docs-processor';
-import { Settings } from '../../../settings';
+import { Settings } from '../../settings';
 import { SettingsBuilder } from '../../../test-helpers/SettingsBuilder';
 import { DocCommentBuilder } from '../../../test-helpers/DocCommentBuilder';
 import { AnnotationBuilder } from '../../../test-helpers/AnnotationBuilder';

package/src/{model → core/openapi}/apex-type-wrappers/__tests__/ClassMirrorWrapper.spec.ts

@@ -1,7 +1,7 @@
-import { ClassMirrorBuilder } from '../../../test-helpers/ClassMirrorBuilder';
 import { ClassMirrorWrapper } from '../ClassMirrorWrapper';
-import { AnnotationBuilder } from '../../../test-helpers/AnnotationBuilder';
-import { MethodMirrorBuilder } from '../../../test-helpers/MethodMirrorBuilder';
+import { ClassMirrorBuilder } from '../../../../test-helpers/ClassMirrorBuilder';
+import { MethodMirrorBuilder } from '../../../../test-helpers/MethodMirrorBuilder';
+import { AnnotationBuilder } from '../../../../test-helpers/AnnotationBuilder';
 
 it('should return methods by annotation when they exist', function () {
   const classMirror = new ClassMirrorBuilder()

package/src/core/openapi/file-container.ts

@@ -0,0 +1,13 @@
+import { PageData } from '../shared/types';
+
+export class FileContainer {
+  _files: PageData[] = [];
+
+  files(): PageData[] {
+    return this._files;
+  }
+
+  pushFile(file: PageData): void {
+    this._files.push(file);
+  }
+}

package/src/{service → core/openapi}/manifest-factory.ts

@@ -1,7 +1,7 @@
-import Manifest from '../core/manifest';
+import Manifest from '../manifest';
 import { TypeParser } from './parser';
 import { ReflectionResult } from '@cparra/apex-reflection';
-import ApexBundle from '../core/apex-bundle';
+import { SourceFile } from '../shared/types';
 
 /**
  * Builds a new Manifest object, sourcing its types from the received TypeParser.
@@ -10,7 +10,7 @@ import ApexBundle from '../core/apex-bundle';
  */
 export function createManifest(
   typeParser: TypeParser,
-  reflect: (apexBundle: ApexBundle) => ReflectionResult,
+  reflect: (apexBundle: SourceFile) => ReflectionResult,
 ): Manifest {
   return new Manifest(typeParser.parse(reflect));
 }

package/src/{transpiler → core}/openapi/open-api-docs-processor.ts

@@ -1,19 +1,17 @@
-import ProcessorTypeTranspiler from '../processor-type-transpiler';
-import { FileContainer } from '../file-container';
+import { FileContainer } from './file-container';
 import { ClassMirror, Type } from '@cparra/apex-reflection';
-import { OpenapiTypeFile } from '../../model/openapi/openapi-type-file';
-import { Logger } from '../../util/logger';
-import { OpenApi } from '../../model/openapi/open-api';
-import { Settings } from '../../settings';
+import { Logger } from '#utils/logger';
+import { OpenApi } from './open-api';
+import { Settings } from '../settings';
 import { MethodParser } from './parsers/MethodParser';
-import { camel2title } from '../../util/string-utils';
+import { camel2title } from '#utils/string-utils';
+import { createOpenApiFile } from './openapi-type-file';
 
-export class OpenApiDocsProcessor extends ProcessorTypeTranspiler {
+export class OpenApiDocsProcessor {
   protected readonly _fileContainer: FileContainer;
   openApiModel: OpenApi;
 
   constructor() {
-    super();
     this._fileContainer = new FileContainer();
     const title = Settings.getInstance().getOpenApiTitle();
     if (!title) {
@@ -68,7 +66,8 @@ export class OpenApiDocsProcessor extends ProcessorTypeTranspiler {
   }
 
   onAfterProcess: ((types: Type[]) => void) | undefined = () => {
-    this._fileContainer.pushFile(new OpenapiTypeFile(this.openApiModel));
+    const page = createOpenApiFile(Settings.getInstance().openApiFileName(), this.openApiModel);
+    this._fileContainer.pushFile(page);
   };
 
   private getEndpointPath(type: Type): string | null {

package/src/core/openapi/openapi-type-file.ts

@@ -0,0 +1,14 @@
+import { OpenApi } from './open-api';
+import { OpenApiPageData } from '../shared/types';
+
+export function createOpenApiFile(fileName: string, openApiModel: OpenApi): OpenApiPageData {
+  const content = JSON.stringify({ ...openApiModel, namespace: undefined }, null, 2);
+  return {
+    fileExtension: 'json',
+    fileName,
+    directory: '',
+    content,
+    frontmatter: null,
+    group: null,
+  };
+}

package/src/{service → core/openapi}/parser.ts

@@ -1,25 +1,25 @@
 import { ClassMirror, InterfaceMirror, ReflectionResult, Type } from '@cparra/apex-reflection';
-import ApexBundle from '../core/apex-bundle';
-import MetadataProcessor from './metadata-processor';
-import { Logger } from '../util/logger';
+import { parseApexMetadata } from '../parse-apex-metadata';
+import { Logger } from '#utils/logger';
+import { SourceFile } from '../shared/types';
 
 export interface TypeParser {
-  parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[];
+  parse(reflect: (apexBundle: SourceFile) => ReflectionResult): Type[];
 }
 
 type NameAware = { name: string };
 
 export class RawBodyParser implements TypeParser {
-  constructor(public typeBundles: ApexBundle[]) {}
+  constructor(public typeBundles: SourceFile[]) {}
 
-  parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[] {
+  parse(reflect: (apexBundle: SourceFile) => ReflectionResult): Type[] {
     const types = this.typeBundles
       .map((currentBundle) => {
         Logger.log(`Parsing file: ${currentBundle.filePath}`);
         const result = reflect(currentBundle);
-        if (!!result.typeMirror && !!currentBundle.rawMetadataContent) {
+        if (!!result.typeMirror && !!currentBundle.metadataContent) {
           // If successful and there is a metadata file
-          const metadataParams = MetadataProcessor.process(currentBundle.rawMetadataContent);
+          const metadataParams = parseApexMetadata(currentBundle.metadataContent);
           metadataParams.forEach((value, key) => {
             const declaration = `${key}: ${value}`;
             result.typeMirror?.annotations.push({

package/src/{transpiler → core}/openapi/parsers/Builder.ts

@@ -1,6 +1,6 @@
 import { Reference, ReferenceBuilder } from './ReferenceBuilder';
-import { ApexDocSchemaObject } from '../../../model/openapi/apex-doc-types';
-import { SchemaObject } from '../../../model/openapi/open-api-types';
+import { ApexDocSchemaObject } from '../../../core/openapi/apex-doc-types';
+import { SchemaObject } from '../../../core/openapi/open-api-types';
 
 export type ApexDocSchemaAware = {
   schema: ApexDocSchemaObject;

package/src/{transpiler → core}/openapi/parsers/MethodParser.ts

@@ -1,7 +1,7 @@
 import { ClassMirror, MethodMirror } from '@cparra/apex-reflection';
-import { OpenApi } from '../../../model/openapi/open-api';
+import { OpenApi } from '../../../core/openapi/open-api';
 import * as yaml from 'js-yaml';
-import { ClassMirrorWrapper } from '../../../model/apex-type-wrappers/ClassMirrorWrapper';
+import { ClassMirrorWrapper } from '../../../core/openapi/apex-type-wrappers/ClassMirrorWrapper';
 import { Reference, ReferenceBuilder } from './ReferenceBuilder';
 import { ParameterObjectBuilder } from './ParameterObjectBuilder';
 import { ResponsesBuilder } from './ResponsesBuilder';
@@ -9,11 +9,11 @@ import {
   ApexDocHttpRequestBody,
   ApexDocHttpResponse,
   ApexDocParameterObject,
-} from '../../../model/openapi/apex-doc-types';
+} from '../../../core/openapi/apex-doc-types';
 import { RequestBodyBuilder } from './RequestBodyBuilder';
 import { ApexDocSchemaAware } from './Builder';
-import { PropertiesObject, ReferenceObject } from '../../../model/openapi/open-api-types';
-import { MethodMirrorWrapper } from '../../../model/apex-type-wrappers/MethodMirrorWrapper';
+import { PropertiesObject, ReferenceObject } from '../../../core/openapi/open-api-types';
+import { MethodMirrorWrapper } from '../../../core/openapi/apex-type-wrappers/MethodMirrorWrapper';
 
 type FallbackMethodParser = (methodMirror: MethodMirror) => void;
 type AddToOpenApi<T extends ApexDocSchemaAware> = (input: T, urlValue: string, httpMethodKey: HttpOperations) => void;

package/src/{transpiler → core}/openapi/parsers/ParameterObjectBuilder.ts

@@ -1,6 +1,6 @@
-import { ParameterObject } from '../../../model/openapi/open-api-types';
+import { ParameterObject } from '../../../core/openapi/open-api-types';
 import { Reference } from './ReferenceBuilder';
-import { ApexDocParameterObject } from '../../../model/openapi/apex-doc-types';
+import { ApexDocParameterObject } from '../../../core/openapi/apex-doc-types';
 import { Builder } from './Builder';
 
 export class ParameterObjectBuilder extends Builder<ParameterObject, ApexDocParameterObject> {

package/src/{transpiler → core}/openapi/parsers/ReferenceBuilder.ts

@@ -5,11 +5,11 @@ import {
   SchemaObject,
   SchemaObjectArray,
   SchemaObjectObject,
-} from '../../../model/openapi/open-api-types';
-import { TypeBundle, TypesRepository } from '../../../model/types-repository';
+} from '../../../core/openapi/open-api-types';
+import { TypeBundle, TypesRepository } from '../../../core/openapi/types-repository';
 import { ClassMirror, DocCommentAnnotation, FieldMirror, PropertyMirror } from '@cparra/apex-reflection';
 import { ListObjectType, ReferencedType } from '@cparra/apex-reflection';
-import { ApexDocSchemaObject } from '../../../model/openapi/apex-doc-types';
+import { ApexDocSchemaObject } from '../../../core/openapi/apex-doc-types';
 
 type TypeBundleWithIsCollectionAndReferenceOverrides = TypeBundle & {
   originalTypeName: string;

package/src/{transpiler → core}/openapi/parsers/RequestBodyBuilder.ts

@@ -1,6 +1,6 @@
-import { RequestBody } from '../../../model/openapi/open-api-types';
+import { RequestBody } from '../../../core/openapi/open-api-types';
 import { Reference } from './ReferenceBuilder';
-import { ApexDocHttpRequestBody } from '../../../model/openapi/apex-doc-types';
+import { ApexDocHttpRequestBody } from '../../../core/openapi/apex-doc-types';
 import { Builder } from './Builder';
 
 /**

package/src/{transpiler → core}/openapi/parsers/ResponsesBuilder.ts

@@ -1,6 +1,6 @@
-import { ResponseObject } from '../../../model/openapi/open-api-types';
+import { ResponseObject } from '../../../core/openapi/open-api-types';
 import { Reference } from './ReferenceBuilder';
-import { ApexDocHttpResponse } from '../../../model/openapi/apex-doc-types';
+import { ApexDocHttpResponse } from '../../../core/openapi/apex-doc-types';
 import { Builder } from './Builder';
 
 export class ResponsesBuilder extends Builder<ResponseObject, ApexDocHttpResponse> {

package/src/{transpiler → core}/openapi/parsers/__tests__/MethodParser.spec.ts

@@ -1,7 +1,7 @@
 import { ClassMirrorBuilder } from '../../../../test-helpers/ClassMirrorBuilder';
 import { MethodMirrorBuilder } from '../../../../test-helpers/MethodMirrorBuilder';
 import { AnnotationBuilder } from '../../../../test-helpers/AnnotationBuilder';
-import { OpenApi } from '../../../../model/openapi/open-api';
+import { OpenApi } from '../../../../core/openapi/open-api';
 import { MethodParser } from '../MethodParser';
 import { DocCommentBuilder } from '../../../../test-helpers/DocCommentBuilder';
 

package/src/{transpiler → core}/openapi/parsers/__tests__/ParameterObjectBuilder.spec.ts

@@ -1,7 +1,7 @@
 import { ParameterObjectBuilder } from '../ParameterObjectBuilder';
 import { Reference } from '../ReferenceBuilder';
-import { ReferenceObject } from '../../../../model/openapi/open-api-types';
-import { ApexDocParameterObject } from '../../../../model/openapi/apex-doc-types';
+import { ReferenceObject } from '../../../../core/openapi/open-api-types';
+import { ApexDocParameterObject } from '../../../../core/openapi/apex-doc-types';
 
 jest.mock('../ReferenceBuilder', () => {
   return {

package/src/{transpiler → core}/openapi/parsers/__tests__/ReferenceBuilder.spec.ts

@@ -1,8 +1,8 @@
-import { TypesRepository } from '../../../../model/types-repository';
+import { TypesRepository } from '../../../../core/openapi/types-repository';
 import { ReferenceBuilder } from '../ReferenceBuilder';
 import { ClassMirrorBuilder } from '../../../../test-helpers/ClassMirrorBuilder';
 import { FieldMirrorBuilder } from '../../../../test-helpers/FieldMirrorBuilder';
-import { SchemaObjectArray, SchemaObjectObject } from '../../../../model/openapi/open-api-types';
+import { SchemaObjectArray, SchemaObjectObject } from '../../../../core/openapi/open-api-types';
 import { DocCommentBuilder } from '../../../../test-helpers/DocCommentBuilder';
 import { DocCommentAnnotationBuilder } from '../../../../test-helpers/DocCommentAnnotationBuilder';
 

package/src/{transpiler → core}/openapi/parsers/__tests__/RequestBodyBuilder.spec.ts

@@ -1,7 +1,7 @@
 import { RequestBodyBuilder } from '../RequestBodyBuilder';
 import { Reference } from '../ReferenceBuilder';
-import { ReferenceObject } from '../../../../model/openapi/open-api-types';
-import { ApexDocHttpRequestBody } from '../../../../model/openapi/apex-doc-types';
+import { ReferenceObject } from '../../../../core/openapi/open-api-types';
+import { ApexDocHttpRequestBody } from '../../../../core/openapi/apex-doc-types';
 
 jest.mock('../ReferenceBuilder', () => {
   return {

package/src/{transpiler → core}/openapi/parsers/__tests__/ResponsesBuilder.spec.ts

@@ -1,6 +1,6 @@
 import { ResponsesBuilder } from '../ResponsesBuilder';
 import { Reference } from '../ReferenceBuilder';
-import { ApexDocHttpResponse } from '../../../../model/openapi/apex-doc-types';
+import { ApexDocHttpResponse } from '../../../../core/openapi/apex-doc-types';
 
 jest.mock('../ReferenceBuilder', () => {
   return {

package/src/{transpiler → core/openapi}/transpiler.ts

@@ -1,24 +1,20 @@
 import { Type } from '@cparra/apex-reflection';
-import ProcessorTypeTranspiler from './processor-type-transpiler';
 import { Settings } from '../settings';
-import State from '../service/state';
+import { OpenApiDocsProcessor } from './open-api-docs-processor';
 
 export default class Transpiler {
-  static generate(types: Type[], processor: ProcessorTypeTranspiler): void {
+  static generate(types: Type[], processor: OpenApiDocsProcessor): void {
     const sortedTypes = types.sort((apexTypeA, apexTypeB) => {
       if (apexTypeA.name < apexTypeB.name) return -1;
       if (apexTypeA.name > apexTypeB.name) return 1;
       return 0;
     });
 
-    processor.onBeforeProcess?.(sortedTypes);
-
     if (Settings.getInstance().indexOnly) {
       return;
     }
 
     sortedTypes.forEach((currentType) => {
-      State.getInstance().setTypeBeingProcessed(currentType);
       processor.onProcess(currentType);
     });
     processor.onAfterProcess?.(sortedTypes);

package/src/{model → core/openapi}/types-repository.ts

@@ -4,7 +4,6 @@ export type TypeBundle = { type: Type; isChild: boolean; parentType?: Type };
 
 export class TypesRepository {
   private static instance: TypesRepository;
-  private scopedTypes: Type[] = [];
   private allTypes: Type[] = [];
 
   public static getInstance(): TypesRepository {
@@ -52,12 +51,4 @@ export class TypesRepository {
     }
     return { type: foundType, isChild: false };
   }
-
-  public populateScoped(types: Type[]) {
-    this.scopedTypes = types;
-  }
-
-  public getFromScopedByName(typeName: string): Type | undefined {
-    return this.scopedTypes.find((currentType: Type) => currentType.name === typeName);
-  }
 }

package/src/core/parse-apex-metadata.ts

@@ -0,0 +1,14 @@
+import { XMLParser } from 'fast-xml-parser';
+
+export function parseApexMetadata(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/core/settings.ts

@@ -0,0 +1,56 @@
+import { Generator } from './shared/types';
+
+export interface SettingsConfig {
+  sourceDirectory: string;
+  scope: string[];
+  outputDir: string;
+  targetGenerator: Generator;
+  indexOnly: boolean;
+  defaultGroupName: string;
+  openApiTitle?: string;
+  namespace?: string;
+  openApiFileName: string;
+  includeMetadata: boolean;
+  sortMembersAlphabetically?: boolean;
+}
+
+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 scope(): string[] {
+    return this.config.scope;
+  }
+
+  get targetGenerator(): Generator {
+    return this.config.targetGenerator;
+  }
+
+  get indexOnly(): boolean {
+    return this.config.indexOnly;
+  }
+
+  public getOpenApiTitle(): string | undefined {
+    return this.config.openApiTitle;
+  }
+
+  public getNamespace(): string | undefined {
+    return this.config.namespace;
+  }
+
+  public openApiFileName(): string {
+    return this.config.openApiFileName;
+  }
+}

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

@@ -0,0 +1,92 @@
+import { Type } from '@cparra/apex-reflection';
+
+export type Generator = 'markdown' | 'openapi';
+
+export type ConfigurableHooks = {
+  transformReferenceGuide: TransformReferenceGuide;
+  transformDocs: TransformDocs;
+  transformDocPage: TransformDocPage;
+};
+
+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 SourceFile = {
+  filePath: string;
+  content: string;
+  metadataContent: string | null;
+};
+
+export type ParsedFile = {
+  filePath: string;
+  type: Type;
+};
+
+type Frontmatter = string | Record<string, unknown> | null;
+
+export type ReferenceGuidePageData = {
+  directory: string;
+  frontmatter: Frontmatter;
+  content: string;
+  fileExtension: string;
+  fileName: string;
+};
+
+export type DocPageData = {
+  source: {
+    filePath: string;
+    name: string;
+    type: 'interface' | 'class' | 'enum';
+  };
+  group: string | null;
+  fileName: string;
+  fileExtension: string;
+  directory: string;
+  frontmatter: Frontmatter;
+  content: string;
+};
+
+export type OpenApiPageData = Omit<DocPageData, 'source'>;
+
+export type PageData = DocPageData | OpenApiPageData | ReferenceGuidePageData;
+
+export type DocumentationBundle = {
+  referenceGuide: ReferenceGuidePageData;
+  docs: DocPageData[];
+};
+
+export type Skip = {
+  readonly _tag: 'Skip';
+};
+
+export type PostHookDocumentationBundle = {
+  referenceGuide: ReferenceGuidePageData | Skip;
+  docs: DocPageData[];
+};
+
+// Configurable Hooks
+
+export type TransformReferenceGuide = (
+  referenceGuide: ReferenceGuidePageData,
+) => Partial<ReferenceGuidePageData> | Skip | Promise<Partial<ReferenceGuidePageData> | Skip>;
+
+export type TransformDocs = (docs: DocPageData[]) => DocPageData[] | Promise<DocPageData[]>;
+
+export type TransformDocPage = (doc: DocPageData) => Partial<DocPageData> | Promise<Partial<DocPageData>>;

package/src/core/shared/utils.ts

@@ -0,0 +1,5 @@
+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

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

package/src/index.ts

@@ -1,3 +1,35 @@
-import * as reflection from '@cparra/apex-reflection';
+import { SetOptional } from 'type-fest';
+import type {
+  ConfigurableHooks,
+  Skip,
+  UserDefinedMarkdownConfig,
+  ReferenceGuidePageData,
+  DocPageData,
+} from './core/shared/types';
+import { defaults } from './defaults';
 
-export { reflection };
+type ConfigurableMarkdownConfig = Omit<
+  SetOptional<
+    UserDefinedMarkdownConfig,
+    'targetDir' | 'scope' | 'defaultGroupName' | 'includeMetadata' | 'sortMembersAlphabetically'
+  >,
+  'targetGenerator'
+>;
+
+function defineMarkdownConfig(config: ConfigurableMarkdownConfig): UserDefinedMarkdownConfig {
+  return {
+    ...defaults,
+    ...config,
+    targetGenerator: 'markdown',
+  };
+}
+
+function skip(): Skip {
+  return {
+    _tag: 'Skip',
+  };
+}
+
+// Exports
+
+export { defineMarkdownConfig, skip, ConfigurableHooks, ReferenceGuidePageData, DocPageData };

package/src/test-helpers/InterfaceMirrorBuilder.ts

@@ -20,11 +20,6 @@ export class InterfaceMirrorBuilder {
     return this;
   }
 
-  withDocComment(docComment: DocComment): InterfaceMirrorBuilder {
-    this.docComment = docComment;
-    return this;
-  }
-
   addMethod(method: MethodMirror): InterfaceMirrorBuilder {
     this.methods.push(method);
     return this;

package/src/test-helpers/SettingsBuilder.ts

@@ -1,4 +1,4 @@
-import { SettingsConfig } from '../settings';
+import { SettingsConfig } from '../core/settings';
 
 /**
  * Builder class to create SettingsConfig objects.
@@ -8,18 +8,14 @@ export class SettingsBuilder {
   build(): SettingsConfig {
     return {
       sourceDirectory: './',
-      recursive: true,
       scope: [],
       outputDir: './',
       targetGenerator: 'openapi',
       indexOnly: false,
       defaultGroupName: 'Misc',
-      sanitizeHtml: true,
       openApiTitle: 'Apex API',
       openApiFileName: 'openapi',
-      title: 'Classes',
       includeMetadata: false,
-      linkingStrategy: 'root-relative',
     };
   }
 }

package/src/util/fp.ts

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

package/src/util/logger.ts

@@ -26,14 +26,14 @@ export class Logger {
    * @param message The error message to log.
    * @param args Optional arguments.
    */
-  public static error(message: string, ...args: string[]) {
+  public static error(message: unknown, ...args: string[]) {
     this.logSingle(message, false, 'red', false);
     args.forEach(() => {
       this.logSingle(message, false, 'red', false);
     });
   }
 
-  public static logSingle(text: string, showSpinner = true, color: 'green' | 'red' = 'green', overrideConsole = true) {
+  public static logSingle(text: unknown, showSpinner = true, color: 'green' | 'red' = 'green', overrideConsole = true) {
     if (this.currentFrame > 9) {
       this.currentFrame = 0;
     }

package/src/util/string-utils.ts

@@ -1,7 +1,3 @@
-export function truncate(str: string, n: number) {
-  return str.length > n ? str.substr(0, n - 1) + '…' : str;
-}
-
 export const camel2title = (camelCase: string) =>
   camelCase
     .replace(/\//g, ' ')

package/tsconfig.json

@@ -9,7 +9,11 @@
     "esModuleInterop": true,
     "lib": [
       "ES2021"
-    ]
+    ],
+    "baseUrl": "./",
+    "paths": {
+      "#utils/*": ["src/util/*"],
+    }
   },
   "include": [
     "src", "jest.d.ts"

package/apexdocs.config.ts

@@ -1,13 +0,0 @@
-import { TargetFile, TargetType } from './src/settings';
-
-export default {
-  onBeforeFileWrite: (file: TargetFile): TargetFile => {
-    console.log('onBefore writing', file);
-    return file;
-  },
-  onAfterProcess: (files: TargetFile[]) => {
-    console.log('onAfterProcess files', files);
-  },
-  frontMatterHeader: (file: TargetType) => [`title: ${file.name}.cls`, `description: ${file.description}`],
-  sortMembersAlphabetically: true,
-};