mdat 1.3.4 → 1.3.5

package/dist/mdat-json-loader.d.ts

@@ -1,7 +0,0 @@
-import type { LoaderResult } from 'cosmiconfig';
-/**
- * Lets arbitrary JSON objects (like from package.json) become reasonably good mdat rule sets
- * HOWEVER cosmiconfig treats package.json as a special case and will always load only specific keys from it
- * So we have to intercept and load them manually in config.ts
- */
-export declare function mdatJsonLoader(filePath: string, content: string): LoaderResult;

package/dist/processors.d.ts

@@ -1,12 +0,0 @@
-import type { Root } from 'mdast';
-import { VFile } from 'vfile';
-import type { ConfigLoaded, ConfigToLoad, loadConfig, RulesToLoad } from './config';
-import type { AmbientRemarkConfig } from './utilities';
-type Loader = typeof loadConfig;
-type ProcessorGetter = typeof getCleanProcessor | typeof getExpandProcessor;
-export declare function processFiles(files: string | string[], loader: Loader, processorGetter: ProcessorGetter, name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
-export declare function processString(markdown: string, loader: Loader, processorGetter: ProcessorGetter, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
-export declare function getExpandProcessor(options: ConfigLoaded, ambientRemarkConfig: AmbientRemarkConfig): import("unified").Processor<Root, undefined, undefined, Root, string>;
-export declare function getCleanProcessor(options: ConfigLoaded, ambientRemarkConfig: AmbientRemarkConfig): import("unified").Processor<Root, undefined, undefined, Root, string>;
-export declare function getCheckProcessor(options: ConfigLoaded, ambientRemarkConfig: AmbientRemarkConfig): import("unified").Processor<Root, undefined, undefined, Root, string>;
-export {};

package/dist/readme/api.d.ts

@@ -1,46 +0,0 @@
-import type { VFile } from 'vfile';
-import type { ConfigToLoad, RulesToLoad } from '../config';
-/**
- * Expands MDAT readme comments in the closest readme.md file
- * Basically an alias to `expandReadmeFiles()` with certain arguments elided.
- * @see `findReadme()` for more details on the search process.
- */
-export declare function expandReadme(config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
-/**
- * Expands MDAT readme comments in one or more Markdown files
- * Searches up for a readme.md file if none is provided.
- * @see `findReadme()` for more details on the search process.
- */
-export declare function expandReadmeFiles(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
-/**
- * Expands MDAT readme comments in a Markdown string
- */
-export declare function expandReadmeString(markdown: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
-/**
- * Checks and validates MDAT readme comments in the closest readme.md file
- * Basically an alias to `checkReadmeFiles()` with certain arguments elided.
- * @see `findReadme()` for more details on the search process.
- */
-export declare function checkReadme(config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
-/**
- * Checks and validates MDAT readme comments in one or more Markdown files
- * Searches up for a readme.md file if none is provided.
- * @see `findReadme()` for more details on the search process.
- */
-export declare function checkReadmeFiles(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
-/**
- * Checks and validates MDAT readme comments in a Markdown string
- */
-export declare function checkReadmeString(markdown: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
-/**
- * Collapses MDAT readme comments in the closest readme.md file
- * Basically an alias to `collapseReadmeFiles()` with certain arguments elided.
- * @see `findReadme()` for more details on the search process.
- */
-export declare function collapseReadme(config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
-/**
- * Collapses MDAT readme comments in one or more Markdown files
- * Searches up for a readme.md file if none is provided.
- * @see `findReadme()` for more details on the search process.
- */
-export declare function collapseReadmeFiles(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;

package/dist/readme/config.d.ts

@@ -1,14 +0,0 @@
-import type { Simplify } from 'type-fest';
-import type { ConfigLoaded } from '../config';
-import { loadConfig } from '../config';
-type ReadmeConfigLoaded = Simplify<ConfigLoaded & {
-    packageFile: string;
-}>;
-type LoadConfigOptions = Parameters<typeof loadConfig>[0];
-/**
- * Convenience loader to always include the default readme config.
- * The readme defaults should have lower priority than searched/user config,
- * but higher priority than base mdat defaults.
- */
-export declare function loadConfigReadme(options?: LoadConfigOptions): Promise<ReadmeConfigLoaded>;
-export {};

package/dist/readme/init.d.ts

@@ -1,18 +0,0 @@
-type MdatReadmeInitOptions = {
-    compound: boolean;
-    expand: boolean;
-    output: string;
-    overwrite: boolean;
-    template: string;
-};
-/**
- * Initializes a new readme file interactively.
- * @returns Path to the created readme file.
- */
-export declare function initReadmeInteractive(): Promise<string>;
-/**
- * Creates a new readme file with the given options.
- * @returns Path to the created readme file.
- */
-export declare function initReadme(options?: Partial<MdatReadmeInitOptions>): Promise<string>;
-export {};

package/dist/readme/rules/badges.d.ts

@@ -1,7 +0,0 @@
-declare const _default: {
-    badges: {
-        content(options?: import("type-fest").JsonValue | undefined): Promise<string>;
-        order: number;
-    };
-};
-export default _default;

package/dist/readme/rules/banner.d.ts

@@ -1,7 +0,0 @@
-declare const _default: {
-    banner: {
-        content(options?: import("type-fest").JsonValue | undefined): Promise<string>;
-        order: number;
-    };
-};
-export default _default;

package/dist/readme/rules/code.d.ts

@@ -1,6 +0,0 @@
-declare const _default: {
-    code: {
-        content(options: import("type-fest").JsonValue): Promise<string>;
-    };
-};
-export default _default;

package/dist/readme/rules/contributing.d.ts

@@ -1,7 +0,0 @@
-declare const _default: {
-    contributing: {
-        content(): Promise<string>;
-        order: number;
-    };
-};
-export default _default;

package/dist/readme/rules/description.d.ts

@@ -1,10 +0,0 @@
-/**
- * Simple alias for short-description
- */
-declare const _default: {
-    description: {
-        content(): Promise<string>;
-        order: number;
-    };
-};
-export default _default;

package/dist/readme/rules/footer.d.ts

@@ -1,10 +0,0 @@
-declare const _default: {
-    footer: {
-        content: {
-            content(): Promise<string>;
-            order: number;
-        }[];
-        order: number;
-    };
-};
-export default _default;

package/dist/readme/rules/header.d.ts

@@ -1,11 +0,0 @@
-declare const _default: {
-    header: {
-        applicationOrder: number;
-        content: {
-            content(options?: import("type-fest").JsonValue | undefined): Promise<string>;
-            order: number;
-        }[];
-        order: number;
-    };
-};
-export default _default;

package/dist/readme/rules/index.d.ts

@@ -1,66 +0,0 @@
-declare const _default: {
-    toc: {
-        applicationOrder: number;
-        content(options: import("type-fest").JsonValue, tree: import("mdast").Root): Promise<string>;
-        order: number;
-    };
-    title: {
-        applicationOrder: number;
-        content(options?: import("type-fest").JsonValue | undefined): Promise<string>;
-        order: number;
-    };
-    'table-of-contents': {
-        applicationOrder: number;
-        content(options: import("type-fest").JsonValue, tree: import("mdast").Root): Promise<string>;
-        order: number;
-    };
-    'size-table': {
-        content(options: import("type-fest").JsonValue): Promise<string>;
-    };
-    size: {
-        content(options: import("type-fest").JsonValue): Promise<string>;
-    };
-    'short-description': {
-        content(): Promise<string>;
-        order: number;
-    };
-    license: {
-        content(): Promise<string>;
-        order: number;
-    };
-    header: {
-        applicationOrder: number;
-        content: {
-            content(options?: import("type-fest").JsonValue | undefined): Promise<string>;
-            order: number;
-        }[];
-        order: number;
-    };
-    footer: {
-        content: {
-            content(): Promise<string>;
-            order: number;
-        }[];
-        order: number;
-    };
-    description: {
-        content(): Promise<string>;
-        order: number;
-    };
-    contributing: {
-        content(): Promise<string>;
-        order: number;
-    };
-    code: {
-        content(options: import("type-fest").JsonValue): Promise<string>;
-    };
-    banner: {
-        content(options?: import("type-fest").JsonValue | undefined): Promise<string>;
-        order: number;
-    };
-    badges: {
-        content(options?: import("type-fest").JsonValue | undefined): Promise<string>;
-        order: number;
-    };
-};
-export default _default;

package/dist/readme/rules/license.d.ts

@@ -1,7 +0,0 @@
-declare const _default: {
-    license: {
-        content(): Promise<string>;
-        order: number;
-    };
-};
-export default _default;

package/dist/readme/rules/short-description.d.ts

@@ -1,12 +0,0 @@
-/**
- * Simple alias for `description` rule, to match nomenclature in
- * [standard-readme](https://github.com/RichardLitt/standard-readme/blob/main/spec.md#short-description)
- * spec.
- */
-declare const _default: {
-    'short-description': {
-        content(): Promise<string>;
-        order: number;
-    };
-};
-export default _default;

package/dist/readme/rules/size-table.d.ts

@@ -1,6 +0,0 @@
-declare const _default: {
-    'size-table': {
-        content(options: import("type-fest").JsonValue): Promise<string>;
-    };
-};
-export default _default;

package/dist/readme/rules/size.d.ts

@@ -1,6 +0,0 @@
-declare const _default: {
-    size: {
-        content(options: import("type-fest").JsonValue): Promise<string>;
-    };
-};
-export default _default;

package/dist/readme/rules/table-of-contents.d.ts

@@ -1,9 +0,0 @@
-import type { Root } from 'mdast';
-declare const _default: {
-    'table-of-contents': {
-        applicationOrder: number;
-        content(options: import("type-fest").JsonValue, tree: Root): Promise<string>;
-        order: number;
-    };
-};
-export default _default;

package/dist/readme/rules/title.d.ts

@@ -1,8 +0,0 @@
-declare const _default: {
-    title: {
-        applicationOrder: number;
-        content(options?: import("type-fest").JsonValue | undefined): Promise<string>;
-        order: number;
-    };
-};
-export default _default;

package/dist/readme/rules/toc.d.ts

@@ -1,11 +0,0 @@
-/**
- * Simple alias for table-of-contents
- */
-declare const _default: {
-    toc: {
-        applicationOrder: number;
-        content(options: import("type-fest").JsonValue, tree: import("mdast").Root): Promise<string>;
-        order: number;
-    };
-};
-export default _default;

package/dist/readme/rules/utilities/size/size-report.d.ts

@@ -1,19 +0,0 @@
-type SizeInfo = {
-    bytes: number;
-    bytesPretty: string;
-    percent: number;
-    percentPretty: string;
-};
-export type SizeReport = {
-    brotli: SizeInfo;
-    gzip: SizeInfo;
-    original: SizeInfo;
-};
-/**
- * Analyzes a file's size and its compressed sizes using Brotli and Gzip
- * @param filePath - Path to the file to analyze
- * @returns Promise containing detailed size report
- * @throws {Error} if file cannot be read or compressed
- */
-export declare function createSizeReport(filePath: string): Promise<SizeReport>;
-export {};

package/dist/readme/templates/index.d.ts

@@ -1,27 +0,0 @@
-declare const _default: {
-    'MDAT Readme': {
-        content: {
-            compound: string;
-            explicit: string;
-        };
-        description: string;
-        exampleLink: "https://github.com/kitschpatrol/mdat/blob/main/readme.md";
-    };
-    'Standard Readme Basic': {
-        content: {
-            compound: string;
-            explicit: string;
-        };
-        description: string;
-        exampleLink: "https://github.com/RichardLitt/standard-readme/blob/main/example-readmes/minimal-readme.md";
-    };
-    'Standard Readme Full': {
-        content: {
-            compound: string;
-            explicit: string;
-        };
-        description: string;
-        exampleLink: "https://github.com/RichardLitt/standard-readme/blob/main/example-readmes/maximal-readme.md";
-    };
-};
-export default _default;

package/dist/readme/utilities.d.ts

@@ -1,15 +0,0 @@
-/**
- * Searches for a readme file in the following order:
- * 1. Searches the current working directly for readme.md
- * 2. If there's no readme.md in the current directory, search up to the closest package directory
- * 3. Give up and return undefined if no readme is found
- * @returns The path to the readme file or undefined if not found
- */
-export declare function findReadme(): Promise<string | undefined>;
-/**
- * Searches up for a readme.md file
- * @see `findReadme()` for more details on the search process.
- * @returns The path to the readme file
- * @throws {Error} if no readme is found
- */
-export declare function findReadmeThrows(): Promise<string>;

package/dist/utilities.d.ts

@@ -1,10 +0,0 @@
-import type { ConfigResult as AmbientRemarkConfig } from 'unified-engine';
-export { type ConfigResult as AmbientRemarkConfig } from 'unified-engine';
-export declare function getInputOutputPaths(inputs: string[], output: string | undefined, name: string | undefined, extension: string | undefined): Array<{
-    input: string;
-    name: string;
-    output: string;
-}>;
-export declare function findPackage(): Promise<string | undefined>;
-export declare function ensureArray<T>(value: T | T[] | undefined): T[];
-export declare function loadAmbientRemarkConfig(): Promise<AmbientRemarkConfig>;