@batijs/core 0.0.287 → 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';
@@ -28,6 +31,9 @@ type TransformerProps = {
     meta: VikeMeta;
 };
 type Transformer = (props: TransformerProps) => unknown;
+interface StringTransformer {
+    finalize(): string;
+}
 
 declare function transformAndFormat(code: string, meta: VikeMeta, options: {
     filepath: string;
@@ -40,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;
@@ -68,37 +124,63 @@ declare const markdown: {
     italic: typeof italic;
 };
 
-declare function loadReadme({ readfile }: TransformerProps): Promise<Readme>;
-declare function loadAsJson({ readfile, source, target }: TransformerProps): Promise<any>;
-declare function loadAsMagicast<Exports extends object>({ readfile, source, target, }: TransformerProps): Promise<ProxifiedModule<Exports>>;
-declare function loadRelativeFileAsMagicast<Exports extends object>(relativePath: string, meta: Pick<ImportMeta, "url">): Promise<ProxifiedModule<Exports>>;
-declare function loadYaml({ readfile, source, target }: TransformerProps, options?: ParseOptions & DocumentOptions & SchemaOptions): Promise<Document.Parsed<yaml.Alias.Parsed, true> | Document.Parsed<yaml.Scalar.Parsed, true> | Document.Parsed<yaml.YAMLMap.Parsed<yaml.ParsedNode, yaml.ParsedNode | null>, true> | Document.Parsed<yaml.YAMLSeq.Parsed<yaml.ParsedNode>, true>>;
-
-declare const keys: readonly ["dev", "build", "preview", "lint", "format", "deploy", "test"];
-type Scripts = (typeof keys)[number];
-type ValidScripts = Scripts | `${Scripts}:${string}`;
 interface PackageJsonDeps {
     dependencies?: Record<string, string>;
     devDependencies?: Record<string, string>;
 }
 interface PackageJsonScripts {
-    scripts: Partial<Record<ValidScripts, string>>;
+    scripts?: Record<string, string>;
 }
 interface PackageJsonScriptOption {
-    value?: string;
+    value: string;
     /**
      * Higher values have priority
      */
     precedence: number;
     warnIfReplaced?: boolean;
 }
-type PackageJsonScriptOptions = Partial<Record<ValidScripts, PackageJsonScriptOption>>;
-declare function addDependency<T extends PackageJsonDeps, U extends PackageJsonDeps>(packageJson: T, scopedPackageJson: U, keys: {
-    devDependencies?: (keyof U["dependencies"] | keyof U["devDependencies"])[];
-    dependencies?: (keyof U["dependencies"] | keyof U["devDependencies"])[];
-}): T;
-declare function removeDependency<T extends PackageJsonDeps>(packageJson: T, key: string): T;
-declare function setScripts<T extends PackageJsonScripts>(packageJson: T, scripts: PackageJsonScriptOptions): T;
+type PackageJsonScriptOptions = Record<string, {
+    value?: string;
+    precedence: number;
+    warnIfReplaced?: boolean;
+}>;
+type AllDependencies<U extends PackageJsonDeps> = keyof U["dependencies"] | keyof U["devDependencies"];
+declare class PackageJsonTransformer<U extends PackageJsonDeps> implements StringTransformer {
+    protected static previousScripts: PackageJsonScriptOptions;
+    protected static forcedDependencies: Set<string>;
+    protected static dependenciesScriptsRelation: Map<string | symbol | number, Set<string>>;
+    protected pendingAddedDependencies: string[];
+    protected pendingReplacedScripts: string[];
+    protected packageJson: PackageJsonScripts & PackageJsonDeps;
+    protected scopedPackageJson: U;
+    constructor(packageJson: PackageJsonScripts & PackageJsonDeps, scopedPackageJson: U);
+    setScript(name: string, args: PackageJsonScriptOption, condition?: boolean): this;
+    removeScript(name: string, condition?: boolean): this;
+    addDependencies(newDeps: AllDependencies<U>[], condition?: boolean): this;
+    addDependencies(newDeps: AllDependencies<U>[], onlyUsedBy?: string[], condition?: boolean): this;
+    addDevDependencies(newDeps: AllDependencies<U>[], condition?: boolean): this;
+    addDevDependencies(newDeps: AllDependencies<U>[], onlyUsedBy?: string[], condition?: boolean): this;
+    finalize(): string;
+    /**
+     * For tests purpose only
+     * @internal
+     */
+    static clear(): void;
+    private _onlyUsedBy;
+    private _addDependencies;
+    /**
+     * Instead of removing a previously added dep, use `onlyUsedBy` parameter when adding a dependency
+     */
+    private removeDependency;
+}
+
+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>>;
+declare function loadRelativeFileAsMagicast<Exports extends object>(relativePath: string, meta: Pick<ImportMeta, "url">): Promise<ProxifiedModule<Exports>>;
+declare function loadYaml({ readfile, source, target }: TransformerProps, options?: ParseOptions & DocumentOptions & SchemaOptions): Promise<Document.Parsed<yaml.Alias.Parsed, true> | Document.Parsed<yaml.Scalar.Parsed, true> | Document.Parsed<yaml.YAMLMap.Parsed<yaml.ParsedNode, yaml.ParsedNode | null>, true> | Document.Parsed<yaml.YAMLSeq.Parsed<yaml.ParsedNode>, true>>;
 
 declare function appendToEnv(envContent: string | undefined | null, key: string, value: unknown, comment?: string): string;
 
@@ -114,4 +196,4 @@ declare function getVersion(): {
     semver: string[];
 };
 
-export { type ContentGetter, type FileContext, type PackageJsonDeps, type PackageJsonScriptOption, type PackageJsonScriptOptions, type PackageJsonScripts, Readme, type Transformer, type TransformerProps, type VikeMeta, addDependency, appendToEnv, formatCode, getArgs, getVersion, loadAsJson, loadAsMagicast, loadReadme, loadRelativeFileAsMagicast, loadYaml, markdown, packageManager, parseReadme, removeDependency, setScripts, 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 };