mdat 0.10.0 → 1.0.1

package/dist/api.d.ts

@@ -1,11 +1,31 @@
 import { type VFile } from 'vfile';
 import { type ConfigToLoad, type RulesToLoad } from './config';
 /**
+ * Expand MDAT comments in one or more Markdown files
  * Writing is the responsibility of the caller (e.g. via `await write(result)`)
+ * @returns an array of VFiles (Even if you only pass a single file path!)
  */
 export declare function expandFiles(files: string | string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
+/**
+ * Expand MDAT comments in a Markdown string
+ */
 export declare function expandString(markdown: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
+/**
+ * Check and validate MDAT comments in one or more Markdown files
+ * @returns an array of VFiles (Even if you only pass a single file path!)
+ */
 export declare function checkFiles(files: string | string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
+/**
+ * Check and validate MDAT comments in a Markdown string
+ */
 export declare function checkString(markdown: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
+/**
+ * Collapse MDAT comments in one or more Markdown files
+ * Writing is the responsibility of the caller (e.g. via `await write(result)`)
+ * @returns an array of VFiles (Even if you only pass a single file path!)
+ */
 export declare function collapseFiles(files: string | string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
+/**
+ * Collapse MDAT comments in a Markdown string
+ */
 export declare function collapseString(markdown: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;

package/dist/config.d.ts

@@ -1,10 +1,10 @@
 import { type NormalizedPackageJson } from 'read-pkg';
 import { type Options, type Rules } from 'remark-mdat';
 import { type Simplify } from 'type-fest';
-export type Config = Simplify<{
+export type Config = Simplify<Options & {
     assetsPath?: string;
     packageFile?: string;
-} & Options>;
+}>;
 export type ConfigLoaded = {
     addMetaComment: boolean;
     assetsPath: string;
@@ -51,7 +51,16 @@ export declare function loadConfig(options?: {
     /** Search for config in specific directories, mainly useful for testing. Cosmiconfig default search paths used if unset. */
     searchFrom?: string;
 }): Promise<ConfigLoaded>;
+/**
+ * Get the current MDAT config object, loading it if necessary
+ */
 export declare function getConfig(): Promise<ConfigLoaded>;
+/**
+ * Convenience function for rules
+ * Load as package json only as needed, memoize
+ * Rules could call this themselves, but this is more convenient and efficient
+ * @throws If no package.json is found
+ */
 export declare function getPackageJson(): Promise<NormalizedPackageJson>;
 /**
  * Convenience function for merging configs

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { checkFiles, checkString, collapseFiles, collapseString, expandFiles, expandString, } from './api';
 export { type Config, loadConfig, mergeConfigs } from './config';
-export { checkReadmeFiles, checkReadmeString, collapseReadmeFiles, expandReadmeFiles, expandReadmeString, } from './readme/api';
+export { checkReadme, checkReadmeFiles, checkReadmeString, collapseReadme, collapseReadmeFiles, expandReadme, expandReadmeFiles, expandReadmeString, } from './readme/api';
 export { loadConfigReadme } from './readme/config';
 export { type Rules } from 'remark-mdat';