@batijs/core 0.0.288 → 0.0.289

package/dist/index.d.ts

@@ -1,7 +1,10 @@
-import { BatiSet } from '@batijs/features';
+import { BatiSet, CategoryLabels, Flags } from '@batijs/features';
 import * as yaml from 'yaml';
 import { ParseOptions, DocumentOptions, SchemaOptions, Document } from 'yaml';
 export { Document as YAMLDocument } from 'yaml';
+import * as mdast from 'mdast';
+import { Nodes, Parents, Root } from 'mdast';
+import * as attributes_parser from 'attributes-parser';
 import { ProxifiedModule } from 'magicast';
 export { builders, generateCode, loadFile, parseModule } from 'magicast';
 export { addVitePlugin, deepMergeObject } from 'magicast/helpers';
@@ -43,6 +46,56 @@ declare function formatCode(code: string, options: {
     filepath: string;
 }): Promise<string>;
 
+/**
+ * Parse a comment marker.
+ *
+ */
+declare function commentMarker(value: Nodes): {
+    name: string;
+    suffix: string;
+    attributes: string;
+    parameters: attributes_parser.Attributes;
+    node: mdast.Html;
+} | undefined;
+
+type MarkdownPosition = "before" | "after" | "replace";
+type Sections = "document" | "intro" | "features" | "TOC";
+type FilterHandler = (info: ReturnType<typeof commentMarker>) => boolean;
+type FilterObject = {
+    section?: Sections;
+    category?: CategoryLabels;
+    flag?: Flags;
+    [key: string]: undefined | string | number | boolean;
+};
+type WrapperObject = FilterObject & {
+    name?: string;
+};
+type MarkdownOptions = {
+    filter?: FilterObject | FilterHandler;
+    position?: MarkdownPosition;
+    wrapper?: WrapperObject;
+};
+type classConfig = {
+    defaults?: MarkdownOptions;
+};
+type Info = {
+    parent: Parents;
+    start: number;
+    end: number;
+};
+type ZoneHandler = (start: Nodes, between: Nodes[], end: Nodes, info: Info) => Nodes[] | null | undefined | void;
+
+declare function parseMarkdown(text: string, defaults?: MarkdownOptions): MarkdownV2;
+declare class MarkdownV2 implements StringTransformer {
+    private tree;
+    private contents;
+    private config;
+    constructor(tree: Root, config?: classConfig);
+    addMarkdownFeature(markdown: string | ZoneHandler, flag: Flags): void;
+    addMarkdown(markdown: string | ZoneHandler, options?: MarkdownOptions): void;
+    finalize(): string;
+}
+
 declare function h1(text: string): string;
 declare function h2(text: string): string;
 declare function h3(text: string): string;
@@ -122,6 +175,7 @@ declare class PackageJsonTransformer<U extends PackageJsonDeps> implements Strin
 }
 
 declare function loadReadme({ readfile }: TransformerProps): Promise<Readme>;
+declare function loadMarkdown({ readfile }: TransformerProps): Promise<MarkdownV2>;
 declare function loadAsJson({ readfile, source, target }: TransformerProps): Promise<any>;
 declare function loadPackageJson<U extends PackageJsonDeps>({ readfile, source, target }: TransformerProps, scopedPackageJson: U): Promise<PackageJsonTransformer<U>>;
 declare function loadAsMagicast<Exports extends object>({ readfile, source, target, }: TransformerProps): Promise<ProxifiedModule<Exports>>;
@@ -142,4 +196,4 @@ declare function getVersion(): {
     semver: string[];
 };
 
-export { type ContentGetter, type FileContext, Readme, type StringTransformer, type Transformer, type TransformerProps, type VikeMeta, appendToEnv, formatCode, getArgs, getVersion, loadAsJson, loadAsMagicast, loadPackageJson, loadReadme, loadRelativeFileAsMagicast, loadYaml, markdown, packageManager, parseReadme, transformAndFormat, withIcon };
+export { type ContentGetter, type FileContext, MarkdownV2, Readme, type StringTransformer, type Transformer, type TransformerProps, type VikeMeta, appendToEnv, formatCode, getArgs, getVersion, loadAsJson, loadAsMagicast, loadMarkdown, loadPackageJson, loadReadme, loadRelativeFileAsMagicast, loadYaml, markdown, packageManager, parseMarkdown, parseReadme, transformAndFormat, withIcon };