docrev 0.8.1 → 0.8.5

package/dist/lib/templates.js

@@ -0,0 +1,504 @@
+/**
+ * Built-in templates for project scaffolding
+ *
+ * Used by `rev new` command to create new paper projects
+ */
+export const TEMPLATES = {
+    /**
+     * Standard academic paper structure
+     */
+    paper: {
+        name: 'Academic Paper',
+        description: 'Standard paper with introduction, methods, results, discussion',
+        files: {
+            'rev.yaml': `# Paper configuration
+title: "Your Paper Title"
+authors:
+  - name: First Author
+    affiliation: Institution
+    email: author@example.com
+
+# Section files in order
+sections:
+  - introduction.md
+  - methods.md
+  - results.md
+  - discussion.md
+
+# Bibliography (optional)
+bibliography: references.bib
+csl: null  # uses default CSL
+
+# Cross-reference settings
+crossref:
+  figureTitle: Figure
+  tableTitle: Table
+  figPrefix: [Fig., Figs.]
+  tblPrefix: [Table, Tables]
+  linkReferences: true
+
+# PDF output settings
+pdf:
+  documentclass: article
+  fontsize: 12pt
+  geometry: margin=1in
+  linestretch: 1.5
+  numbersections: false
+
+# Word output settings
+docx:
+  reference: null  # path to reference.docx template
+  keepComments: true
+`,
+            'introduction.md': `# Introduction
+
+Your introduction goes here. Use dynamic figure references like @fig:example.
+
+`,
+            'methods.md': `# Methods
+
+## Study Design
+
+Describe your methodology here.
+
+## Data Analysis
+
+Reference tables with @tbl:summary.
+
+`,
+            'results.md': `# Results
+
+Present your findings. See @fig:results for the main analysis.
+
+![Example figure caption](figures/placeholder.png){#fig:results}
+
+`,
+            'discussion.md': `# Discussion
+
+Interpret your results here.
+
+## Conclusions
+
+Summarize key findings.
+
+`,
+            'references.bib': `@article{example2024,
+  author = {Author, A. and Coauthor, B.},
+  title = {An Example Paper Title},
+  journal = {Journal Name},
+  year = {2024},
+  volume = {1},
+  pages = {1--10}
+}
+`,
+            '.gitignore': `# Build outputs
+*.pdf
+*.docx
+*.tex
+paper.md
+.paper-*.md
+
+# System
+.DS_Store
+`,
+        },
+        directories: ['figures'],
+    },
+    /**
+     * Minimal single-section document
+     */
+    minimal: {
+        name: 'Minimal',
+        description: 'Single document with basic config',
+        files: {
+            'rev.yaml': `title: "Document Title"
+authors: []
+sections:
+  - content.md
+`,
+            'content.md': `# Your Document
+
+Write your content here.
+
+`,
+        },
+        directories: [],
+    },
+    /**
+     * Thesis chapter structure
+     */
+    thesis: {
+        name: 'Thesis Chapter',
+        description: 'Thesis-style with abstract, sections, appendix',
+        files: {
+            'rev.yaml': `title: "Chapter Title"
+authors:
+  - name: Your Name
+    affiliation: University
+
+sections:
+  - abstract.md
+  - introduction.md
+  - literature.md
+  - methods.md
+  - results.md
+  - discussion.md
+  - conclusion.md
+  - appendix.md
+
+bibliography: references.bib
+
+pdf:
+  documentclass: report
+  fontsize: 11pt
+  geometry: "margin=1in"
+  linestretch: 2
+  numbersections: true
+`,
+            'abstract.md': `# Abstract
+
+Brief summary of the chapter (150-300 words).
+
+`,
+            'introduction.md': `# Introduction
+
+Background and research questions.
+
+`,
+            'literature.md': `# Literature Review
+
+Review of relevant prior work.
+
+`,
+            'methods.md': `# Materials and Methods
+
+Detailed methodology.
+
+`,
+            'results.md': `# Results
+
+Findings and analysis.
+
+`,
+            'discussion.md': `# Discussion
+
+Interpretation of results.
+
+`,
+            'conclusion.md': `# Conclusion
+
+Summary and implications.
+
+`,
+            'appendix.md': `# Appendix
+
+## Supplementary Materials
+
+Additional details here.
+
+`,
+            'references.bib': ``,
+            '.gitignore': `*.pdf
+*.docx
+*.tex
+paper.md
+.paper-*.md
+.DS_Store
+`,
+        },
+        directories: ['figures', 'tables'],
+    },
+    /**
+     * LaTeX-focused project with direct .tex output
+     */
+    latex: {
+        name: 'LaTeX Project',
+        description: 'LaTeX-native with journal template support',
+        files: {
+            'rev.yaml': `# LaTeX Paper Configuration
+title: "Paper Title"
+authors:
+  - name: First Author
+    affiliation: University
+    email: author@example.edu
+    orcid: 0000-0000-0000-0000
+
+sections:
+  - introduction.md
+  - methods.md
+  - results.md
+  - discussion.md
+
+bibliography: references.bib
+csl: null
+
+# LaTeX-specific settings
+pdf:
+  documentclass: article
+  classoption: [11pt, a4paper]
+  fontsize: 11pt
+  geometry: "margin=2.5cm"
+  linestretch: 1.5
+  numbersections: true
+  header-includes: |
+    \\usepackage{amsmath}
+    \\usepackage{graphicx}
+    \\usepackage{booktabs}
+    \\usepackage{hyperref}
+    \\usepackage{natbib}
+
+# TEX output settings
+tex:
+  standalone: true
+  keep-tex: true
+`,
+            'introduction.md': `# Introduction
+
+Background and motivation.
+
+## Objectives
+
+State your research questions.
+
+`,
+            'methods.md': `# Materials and Methods
+
+## Study Area
+
+Describe the study area or data sources.
+
+## Statistical Analysis
+
+All analyses were performed in R [@R2024].
+
+`,
+            'results.md': `# Results
+
+Main findings presented here.
+
+![Caption for figure](figures/fig1.pdf){#fig:main width=100%}
+
+See @fig:main for the main results.
+
+| Variable | Value | SE |
+|----------|-------|------|
+| A | 1.23 | 0.05 |
+| B | 4.56 | 0.12 |
+
+: Summary statistics {#tbl:summary}
+
+`,
+            'discussion.md': `# Discussion
+
+Interpretation of findings.
+
+## Limitations
+
+Study limitations.
+
+## Conclusions
+
+Key takeaways.
+
+`,
+            'references.bib': `@Manual{R2024,
+  title = {R: A Language and Environment for Statistical Computing},
+  author = {{R Core Team}},
+  organization = {R Foundation for Statistical Computing},
+  address = {Vienna, Austria},
+  year = {2024},
+  url = {https://www.R-project.org/}
+}
+`,
+            '.gitignore': `# Build outputs
+*.pdf
+*.docx
+paper.md
+.paper-*.md
+
+# Keep .tex for version control
+# *.tex
+
+# LaTeX auxiliary files
+*.aux
+*.bbl
+*.blg
+*.log
+*.out
+*.toc
+*.fdb_latexmk
+*.fls
+*.synctex.gz
+
+# System
+.DS_Store
+`,
+        },
+        directories: ['figures', 'tables'],
+    },
+    /**
+     * Review article structure
+     */
+    review: {
+        name: 'Review Article',
+        description: 'Literature review or synthesis paper',
+        files: {
+            'rev.yaml': `title: "Review Title"
+authors:
+  - name: Author Name
+    affiliation: Institution
+
+sections:
+  - introduction.md
+  - section1.md
+  - section2.md
+  - section3.md
+  - synthesis.md
+  - conclusion.md
+
+bibliography: references.bib
+
+crossref:
+  figureTitle: Figure
+  tableTitle: Table
+  figPrefix: [Fig., Figs.]
+  tblPrefix: [Table, Tables]
+`,
+            'introduction.md': `# Introduction
+
+Scope and objectives of the review.
+
+`,
+            'section1.md': `# Theme One
+
+First major theme or topic.
+
+`,
+            'section2.md': `# Theme Two
+
+Second major theme.
+
+`,
+            'section3.md': `# Theme Three
+
+Third major theme.
+
+`,
+            'synthesis.md': `# Synthesis
+
+Integration of themes and emerging patterns.
+
+`,
+            'conclusion.md': `# Conclusion and Future Directions
+
+Key takeaways and research gaps.
+
+`,
+            'references.bib': ``,
+            '.gitignore': `*.pdf
+*.docx
+*.tex
+paper.md
+.paper-*.md
+.DS_Store
+`,
+        },
+        directories: ['figures'],
+    },
+};
+/**
+ * Get template by name
+ */
+export function getTemplate(name) {
+    return TEMPLATES[name.toLowerCase()] || null;
+}
+/**
+ * List available templates
+ */
+export function listTemplates() {
+    return Object.entries(TEMPLATES).map(([id, template]) => ({
+        id,
+        name: template.name,
+        description: template.description,
+    }));
+}
+/**
+ * Convert string to title case for headers
+ */
+function titleCase(str) {
+    return str
+        .split(/[-_\s]+/)
+        .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+        .join(' ');
+}
+/**
+ * Generate a custom template with specified sections
+ */
+export function generateCustomTemplate(sections, baseTemplate) {
+    const base = baseTemplate || TEMPLATES.paper;
+    const files = {};
+    // Generate rev.yaml with custom sections
+    const sectionsList = sections.map((s) => `  - ${s}.md`).join('\n');
+    files['rev.yaml'] = `# Paper configuration
+title: "Your Paper Title"
+authors:
+  - name: First Author
+    affiliation: Institution
+    email: author@example.com
+
+# Section files in order
+sections:
+${sectionsList}
+
+# Bibliography (optional)
+bibliography: references.bib
+csl: null  # uses default CSL
+
+# Cross-reference settings
+crossref:
+  figureTitle: Figure
+  tableTitle: Table
+  figPrefix: [Fig., Figs.]
+  tblPrefix: [Table, Tables]
+  linkReferences: true
+
+# PDF output settings
+pdf:
+  documentclass: article
+  fontsize: 12pt
+  geometry: margin=1in
+  linestretch: 1.5
+  numbersections: false
+
+# Word output settings
+docx:
+  reference: null  # path to reference.docx template
+  keepComments: true
+`;
+    // Generate section files
+    for (const section of sections) {
+        const header = titleCase(section);
+        files[`${section}.md`] = `# ${header}
+
+`;
+    }
+    // Add common files
+    files['references.bib'] = base.files['references.bib'] || '';
+    files['.gitignore'] = base.files['.gitignore'] || `# Build outputs
+*.pdf
+*.docx
+*.tex
+paper.md
+.paper-*.md
+
+# System
+.DS_Store
+`;
+    return {
+        name: 'Custom',
+        description: 'Custom sections',
+        files,
+        directories: base.directories || ['figures'],
+    };
+}
+//# sourceMappingURL=templates.js.map

package/dist/lib/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../lib/templates.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AASH,MAAM,CAAC,MAAM,SAAS,GAAuC;IAC3D;;OAEG;IACH,KAAK,EAAE;QACL,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,gEAAgE;QAC7E,KAAK,EAAE;YACL,UAAU,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsCjB;YACK,iBAAiB,EAAE;;;;CAIxB;YACK,YAAY,EAAE;;;;;;;;;;CAUnB;YACK,YAAY,EAAE;;;;;;CAMnB;YACK,eAAe,EAAE;;;;;;;;CAQtB;YACK,gBAAgB,EAAE;;;;;;;;CAQvB;YACK,YAAY,EAAE;;;;;;;;;CASnB;SACI;QACD,WAAW,EAAE,CAAC,SAAS,CAAC;KACzB;IAED;;OAEG;IACH,OAAO,EAAE;QACP,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,mCAAmC;QAChD,KAAK,EAAE;YACL,UAAU,EAAE;;;;CAIjB;YACK,YAAY,EAAE;;;;CAInB;SACI;QACD,WAAW,EAAE,EAAE;KAChB;IAED;;OAEG;IACH,MAAM,EAAE;QACN,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,gDAAgD;QAC7D,KAAK,EAAE;YACL,UAAU,EAAE;;;;;;;;;;;;;;;;;;;;;;;CAuBjB;YACK,aAAa,EAAE;;;;CAIpB;YACK,iBAAiB,EAAE;;;;CAIxB;YACK,eAAe,EAAE;;;;CAItB;YACK,YAAY,EAAE;;;;CAInB;YACK,YAAY,EAAE;;;;CAInB;YACK,eAAe,EAAE;;;;CAItB;YACK,eAAe,EAAE;;;;CAItB;YACK,aAAa,EAAE;;;;;;CAMpB;YACK,gBAAgB,EAAE,EAAE;YACpB,YAAY,EAAE;;;;;;CAMnB;SACI;QACD,WAAW,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;KACnC;IAED;;OAEG;IACH,KAAK,EAAE;QACL,IAAI,EAAE,eAAe;QACrB,WAAW,EAAE,4CAA4C;QACzD,KAAK,EAAE;YACL,UAAU,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCjB;YACK,iBAAiB,EAAE;;;;;;;;CAQxB;YACK,YAAY,EAAE;;;;;;;;;;CAUnB;YACK,YAAY,EAAE;;;;;;;;;;;;;;;CAenB;YACK,eAAe,EAAE;;;;;;;;;;;;CAYtB;YACK,gBAAgB,EAAE;;;;;;;;CAQvB;YACK,YAAY,EAAE;;;;;;;;;;;;;;;;;;;;;;CAsBnB;SACI;QACD,WAAW,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;KACnC;IAED;;OAEG;IACH,MAAM,EAAE;QACN,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,sCAAsC;QACnD,KAAK,EAAE;YACL,UAAU,EAAE;;;;;;;;;;;;;;;;;;;;CAoBjB;YACK,iBAAiB,EAAE;;;;CAIxB;YACK,aAAa,EAAE;;;;CAIpB;YACK,aAAa,EAAE;;;;CAIpB;YACK,aAAa,EAAE;;;;CAIpB;YACK,cAAc,EAAE;;;;CAIrB;YACK,eAAe,EAAE;;;;CAItB;YACK,gBAAgB,EAAE,EAAE;YACpB,YAAY,EAAE;;;;;;CAMnB;SACI;QACD,WAAW,EAAE,CAAC,SAAS,CAAC;KACzB;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,IAAI,CAAC;AAC/C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;QACxD,EAAE;QACF,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,WAAW,EAAE,QAAQ,CAAC,WAAW;KAClC,CAAC,CAAC,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAS,SAAS,CAAC,GAAW;IAC5B,OAAO,GAAG;SACP,KAAK,CAAC,SAAS,CAAC;SAChB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC3D,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CACpC,QAAkB,EAClB,YAAiC;IAEjC,MAAM,IAAI,GAAG,YAAY,IAAI,SAAS,CAAC,KAAK,CAAC;IAC7C,MAAM,KAAK,GAA2B,EAAE,CAAC;IAEzC,yCAAyC;IACzC,MAAM,YAAY,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnE,KAAK,CAAC,UAAU,CAAC,GAAG;;;;;;;;;EASpB,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;CA0Bb,CAAC;IAEA,yBAAyB;IACzB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;QAClC,KAAK,CAAC,GAAG,OAAO,KAAK,CAAC,GAAG,KAAK,MAAM;;CAEvC,CAAC;IACA,CAAC;IAED,mBAAmB;IACnB,KAAK,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;IAC7D,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI;;;;;;;;;CASnD,CAAC;IAEA,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,iBAAiB;QAC9B,KAAK;QACL,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC;KAC7C,CAAC;AACJ,CAAC"}

package/dist/lib/themes.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Slide Themes for Beamer and PPTX
+ *
+ * 20 professionally designed themes based on modern design principles:
+ * - Bold, confident typography (2025-2026 trend)
+ * - Curated color palettes (monochrome, earth tones, neo-mint, dark mode)
+ * - Clean sans-serif fonts for readability
+ * - Consistent visual hierarchy
+ *
+ * Each theme includes:
+ * - Primary, secondary, accent colors
+ * - Background and text colors
+ * - Font recommendations
+ * - Beamer configuration
+ */
+/**
+ * Theme colors
+ */
+interface ThemeColors {
+    primary: string;
+    secondary: string;
+    accent: string;
+    background: string;
+    backgroundDark: string;
+    text: string;
+    textLight: string;
+}
+/**
+ * Theme fonts
+ */
+interface ThemeFonts {
+    heading: string;
+    body: string;
+    mono: string;
+}
+/**
+ * Beamer settings
+ */
+interface BeamerSettings {
+    theme: string;
+    colortheme: string | null;
+    fonttheme: string | null;
+}
+/**
+ * Complete theme definition
+ */
+interface Theme {
+    name: string;
+    displayName: string;
+    description: string;
+    colors: ThemeColors;
+    fonts: ThemeFonts;
+    beamer: BeamerSettings;
+}
+export declare const THEMES: Record<string, Theme>;
+/**
+ * Get theme by name
+ */
+export declare function getTheme(name: string): Theme | null;
+/**
+ * Get all theme names
+ */
+export declare function getThemeNames(): string[];
+/**
+ * Get themes by category
+ */
+export declare function getThemesByCategory(category: string): Theme[];
+/**
+ * Generate Beamer color definitions for a theme
+ */
+export declare function generateBeamerColors(theme: Theme): string;
+/**
+ * Generate CSS for PPTX reference doc
+ */
+export declare function generatePptxCSS(theme: Theme): string;
+/**
+ * Format theme info for display
+ */
+export declare function formatThemeInfo(theme: Theme): string;
+/**
+ * List all themes with descriptions
+ */
+export declare function listThemes(): string;
+export {};
+//# sourceMappingURL=themes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"themes.d.ts","sourceRoot":"","sources":["../../lib/themes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;GAEG;AACH,UAAU,WAAW;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,UAAU,UAAU;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,UAAU,cAAc;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,UAAU,KAAK;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,WAAW,CAAC;IACpB,KAAK,EAAE,UAAU,CAAC;IAClB,MAAM,EAAE,cAAc,CAAC;CACxB;AAWD,eAAO,MAAM,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAwgBxC,CAAC;AAEF;;GAEG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,CAEnD;AAED;;GAEG;AACH,wBAAgB,aAAa,IAAI,MAAM,EAAE,CAExC;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,EAAE,CAW7D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAsCzD;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAsCpD;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAQpD;AAED;;GAEG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAmBnC"}