docrev 0.8.1 → 0.9.0

package/dist/lib/build.d.ts

@@ -0,0 +1,171 @@
+/**
+ * Build system - combines sections → paper.md → PDF/DOCX/TEX
+ *
+ * Features:
+ * - Reads rev.yaml config
+ * - Combines section files into paper.md (persisted)
+ * - Strips annotations appropriately per output format
+ * - Runs pandoc with crossref filter
+ */
+import type { Author } from './types.js';
+export interface CrossrefConfig {
+    figureTitle?: string;
+    tableTitle?: string;
+    figPrefix?: string | string[];
+    tblPrefix?: string | string[];
+    secPrefix?: string | string[];
+    linkReferences?: boolean;
+}
+export interface PdfConfig {
+    template?: string | null;
+    documentclass?: string;
+    fontsize?: string;
+    geometry?: string;
+    linestretch?: number;
+    numbersections?: boolean;
+    toc?: boolean;
+}
+export interface DocxConfig {
+    reference?: string | null;
+    keepComments?: boolean;
+    toc?: boolean;
+}
+export interface TexConfig {
+    standalone?: boolean;
+}
+export interface BeamerConfig {
+    theme?: string;
+    colortheme?: string | null;
+    fonttheme?: string | null;
+    aspectratio?: string | null;
+    navigation?: string | null;
+    section?: boolean;
+    notes?: string | false;
+    fit_images?: boolean;
+}
+export interface PptxConfig {
+    theme?: string;
+    reference?: string | null;
+    media?: string | null;
+    colors?: {
+        default?: string;
+        title?: string;
+    };
+    buildup?: {
+        grey?: string;
+        accent?: string;
+        enabled?: boolean;
+    };
+}
+export interface TablesConfig {
+    nowrap?: string[];
+}
+export interface PostprocessConfig {
+    pdf?: string | null;
+    docx?: string | null;
+    tex?: string | null;
+    pptx?: string | null;
+    beamer?: string | null;
+    all?: string | null;
+    [key: string]: string | null | undefined;
+}
+export interface BuildConfig {
+    title: string;
+    authors: (string | Author)[];
+    sections: string[];
+    bibliography: string | null;
+    csl: string | null;
+    crossref: CrossrefConfig;
+    pdf: PdfConfig;
+    docx: DocxConfig;
+    tex: TexConfig;
+    beamer: BeamerConfig;
+    pptx: PptxConfig;
+    tables: TablesConfig;
+    postprocess: PostprocessConfig;
+    _configPath?: string | null;
+}
+export interface BuildResult {
+    format: string;
+    success: boolean;
+    outputPath?: string;
+    error?: string;
+}
+interface BuildOptions {
+    verbose?: boolean;
+    config?: BuildConfig;
+    outputPath?: string;
+    crossref?: boolean;
+    _refsAutoInjected?: boolean;
+    _forwardRefsResolved?: number;
+}
+interface CombineOptions extends BuildOptions {
+    _refsAutoInjected?: boolean;
+}
+interface PandocResult {
+    outputPath: string;
+    success: boolean;
+    error?: string;
+}
+interface FullBuildResult {
+    results: BuildResult[];
+    paperPath: string;
+    warnings: string[];
+    forwardRefsResolved: number;
+    refsAutoInjected?: boolean;
+}
+/**
+ * Default rev.yaml configuration
+ */
+export declare const DEFAULT_CONFIG: BuildConfig;
+/**
+ * Load rev.yaml config from directory
+ * @param directory - Project directory path
+ * @returns Merged config with defaults
+ * @throws {TypeError} If directory is not a string
+ * @throws {Error} If rev.yaml exists but cannot be parsed
+ */
+export declare function loadConfig(directory: string): BuildConfig;
+/**
+ * Find section files in directory
+ * @param directory - Project directory path
+ * @param configSections - Sections from rev.yaml (optional)
+ * @returns Ordered list of section file names
+ * @throws {TypeError} If directory is not a string
+ */
+export declare function findSections(directory: string, configSections?: string[]): string[];
+/**
+ * Combine section files into paper.md
+ */
+export declare function combineSections(directory: string, config: BuildConfig, options?: CombineOptions): string;
+/**
+ * Process markdown tables to apply nowrap formatting to specified columns.
+ * Converts distribution notation (Normal, Student-t, Gamma) to LaTeX math.
+ * @param content - Markdown content
+ * @param tablesConfig - tables config from rev.yaml
+ * @param format - output format (pdf, docx, etc.)
+ * @returns processed content
+ */
+export declare function processTablesForFormat(content: string, tablesConfig: TablesConfig, format: string): string;
+/**
+ * Prepare paper.md for specific output format
+ */
+export declare function prepareForFormat(paperPath: string, format: string, config: BuildConfig, options?: BuildOptions): string;
+/**
+ * Build pandoc arguments for format
+ */
+export declare function buildPandocArgs(format: string, config: BuildConfig, outputPath: string): string[];
+/**
+ * Run pandoc build
+ */
+export declare function runPandoc(inputPath: string, format: string, config: BuildConfig, options?: BuildOptions): Promise<PandocResult>;
+/**
+ * Full build pipeline
+ */
+export declare function build(directory: string, formats?: string[], options?: BuildOptions): Promise<FullBuildResult>;
+/**
+ * Get build status summary
+ */
+export declare function formatBuildResults(results: BuildResult[]): string;
+export {};
+//# sourceMappingURL=build.d.ts.map

package/dist/lib/build.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../lib/build.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAeH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAgBzC,MAAM,WAAW,cAAc;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,SAAS;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IACvB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;CACH;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CAC1C;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC7B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,QAAQ,EAAE,cAAc,CAAC;IACzB,GAAG,EAAE,SAAS,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,GAAG,EAAE,SAAS,CAAC;IACf,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,EAAE,iBAAiB,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,YAAY;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,UAAU,cAAe,SAAQ,YAAY;IAC3C,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAMD,UAAU,YAAY;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,eAAe;IACvB,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAsBD;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,WA4D5B,CAAC;AAMF;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW,CAmCzD;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,GAAE,MAAM,EAAO,GAAG,MAAM,EAAE,CAgDvF;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,GAAE,cAAmB,GAAG,MAAM,CAuF5G;AAoCD;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CA0F1G;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,OAAO,GAAE,YAAiB,GACzB,MAAM,CAmCR;AAuBD;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAiGjG;AAwBD;;GAEG;AACH,wBAAsB,SAAS,CAC7B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,OAAO,GAAE,YAAiB,GACzB,OAAO,CAAC,YAAY,CAAC,CAiJvB;AAED;;GAEG;AACH,wBAAsB,KAAK,CACzB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,MAAM,EAAoB,EACnC,OAAO,GAAE,YAAiB,GACzB,OAAO,CAAC,eAAe,CAAC,CAgE1B;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,MAAM,CAYjE"}