mdat 1.3.3 → 1.3.5

package/dist/api.d.ts

@@ -1,31 +0,0 @@
-import type { VFile } from 'vfile';
-import type { ConfigToLoad, 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,74 +0,0 @@
-import type { NormalizedPackageJson } from 'read-pkg';
-import type { Options, Rules } from 'remark-mdat';
-import type { Simplify } from 'type-fest';
-export type Config = Simplify<Options & {
-    assetsPath?: string;
-    packageFile?: string;
-}>;
-export type ConfigLoaded = {
-    addMetaComment: boolean | string;
-    assetsPath: string;
-    closingPrefix: string;
-    keywordPrefix: string;
-    metaCommentIdentifier: string;
-    packageFile: string | undefined;
-    rules: Rules;
-};
-/**
- * Generously accept either string paths to .ts, .js, or .json files with
- * `Config` type default exports. Takes a single value, or an array of values which
- * will be merged right to left.
- */
-export type ConfigToLoad = Array<Config | string> | Config | string;
-/**
- * Generously accept either string paths to .ts, .js, or .json files with
- * `Rules` type default exports.
- */
-export type RulesToLoad = Array<Rules | string> | Rules | string;
-/**
- * Load and validate mdat configuration / rule sets
- * Uses cosmiconfig to search in the usual places.
- * Merge precedence: Base Defaults < Readme Defaults < Searched Config < Additional Config Paths
- *
- * Generic to accommodate additional Config options, so set T to your custom config type if needed. You must provide a matching configExtensionSchema as well.
- */
-export declare function loadConfig(options?: {
-    /**
-     * Additional Config objects to merge.
-     *
-     * Strings are treated as paths to `ts`, `js`, or `json` files with `Config` type default exports. These will be dynamically loaded by Cosmiconfig.
-     * Accepts an individual item, or an array. Objects in the array will be merged right to left.
-     *
-     */
-    additionalConfig?: ConfigToLoad;
-    /**
-     * Additional Rules objects to merge.
-     *
-     * Strings are treated as paths to `ts`, `js`, or `json` files with `Rules` type default exports. These will be dynamically loaded by Cosmiconfig.
-     * Accepts an individual item, or an array. Objects in the array will be merged right to left, and take precedence over any rules in previously loaded Config objects as well.
-     */
-    additionalRules?: RulesToLoad;
-    /**
-     * Readme-specific defaults that have higher priority than base defaults but lower than searched config.
-     * Used internally by loadConfigReadme.
-     */
-    readmeDefaults?: Config;
-    /** 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 {Error} If no package.json is found
- */
-export declare function getPackageJson(): Promise<NormalizedPackageJson>;
-/**
- * Convenience function for merging configs
- * Performs a deep merge, with the rightmost object taking precedence
- */
-export declare function mergeConfigs(a: Config, b: Config): Config;

package/dist/index.d.ts

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