mdat 3.2.0 → 3.2.1

package/dist/lib/index.d.ts

@@ -1,5 +1,5 @@
-import { Rule, Rule as Rule$1 } from "remark-mdat";
 import { ILogBasic, ILogLayer } from "lognow";
+import { Rule, Rule as Rule$1 } from "remark-mdat";
 import { MetadataContext } from "metascope";
 import { VFile } from "vfile";
 //#region src/lib/config.d.ts
@@ -18,7 +18,7 @@ type ConfigToLoad = Array<Config | string> | Config | string;
  * places. Merge precedence: Base Defaults < Defaults < Searched Config <
  * Additional Config
  */
-declare function loadConfig(options?: {
+export declare function loadConfig(options?: {
   /**
    * Additional Config objects to merge.
    *
@@ -42,11 +42,11 @@ declare function loadConfig(options?: {
 /**
  * Convenience function for merging configs. Rightmost config takes precedence.
  */
-declare function mergeConfig(a: Config, b: Config): Config;
+export declare function mergeConfig(a: Config, b: Config): Config;
 /**
  * Identity function providing type inference for mdat configuration files.
  */
-declare function defineConfig(config: Config): Config;
+export declare function defineConfig(config: Config): Config;
 //#endregion
 //#region src/lib/readme/create.d.ts
 type MdatReadmeCreateOptions = {
@@ -77,13 +77,13 @@ declare function createReadme(options?: Partial<MdatReadmeCreateOptions>): Promi
  *
  * @returns An array of VFiles
  */
-declare function expand(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, options?: {
+export declare function expand(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, options?: {
   format?: boolean;
 }): Promise<VFile[]>;
 /**
  * Expand MDAT comments in a Markdown string.
  */
-declare function expandString(markdown: string, config?: ConfigToLoad, options?: {
+export declare function expandString(markdown: string, config?: ConfigToLoad, options?: {
   format?: boolean;
 }): Promise<VFile>;
 /**
@@ -93,13 +93,13 @@ declare function expandString(markdown: string, config?: ConfigToLoad, options?:
  *
  * @returns An array of VFiles
  */
-declare function collapse(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, options?: {
+export declare function collapse(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, options?: {
   format?: boolean;
 }): Promise<VFile[]>;
 /**
  * Collapse MDAT comments in a Markdown string.
  */
-declare function collapseString(markdown: string, config?: ConfigToLoad, options?: {
+export declare function collapseString(markdown: string, config?: ConfigToLoad, options?: {
   format?: boolean;
 }): Promise<VFile>;
 /**
@@ -110,13 +110,13 @@ declare function collapseString(markdown: string, config?: ConfigToLoad, options
  *
  * @returns An array of VFiles
  */
-declare function strip(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, options?: {
+export declare function strip(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, options?: {
   format?: boolean;
 }): Promise<VFile[]>;
 /**
  * Strip MDAT comments from a Markdown string.
  */
-declare function stripString(markdown: string, config?: ConfigToLoad, options?: {
+export declare function stripString(markdown: string, config?: ConfigToLoad, options?: {
   format?: boolean;
 }): Promise<VFile>;
 /**
@@ -125,7 +125,7 @@ declare function stripString(markdown: string, config?: ConfigToLoad, options?:
  *
  * @returns Per-file sync status and expanded VFiles
  */
-declare function check(files?: string | string[], config?: ConfigToLoad, options?: {
+export declare function check(files?: string | string[], config?: ConfigToLoad, options?: {
   format?: boolean;
 }): Promise<Array<{
   inSync: boolean;
@@ -135,7 +135,7 @@ declare function check(files?: string | string[], config?: ConfigToLoad, options
  * Check if MDAT comments in a Markdown string are up to date by expanding and
  * comparing per-tag.
  */
-declare function checkString(markdown: string, config?: ConfigToLoad, options?: {
+export declare function checkString(markdown: string, config?: ConfigToLoad, options?: {
   format?: boolean;
 }): Promise<{
   inSync: boolean;
@@ -149,7 +149,7 @@ declare function checkString(markdown: string, config?: ConfigToLoad, options?:
  *
  * @throws {Error} If no package.json is found
  */
-declare function getContextMetadata(): Promise<MetadataContext>;
+export declare function getContextMetadata(): Promise<MetadataContext>;
 declare const readmeMetadataTemplate: import("metascope").Template<{
   author: string | undefined;
   authorUrl: string | undefined;
@@ -193,7 +193,7 @@ type ReadmeMetadata = ReturnType<typeof readmeMetadataTemplate>;
  *
  * @public
  */
-declare function getReadmeMetadata(): Promise<{
+export declare function getReadmeMetadata(): Promise<{
   author: string | undefined;
   authorUrl: string | undefined;
   bin: string[] | undefined;
@@ -234,7 +234,7 @@ declare function getReadmeMetadata(): Promise<{
  * Reset all cached metadata. Call between tests or when the underlying project
  * files may have changed on disk.
  */
-declare function resetMetadataCaches(): void;
+export declare function resetMetadataCaches(): void;
 //#endregion
 //#region src/lib/log.d.ts
 /**
@@ -244,6 +244,6 @@ declare function resetMetadataCaches(): void;
  * @param logger - Accepts either a LogLayer instance or a Console- or
  *   Stream-like log target
  */
-declare function setLogger(logger?: ILogBasic | ILogLayer<unknown>): void;
+export declare function setLogger(logger?: ILogBasic | ILogLayer<unknown>): void;
 //#endregion
-export { type Config, type ReadmeMetadata, type Rule, check, checkString, collapse, collapseString, createReadme as create, createReadmeInteractive as createInteractive, defineConfig, expand, expandString, getContextMetadata, getReadmeMetadata, loadConfig, mergeConfig, resetMetadataCaches, setLogger, strip, stripString };
+export { type Config, type ReadmeMetadata, type Rule, createReadme as create, createReadmeInteractive as createInteractive };