@cparra/apexdocs 2.25.0-alpha.8 → 3.0.0-alpha.1

package/dist/cli/generate.js

@@ -5,18 +5,18 @@ var _function = require('fp-ts/function');
 var E = require('fp-ts/Either');
 var TE = require('fp-ts/TaskEither');
 var yaml = require('js-yaml');
+var path = require('path');
 var apexReflection = require('@cparra/apex-reflection');
 var O = require('fp-ts/Option');
 var fastXmlParser = require('fast-xml-parser');
 var Handlebars = require('handlebars');
+var defaults = require('../defaults-jLXD2y8-.js');
 var fs = require('fs');
-var path = require('path');
 var chalk = require('chalk');
 var logUpdate = require('log-update');
 var cosmiconfig = require('cosmiconfig');
 var yargs = require('yargs');
 var cosmiconfigTypescriptLoader = require('cosmiconfig-typescript-loader');
-var defaults = require('../defaults-DUwru49Q.js');
 
 function _interopNamespaceDefault(e) {
   var n = Object.create(null);
@@ -38,9 +38,9 @@ function _interopNamespaceDefault(e) {
 var E__namespace = /*#__PURE__*/_interopNamespaceDefault(E);
 var TE__namespace = /*#__PURE__*/_interopNamespaceDefault(TE);
 var yaml__namespace = /*#__PURE__*/_interopNamespaceDefault(yaml);
+var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
 var O__namespace = /*#__PURE__*/_interopNamespaceDefault(O);
 var fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs);
-var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
 var yargs__namespace = /*#__PURE__*/_interopNamespaceDefault(yargs);
 
 function apply(fn, ...front) {
@@ -425,7 +425,7 @@ function typeToRenderable(parsedFile, linkGenerator, config) {
     }
   }
   return __spreadProps$d(__spreadValues$d({}, getRenderable()), {
-    filePath: parsedFile.filePath,
+    filePath: parsedFile.source.filePath,
     namespace: config.namespace
   });
 }
@@ -569,116 +569,57 @@ function singleGroup(headingLevel, groupName, adapter, members, linkGenerator) {
   };
 }
 
-function parsedFilesToRenderableBundle(config, parsedFiles) {
-  return parsedFiles.reduce(
-    (acc, parsedFile) => {
-      var _a;
-      const renderable = typeToRenderable(
-        parsedFile,
-        (referenceName) => {
-          return linkFromTypeNameGenerator(
-            parsedFile.type,
-            parsedFiles.map((file) => file.type),
-            referenceName,
-            config
-          );
-        },
-        config
-      );
-      acc.renderables.push(renderable);
-      const descriptionLines = (_a = parsedFile.type.docComment) == null ? void 0 : _a.descriptionLines;
-      const reference = {
-        typeName: parsedFile.type.name,
-        directory: getDirectoryFromRoot(config, parsedFile.type),
-        title: getLinkFromRoot(config, parsedFile.type),
-        description: adaptDescribable(
-          descriptionLines,
-          (referenceName) => getPossibleLinkFromRoot(
-            config,
-            referenceName,
-            findType(
-              parsedFiles.map((file) => file.type),
-              referenceName
-            )
-          )
-        ).description
-      };
-      const group = getTypeGroup(parsedFile.type, config);
-      if (!acc.references[group]) {
-        acc.references[group] = [];
-      }
-      acc.references[group].push(reference);
+function parsedFilesToRenderableBundle(config, parsedFiles, references) {
+  const referenceFinder = apply(linkGenerator, references, config.documentationRootDir);
+  function toReferenceGuide(parsedFiles2) {
+    return parsedFiles2.reduce(
+      addToReferenceGuide(referenceFinder, config, references),
+      {}
+    );
+  }
+  function toRenderables(parsedFiles2) {
+    return parsedFiles2.reduce((acc, parsedFile) => {
+      const renderable = typeToRenderable(parsedFile, referenceFinder, config);
+      acc.push(renderable);
       return acc;
-    },
-    {
-      references: {},
-      renderables: []
-    }
-  );
-}
-function linkFromTypeNameGenerator(typeBeingDocumented, repository, referenceName, config) {
-  const type = findType(repository, referenceName);
-  if (!type) {
-    return referenceName;
+    }, []);
   }
-  const [fullClassName, fileLink] = getFileLinkTuple(typeBeingDocumented, type, config);
   return {
-    __type: "link",
-    title: fullClassName,
-    url: fileLink
+    referencesByGroup: toReferenceGuide(parsedFiles),
+    renderables: toRenderables(parsedFiles)
   };
 }
-function getPossibleLinkFromRoot(config, fallback, type) {
-  if (!type) {
-    return fallback;
-  }
-  const namespacePrefix = config.namespace ? `${config.namespace}.` : "";
-  const title = `${namespacePrefix}${type.name}`;
-  return {
-    __type: "link",
-    title,
-    url: `${getDirectoryFromRoot(config, type)}/${title}.md`
+function addToReferenceGuide(findLinkFromHome, config, references) {
+  return (acc, parsedFile) => {
+    var _a, _b;
+    const group = getTypeGroup$1(parsedFile.type, config);
+    if (!acc[group]) {
+      acc[group] = [];
+    }
+    acc[group].push({
+      reference: references[parsedFile.type.name],
+      title: findLinkFromHome(parsedFile.type.name),
+      description: (_b = adaptDescribable((_a = parsedFile.type.docComment) == null ? void 0 : _a.descriptionLines, findLinkFromHome).description) != null ? _b : null
+    });
+    return acc;
   };
 }
-function getDirectoryFromRoot(config, type) {
-  if (!type) {
-    return "";
-  }
-  return `./${getSanitizedGroup(type, config)}`;
-}
-function findType(repository, referenceName) {
-  return repository.find((currentType) => currentType.name.toLowerCase() === referenceName.toLowerCase());
-}
-function getFileLinkTuple(typeBeingDocumented, referencedType, config) {
-  const namespacePrefix = config.namespace ? `${config.namespace}.` : "";
-  const directoryRoot = `${getDirectoryRoot(typeBeingDocumented, referencedType, config)}`;
-  const fullClassName = `${namespacePrefix}${referencedType.name}`;
-  return [fullClassName, `${directoryRoot}${fullClassName}.md`];
-}
-function getDirectoryRoot(typeBeingDocumented, referencedType, config) {
-  if (getTypeGroup(typeBeingDocumented, config) === getTypeGroup(referencedType, config)) {
-    return "./";
-  } else {
-    return `../${getSanitizedGroup(referencedType, config)}/`;
-  }
-}
-function getTypeGroup(type, config) {
+const linkGenerator = (references, documentationRootDir, referenceName) => {
+  const reference = references[referenceName];
+  return reference ? (
+    // Starting the path with a "/" will ensure the link will always be relative to the root of the site.
+    {
+      __type: "link",
+      title: reference.displayName,
+      url: path__namespace.join("/", documentationRootDir, reference.pathFromRoot)
+    }
+  ) : referenceName;
+};
+function getTypeGroup$1(type, config) {
   var _a, _b;
   const groupAnnotation = (_a = type.docComment) == null ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === "group");
   return (_b = groupAnnotation == null ? void 0 : groupAnnotation.body) != null ? _b : config.defaultGroupName;
 }
-function getSanitizedGroup(classModel, config) {
-  return getTypeGroup(classModel, config).replace(/ /g, "-").replace(".", "");
-}
-function getLinkFromRoot(config, type) {
-  const namespacePrefix = config.namespace ? `${config.namespace}.` : "";
-  const title = `${namespacePrefix}${type.name}`;
-  return {
-    __type: "link",
-    title,
-    url: `${getDirectoryFromRoot(config, type)}/${title}.md`
-  };
-}
 
 function parseApexMetadata(input) {
   var _a;
@@ -730,7 +671,11 @@ function reflectSourceBody(apexBundle) {
   const { filePath, content: input, metadataContent: metadata } = apexBundle;
   const result = apexReflection.reflect(input);
   return result.error ? E__namespace.left(new ReflectionError(filePath, result.error.message)) : E__namespace.right({
-    filePath,
+    source: {
+      filePath,
+      name: result.typeMirror.name,
+      type: result.typeMirror.type_name
+    },
     type: addFileMetadataToTypeAnnotation(result.typeMirror, metadata)
   });
 }
@@ -1249,15 +1194,15 @@ const link = (source) => {
   }
 };
 
-const convertToDocumentationBundle = (referenceGuideTemplate, { references, renderables }) => ({
+const convertToDocumentationBundle = (referenceGuideTemplate, { referencesByGroup, renderables }) => ({
   referenceGuide: {
-    directory: "",
     frontmatter: null,
-    content: referencesToReferenceGuideContent(references, referenceGuideTemplate),
-    fileExtension: "md",
-    fileName: "index"
+    content: referencesToReferenceGuideContent(referencesByGroup, referenceGuideTemplate),
+    filePath: "index.md"
   },
-  docs: renderables.map((renderable) => renderableToPageData(Object.values(references).flat(), renderable))
+  docs: renderables.map(
+    (renderable) => renderableToPageData(Object.values(referencesByGroup).flat(), renderable)
+  )
 });
 function referencesToReferenceGuideContent(references, template) {
   function alphabetizeReferences(references2) {
@@ -1279,21 +1224,18 @@ function renderableToPageData(referenceGuideReference, renderable) {
   function buildDocOutput(renderable2, docContents) {
     var _a;
     const reference = referenceGuideReference.find(
-      (ref) => ref.typeName.toLowerCase() === renderable2.name.toLowerCase()
+      (ref) => ref.reference.source.name.toLowerCase() === renderable2.name.toLowerCase()
     );
-    const namespacePrefix = renderable2.namespace ? `${renderable2.namespace}.` : "";
     return {
       source: {
         filePath: renderable2.filePath,
         name: renderable2.name,
         type: renderable2.type
       },
-      fileName: `${namespacePrefix}${renderable2.name}`,
-      fileExtension: "md",
-      directory: `${reference == null ? void 0 : reference.directory}`,
+      filePath: reference.reference.pathFromRoot,
       frontmatter: null,
       content: docContents,
-      group: (_a = renderable2.doc.group) != null ? _a : "Miscellaneous"
+      group: (_a = renderable2.doc.group) != null ? _a : defaults.defaults.defaultGroupName
     };
   }
   return _function.pipe(renderable, resolveApexTypeTemplate, compile, (docContents) => buildDocOutput(renderable, docContents));
@@ -1501,6 +1443,28 @@ function isSkip(value) {
   return Object.prototype.hasOwnProperty.call(value, "_tag") && value._tag === "Skip";
 }
 
+function parsedFilesToReferenceGuide(config, parsedFiles) {
+  return parsedFiles.reduce((acc, parsedFile) => {
+    acc[parsedFile.type.name] = parsedFileToDocPageReference(config, parsedFile);
+    return acc;
+  }, {});
+}
+function parsedFileToDocPageReference(config, parsedFile) {
+  return {
+    source: parsedFile.source,
+    displayName: parsedFile.type.name,
+    pathFromRoot: `${slugify(getTypeGroup(parsedFile.type, config))}/${parsedFile.type.name}.md`
+  };
+}
+function getTypeGroup(type, config) {
+  var _a, _b;
+  const groupAnnotation = (_a = type.docComment) == null ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === "group");
+  return (_b = groupAnnotation == null ? void 0 : groupAnnotation.body) != null ? _b : config.defaultGroupName;
+}
+function slugify(text) {
+  return text.toLowerCase().replace(/[^a-z0-9\s-]/g, "").trim().replace(/\s+/g, "-").replace(/-+/g, "-");
+}
+
 var __defProp$7 = Object.defineProperty;
 var __defProps$7 = Object.defineProperties;
 var __getOwnPropDescs$7 = Object.getOwnPropertyDescriptors;
@@ -1548,6 +1512,7 @@ class HookError {
 }
 function generateDocs(apexBundles, config) {
   const filterOutOfScope = apply(filterScope, config.scope);
+  const convertToReferences = apply(parsedFilesToReferenceGuide, config);
   const convertToRenderableBundle = apply(parsedFilesToRenderableBundle, config);
   const convertToDocumentationBundleForTemplate = apply(convertToDocumentationBundle, config.referenceGuideTemplate);
   const sortTypeMembers = apply(sortMembers, config.sortMembersAlphabetically);
@@ -1559,52 +1524,50 @@ function generateDocs(apexBundles, config) {
     E__namespace.map(addInheritedMembersToTypes),
     E__namespace.map(addInheritanceChainToTypes),
     E__namespace.map(sortTypeMembers),
-    E__namespace.map(convertToRenderableBundle),
-    E__namespace.map(convertToDocumentationBundleForTemplate),
+    E__namespace.bindTo("parsedFiles"),
+    E__namespace.bind("references", ({ parsedFiles }) => E__namespace.right(convertToReferences(parsedFiles))),
     TE__namespace.fromEither,
-    TE__namespace.flatMap(
-      (bundle) => TE__namespace.tryCatch(
-        () => documentationBundleHook(bundle, config),
-        (error) => new HookError(error)
-      )
-    ),
-    TE__namespace.map((bundle) => ({
-      referenceGuide: isSkip(bundle.referenceGuide) ? bundle.referenceGuide : __spreadProps$7(__spreadValues$7({}, bundle.referenceGuide), {
-        content: Template.getInstance().compile({
-          source: {
-            frontmatter: toFrontmatterString(bundle.referenceGuide.frontmatter),
-            content: bundle.referenceGuide.content
-          },
-          template: hookableTemplate
-        })
-      }),
-      docs: bundle.docs.map((doc) => __spreadProps$7(__spreadValues$7({}, doc), {
-        content: Template.getInstance().compile({
-          source: {
-            frontmatter: toFrontmatterString(doc.frontmatter),
-            content: doc.content
-          },
-          template: hookableTemplate
-        })
-      }))
-    }))
+    TE__namespace.flatMap(({ parsedFiles, references }) => transformReferenceHook(config)({ references, parsedFiles })),
+    TE__namespace.map(({ parsedFiles, references }) => convertToRenderableBundle(parsedFiles, references)),
+    TE__namespace.map(convertToDocumentationBundleForTemplate),
+    TE__namespace.flatMap(transformDocumentationBundleHook(config)),
+    TE__namespace.map(postHookCompile)
   );
 }
-function toFrontmatterString(frontmatter) {
-  if (typeof frontmatter === "string") {
-    return frontmatter;
-  }
-  if (!frontmatter) {
-    return "";
+function transformReferenceHook(config) {
+  function _execute(references, parsedFiles, transformReference) {
+    return __async$2(this, null, function* () {
+      return {
+        references: yield execTransformReferenceHook(Object.values(references), transformReference),
+        parsedFiles
+      };
+    });
   }
-  const yamlString = yaml.dump(frontmatter);
-  return `---
-${yamlString}---
-`;
+  return ({ references, parsedFiles }) => TE__namespace.tryCatch(
+    () => _execute(references, parsedFiles, config.transformReference),
+    (error) => new HookError(error)
+  );
+}
+function transformDocumentationBundleHook(config) {
+  return (bundle) => TE__namespace.tryCatch(
+    () => documentationBundleHook(bundle, config),
+    (error) => new HookError(error)
+  );
 }
 function passThroughHook(value) {
   return value;
 }
+const execTransformReferenceHook = (_0, ..._1) => __async$2(void 0, [_0, ..._1], function* (references, hook = passThroughHook) {
+  const hooked = references.map((reference) => __async$2(void 0, null, function* () {
+    const hookedResult = yield hook(reference);
+    return __spreadValues$7(__spreadValues$7({}, reference), hookedResult);
+  }));
+  const awaited = yield Promise.all(hooked);
+  return awaited.reduce((acc, reference) => {
+    acc[reference.source.name] = reference;
+    return acc;
+  }, {});
+});
 const documentationBundleHook = (bundle, config) => __async$2(void 0, null, function* () {
   return {
     referenceGuide: yield transformReferenceGuide(bundle.referenceGuide, config.transformReferenceGuide),
@@ -1625,6 +1588,40 @@ const transformDocs = (_0, ..._1) => __async$2(void 0, [_0, ..._1], function* (d
 const transformDocPage = (_0, ..._1) => __async$2(void 0, [_0, ..._1], function* (doc, hook = passThroughHook) {
   return __spreadValues$7(__spreadValues$7({}, doc), yield hook(doc));
 });
+function postHookCompile(bundle) {
+  return {
+    referenceGuide: isSkip(bundle.referenceGuide) ? bundle.referenceGuide : __spreadProps$7(__spreadValues$7({}, bundle.referenceGuide), {
+      content: Template.getInstance().compile({
+        source: {
+          frontmatter: toFrontmatterString(bundle.referenceGuide.frontmatter),
+          content: bundle.referenceGuide.content
+        },
+        template: hookableTemplate
+      })
+    }),
+    docs: bundle.docs.map((doc) => __spreadProps$7(__spreadValues$7({}, doc), {
+      content: Template.getInstance().compile({
+        source: {
+          frontmatter: toFrontmatterString(doc.frontmatter),
+          content: doc.content
+        },
+        template: hookableTemplate
+      })
+    }))
+  };
+}
+function toFrontmatterString(frontmatter) {
+  if (typeof frontmatter === "string") {
+    return frontmatter;
+  }
+  if (!frontmatter) {
+    return "";
+  }
+  const yamlString = yaml.dump(frontmatter);
+  return `---
+${yamlString}---
+`;
+}
 
 var __defProp$6 = Object.defineProperty;
 var __defProps$6 = Object.defineProperties;
@@ -1648,18 +1645,15 @@ var __spreadProps$6 = (a, b) => __defProps$6(a, __getOwnPropDescs$6(b));
 class FileWriter {
   static write(files, outputDir, onWriteCallback) {
     files.forEach((file) => {
-      const resolvedFile = this.getTargetLocation(file, outputDir);
-      if (!fs__namespace.existsSync(resolvedFile.directory)) {
-        fs__namespace.mkdirSync(resolvedFile.directory, { recursive: true });
-      }
-      const filePath = path__namespace.join(resolvedFile.directory, `${resolvedFile.fileName}.${resolvedFile.fileExtension}`);
-      fs__namespace.writeFileSync(filePath, resolvedFile.content, "utf8");
-      onWriteCallback(resolvedFile);
+      const { filePath, content } = this.getTargetLocation(file, outputDir);
+      fs__namespace.mkdirSync(path__namespace.dirname(filePath), { recursive: true });
+      fs__namespace.writeFileSync(filePath, content, "utf8");
+      onWriteCallback(file);
     });
   }
   static getTargetLocation(file, outputDir) {
     return __spreadProps$6(__spreadValues$6({}, file), {
-      directory: path__namespace.join(outputDir, file.directory)
+      filePath: path__namespace.join(outputDir, file.filePath)
     });
   }
 }
@@ -1775,7 +1769,7 @@ function writeFilesToSystem(files, outputDir) {
     [files.referenceGuide, ...files.docs].filter((file) => !isSkip(file)),
     outputDir,
     (file) => {
-      Logger.logSingle(`${file.fileName} processed.`, false, "green", false);
+      Logger.logSingle(`${file.filePath} processed.`, false, "green", false);
     }
   );
 }
@@ -2660,9 +2654,7 @@ var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
 function createOpenApiFile(fileName, openApiModel) {
   const content = JSON.stringify(__spreadProps$1(__spreadValues$1({}, openApiModel), { namespace: void 0 }), null, 2);
   return {
-    fileExtension: "json",
-    fileName,
-    directory: "",
+    filePath: "",
     content,
     frontmatter: null,
     group: null
@@ -2735,7 +2727,7 @@ function openApi(fileBodies, config) {
   Transpiler.generate(filteredTypes, processor);
   const generatedFiles = processor.fileBuilder().files();
   FileWriter.write(generatedFiles, config.targetDir, (file) => {
-    Logger.logSingle(`${file.fileName} processed.`, false, "green", false);
+    Logger.logSingle(`${file.filePath} processed.`, false, "green", false);
   });
   ErrorLogger.logErrors(filteredTypes);
 }
@@ -2871,27 +2863,17 @@ const markdownOptions = {
     array: true,
     alias: "p",
     default: defaults.defaults.scope,
-    describe: "A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource."
+    describe: "A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled."
   },
   defaultGroupName: {
     type: "string",
     default: defaults.defaults.defaultGroupName,
     describe: "Defines the @group name to be used when a file does not specify it."
   },
-  openApiTitle: {
-    type: "string",
-    default: "Apex REST Api",
-    describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.'
-  },
   namespace: {
     type: "string",
     describe: "The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. If generating an OpenApi definition, it will be added to the file's Server Url."
   },
-  openApiFileName: {
-    type: "string",
-    describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
-    default: "openapi"
-  },
   sortMembersAlphabetically: {
     type: "boolean",
     describe: "Whether to sort members alphabetically.",
@@ -2901,6 +2883,11 @@ const markdownOptions = {
     type: "boolean",
     describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
     default: defaults.defaults.includeMetadata
+  },
+  documentationRootDir: {
+    type: "string",
+    describe: "The root directory of the documentation. This is used to generate the correct relative paths.",
+    default: defaults.defaults.documentationRootDir
   }
 };
 
@@ -2967,10 +2954,10 @@ function extractArgs() {
 }
 
 function main() {
-  function cathError(error) {
+  function catchError(error) {
     console.error(error);
     process.exit(1);
   }
-  extractArgs().then((config) => Apexdocs.generate(config).catch(cathError)).catch(cathError);
+  extractArgs().then((config) => Apexdocs.generate(config).catch(catchError)).catch(catchError);
 }
 main();

package/dist/defaults-jLXD2y8-.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const defaults = {
+  targetGenerator: "markdown",
+  targetDir: "./docs/",
+  scope: ["global"],
+  defaultGroupName: "Miscellaneous",
+  includeMetadata: false,
+  sortMembersAlphabetically: false,
+  documentationRootDir: ""
+};
+
+exports.defaults = defaults;

package/dist/index.d.ts

@@ -1,9 +1,13 @@
 import { SetOptional } from 'type-fest';
 
+/**
+ * The configurable hooks that can be used to modify the output of the generator.
+ */
 type ConfigurableHooks = {
   transformReferenceGuide: TransformReferenceGuide;
   transformDocs: TransformDocs;
   transformDocPage: TransformDocPage;
+  transformReference: TransformReference;
 };
 
 type UserDefinedMarkdownConfig = {
@@ -15,48 +19,83 @@ type UserDefinedMarkdownConfig = {
   namespace?: string;
   sortMembersAlphabetically: boolean;
   includeMetadata: boolean;
+  documentationRootDir: string;
 } & Partial<ConfigurableHooks>;
 
+type SourceFileMetadata = {
+  filePath: string;
+  name: string;
+  type: 'interface' | 'class' | 'enum';
+};
+
+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;
 
 type ReferenceGuidePageData = {
-  directory: string;
   frontmatter: Frontmatter;
   content: string;
-  fileExtension: string;
-  fileName: string;
+  filePath: string;
 };
 
 type DocPageData = {
-  source: {
-    filePath: string;
-    name: string;
-    type: 'interface' | 'class' | 'enum';
-  };
+  source: SourceFileMetadata;
   group: string | null;
-  fileName: string;
-  fileExtension: string;
-  directory: string;
+  filePath: string;
   frontmatter: Frontmatter;
   content: string;
 };
 
+/**
+ * Represents a file to be skipped.
+ */
 type Skip = {
   readonly _tag: 'Skip';
 };
 
 // Configurable Hooks
 
+type ConfigurableDocPageReference = Omit<DocPageReference, 'source'>;
+
+type ConfigurableDocPageData = Omit<DocPageData, 'source' | 'filePath'>;
+
+/**
+ * Allows changing where the files are written to.
+ */
+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.
+ */
 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.
+ */
 type TransformDocs = (docs: DocPageData[]) => DocPageData[] | Promise<DocPageData[]>;
 
-type TransformDocPage = (doc: DocPageData) => Partial<DocPageData> | Promise<Partial<DocPageData>>;
+/**
+ * Allows changing the frontmatter and content of the doc pages.
+ */
+type TransformDocPage = (
+  doc: DocPageData,
+) => Partial<ConfigurableDocPageData> | Promise<Partial<ConfigurableDocPageData>>;
 
-type ConfigurableMarkdownConfig = Omit<SetOptional<UserDefinedMarkdownConfig, 'targetDir' | 'scope' | 'defaultGroupName' | 'includeMetadata' | 'sortMembersAlphabetically'>, 'targetGenerator'>;
+type ConfigurableMarkdownConfig = Omit<SetOptional<UserDefinedMarkdownConfig, 'targetDir' | 'scope' | 'defaultGroupName' | 'includeMetadata' | 'sortMembersAlphabetically' | 'documentationRootDir'>, 'targetGenerator'>;
 declare function defineMarkdownConfig(config: ConfigurableMarkdownConfig): UserDefinedMarkdownConfig;
 declare function skip(): Skip;
 
-export { type ConfigurableHooks, type DocPageData, type ReferenceGuidePageData, defineMarkdownConfig, skip };
+export { type ConfigurableHooks, type DocPageData, type DocPageReference, type ReferenceGuidePageData, defineMarkdownConfig, skip };

package/dist/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var defaults = require('./defaults-DUwru49Q.js');
+var defaults = require('./defaults-jLXD2y8-.js');
 
 var __defProp = Object.defineProperty;
 var __defProps = Object.defineProperties;