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

package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/documentable-partial-template.ts

@@ -3,10 +3,12 @@ export const documentablePartialTemplate = `
 \`{{this}}\`
 {{/each}}
 
-{{withLinks doc.description}}
+{{{renderContent doc.description}}}
 
 {{#each doc.customTags}}
-**{{splitAndCapitalize name}}** {{withLinks description}}
+**{{splitAndCapitalize name}}** 
+
+{{{renderContent description}}}
 
 {{/each}}
 
@@ -14,11 +16,11 @@ export const documentablePartialTemplate = `
 
 {{#if doc.mermaid.value}}
 {{ heading doc.mermaid.headingLevel doc.mermaid.heading }}
-{{code "mermaid" doc.mermaid.value}}
+{{code doc.mermaid.value}}
 {{/if}}
 
 {{#if doc.example.value}}
 {{ heading doc.example.headingLevel doc.example.heading }}
-{{code "apex" doc.example.value}}
+{{{renderContent doc.example.value}}}
 {{/if}}
 `.trim();

package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/fieldsPartialTemplate.ts

@@ -10,7 +10,7 @@ export const fieldsPartialTemplate = `
 {{#> documentablePartialTemplate }}
 
 {{ heading signature.headingLevel signature.heading }}
-{{ code "apex" signature.value }}
+{{ code signature.value }}
 
 {{ heading type.headingLevel type.heading }}
 {{link type.value}}

package/src/core/markdown/templates/hookable.ts

@@ -0,0 +1,7 @@
+export const hookableTemplate = `
+{{#if frontmatter}}
+{{{frontmatter}}}
+{{/if}}
+
+{{{content}}}
+`.trim();

package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/methods-partial-template.ts

@@ -10,14 +10,14 @@ export const methodsPartialTemplate = `
 {{#> documentablePartialTemplate}}
 
 {{ heading signature.headingLevel signature.heading }}
-{{ code "apex" signature.value }}
+{{ code signature.value }}
 
 {{#if parameters.value}}
 {{ heading parameters.headingLevel parameters.heading }}
 | Name | Type | Description |
 |------|------|-------------|
 {{#each parameters.value}}
-| {{name}} | {{link type}} | {{withLinks description}} |
+| {{name}} | {{link type}} | {{{renderContent description}}} |
 {{/each}}
 {{/if}}
 

package/src/core/{templates → markdown/templates}/reference-guide.ts

@@ -7,7 +7,7 @@ export const referenceGuideTemplate = `
 {{#each this}}
 ### {{link title}}
 
-{{withLinks description}}
+{{{renderContent description}}}
 
 {{/each}}
 {{/each}}

package/src/core/{template.ts → markdown/templates/template.ts}

@@ -1,15 +1,15 @@
 import Handlebars from 'handlebars';
-import { typeDocPartial } from '../transpiler/markdown/plain-markdown/type-doc-partial';
-import { documentablePartialTemplate } from '../transpiler/markdown/plain-markdown/documentable-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 { classMarkdownTemplate } from '../transpiler/markdown/plain-markdown/class-template';
-import { enumMarkdownTemplate } from '../transpiler/markdown/plain-markdown/enum-template';
-import { interfaceMarkdownTemplate } from '../transpiler/markdown/plain-markdown/interface-template';
-import { RenderableContent, StringOrLink } from './renderable/types';
-import { isEmptyLine } from '../adapters/type-utils';
-import { groupedMembersPartialTemplate } from '../transpiler/markdown/plain-markdown/grouped-members-partial-template';
+import { CodeBlock, RenderableContent, StringOrLink } from '../adapters/types';
+import { isCodeBlock, isEmptyLine, isInlineCode } from '../adapters/type-utils';
+import { typeDocPartial } from './type-doc-partial';
+import { documentablePartialTemplate } from './documentable-partial-template';
+import { methodsPartialTemplate } from './methods-partial-template';
+import { groupedMembersPartialTemplate } from './grouped-members-partial-template';
+import { constructorsPartialTemplate } from './constructors-partial-template';
+import { fieldsPartialTemplate } from './fieldsPartialTemplate';
+import { classMarkdownTemplate } from './class-template';
+import { enumMarkdownTemplate } from './enum-template';
+import { interfaceMarkdownTemplate } from './interface-template';
 
 export type CompilationRequest = {
   template: string;
@@ -32,7 +32,7 @@ export class Template {
 
     Handlebars.registerHelper('link', link);
     Handlebars.registerHelper('code', convertCodeBlock);
-    Handlebars.registerHelper('withLinks', resolveLinksInContent);
+    Handlebars.registerHelper('renderContent', resolveRenderableContent);
     Handlebars.registerHelper('heading', heading);
     Handlebars.registerHelper('inlineCode', inlineCode);
     Handlebars.registerHelper('splitAndCapitalize', splitAndCapitalize);
@@ -73,27 +73,33 @@ const inlineCode = (text: string) => {
   return new Handlebars.SafeString(`\`${text}\``);
 };
 
-const convertCodeBlock = (language: string, lines: string[]): Handlebars.SafeString => {
+const convertCodeBlock = (codeBlock: CodeBlock): Handlebars.SafeString => {
   return new Handlebars.SafeString(
     `
-\`\`\`${language}
-${lines.join('\n')}
+\`\`\`${codeBlock.language}
+${codeBlock.content.join('\n')}
 \`\`\`
   `.trim(),
   );
 };
 
-const resolveLinksInContent = (description?: RenderableContent[]): string => {
+const resolveRenderableContent = (description?: RenderableContent[]): string => {
   if (!description) {
     return '';
   }
 
   function reduceDescription(acc: string, curr: RenderableContent) {
     if (isEmptyLine(curr)) {
-      return acc + '\n\n';
+      return acc + '\n';
+    }
+    if (isCodeBlock(curr)) {
+      return acc + convertCodeBlock(curr) + '\n';
+    }
+    if (isInlineCode(curr)) {
+      return acc + inlineCode(curr.content).toString() + ' ';
+    } else {
+      return acc + Handlebars.escapeExpression(link(curr)).trim() + ' ';
     }
-
-    return acc + link(curr).trim() + ' ';
   }
 
   return description.reduce(reduceDescription, '').trim();

package/src/core/markdown/utils.ts

@@ -0,0 +1,3 @@
+import { ParsedFile } from '../shared/types';
+
+export const parsedFilesToTypes = (parsedFiles: ParsedFile[]) => parsedFiles.map((parsedFile) => parsedFile.type);

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 '../model/manifest';
+import Manifest from '../manifest';
 import { TypeParser } from './parser';
 import { ReflectionResult } from '@cparra/apex-reflection';
-import ApexBundle from '../model/apex-bundle';
+import { UnparsedSourceFile } from '../shared/types';
 
 /**
  * Builds a new Manifest object, sourcing its types from the received TypeParser.
@@ -10,7 +10,7 @@ import ApexBundle from '../model/apex-bundle';
  */
 export function createManifest(
   typeParser: TypeParser,
-  reflect: (apexBundle: ApexBundle) => ReflectionResult,
+  reflect: (apexBundle: UnparsedSourceFile) => 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,12 @@
+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 {
+    filePath: '',
+    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 '../model/apex-bundle';
-import MetadataProcessor from './metadata-processor';
-import { Logger } from '../util/logger';
+import { parseApexMetadata } from '../parse-apex-metadata';
+import { Logger } from '#utils/logger';
+import { UnparsedSourceFile } from '../shared/types';
 
 export interface TypeParser {
-  parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[];
+  parse(reflect: (apexBundle: UnparsedSourceFile) => ReflectionResult): Type[];
 }
 
 type NameAware = { name: string };
 
 export class RawBodyParser implements TypeParser {
-  constructor(public typeBundles: ApexBundle[]) {}
+  constructor(public typeBundles: UnparsedSourceFile[]) {}
 
-  parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[] {
+  parse(reflect: (apexBundle: UnparsedSourceFile) => 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;
+  }
+}