brycewang-stanford/Auto-Empirical-Research-Skills / skills/35-bahayonghang-academic-writing-skills/skills/typst-paper
typst-paper
VerifiedTypst academic paper assistant for existing `.typ` paper projects in English or Chinese. Use this skill whenever the user wants to compile, audit, or improve a Typst paper, including format checks, bibliography validation for BibTeX or Hayagriva, grammar/sentence/logic review, expression polishing, translation, title optimization, pseudocode review, algorithm block cleanup, de-AI editing, experiment-section review, table structure validation, three-line table generation, abstract structure diagnosis, or journal adaptation. Trigger even when the user only mentions one Typst file, one bibliography issue, one pseudocode block, one section rewrite, "three-line table", "check abstract", or "reformat for another journal". Also trigger when the user mentions ".typ files", "typst compile error", "typst export", "typst bibliography", `algorithm-figure`, `lovelace`, or `algorithmic` even without saying the word "Typst" explicitly.
scripts/check_format.py
View on GitHub#!/usr/bin/env python3
"""
Typst Format Checker - Validate academic paper formatting
Usage:
uv run python check_format.py main.typ # Basic check
uv run python check_format.py main.typ --strict # Strict mode
uv run python check_format.py main.typ --venue ieee # Venue-specific check
Checks:
- Page settings (margins, paper size)
- Text settings (font, size, language)
- Heading numbering
- Figure and table formatting
- Citation style consistency
- Math equation formatting
"""
import argparse
import re
import sys
from pathlib import Path
class FormatChecker:
"""Check Typst document formatting for academic papers."""
def __init__(self, typ_file: str, strict: bool = False, venue: str = None):
self.typ_file = Path(typ_file)
self.strict = strict
self.venue = venue
self.issues = []
self.warnings = []
self.content = ""
def load_file(self) -> bool:
"""Load the Typst file."""
try:
self.content = self.typ_file.read_text(encoding="utf-8")
return True
except Exception as e:
print(f"[ERROR] Failed to read file: {e}")
return False
def check_page_settings(self):
"""Check page configuration."""
print("\n[CHECK] Page Settings")
# Check paper size
paper_match = re.search(r'#set\s+page\([\s\S]*?paper:\s*"([^"]+)"', self.content)
if paper_match:
paper = paper_match.group(1)
print(f" ✓ Paper size: {paper}")
if self.venue == "ieee" and paper != "us-letter":
self.warnings.append("IEEE typically uses US Letter paper")
else:
self.warnings.append("Paper size not explicitly set")
# Check margins
margin_match = re.search(r"#set\s+page\([\s\S]*?margin:\s*([^,)]+)", self.content)
if margin_match:
margin = margin_match.group(1)
print(f" ✓ Margins: {margin}")
else:
self.warnings.append("Margins not explicitly set")
# Check columns
columns_match = re.search(r"#set\s+page\([\s\S]*?columns:\s*(\d+)", self.content)
if columns_match:
columns = columns_match.group(1)
print(f" ✓ Columns: {columns}")
if self.venue == "ieee" and columns != "2":
self.issues.append("IEEE requires two-column format")
else:
if self.venue in ["ieee", "acm", "cvpr"]:
self.warnings.append(f"{self.venue.upper()} typically uses two-column format")
def check_text_settings(self):
"""Check text configuration."""
print("\n[CHECK] Text Settings")
# Check font
font_match = re.search(r'#set\s+text\([\s\S]*?font:\s*"([^"]+)"', self.content)
if font_match:
font = font_match.group(1)
print(f" ✓ Font: {font}")
if self.venue == "ieee" and "Times" not in font:
self.warnings.append("IEEE typically uses Times New Roman")
else:
self.warnings.append("Font not explicitly set")
# Check font size
size_match = re.search(r"#set\s+text\([\s\S]*?size:\s*(\d+(?:\.\d+)?pt)", self.content)
if size_match:
size = size_match.group(1)
print(f" ✓ Font size: {size}")
else:
self.warnings.append("Font size not explicitly set")
# Check language
lang_match = re.search(r'#set\s+text\([\s\S]*?lang:\s*"([^"]+)"', self.content)
if lang_match:
lang = lang_match.group(1)
print(f" ✓ Language: {lang}")
else:
self.warnings.append("Language not explicitly set")
def check_headings(self):
"""Check heading formatting."""
print("\n[CHECK] Headings")
# Check numbering
numbering_match = re.search(r'#set\s+heading\([\s\S]*?numbering:\s*"([^"]+)"', self.content)
if numbering_match:
numbering = numbering_match.group(1)
print(f" ✓ Heading numbering: {numbering}")
else:
if self.venue not in ["neurips", "icml", "iclr"]:
self.warnings.append("Heading numbering not set (most venues require it)")
# Count headings
headings = re.findall(r"^(=+)\s+(.+)$", self.content, re.MULTILINE)
if headings:
print(f" ✓ Found {len(headings)} headings")
levels = {len(h[0]) for h in headings}
print(f" ✓ Heading levels: {sorted(levels)}")
else:
self.warnings.append("No headings found")
def check_figures_tables(self):
"""Check figure and table formatting."""
print("\n[CHECK] Figures and Tables")
# Count figures
figures = re.findall(r"#figure\(", self.content)
if figures:
print(f" ✓ Found {len(figures)} figures/tables")
# Check for labels
labeled_figures = re.findall(r"#figure\([^)]+\)\s*<([^>]+)>", self.content)
print(f" ✓ Labeled figures/tables: {len(labeled_figures)}")
if len(labeled_figures) < len(figures):
self.warnings.append(
f"{len(figures) - len(labeled_figures)} figures/tables without labels"
)
# Check for captions
captioned_figures = re.findall(r"caption:\s*\[", self.content)
print(f" ✓ Figures/tables with captions: {len(captioned_figures)}")
if len(captioned_figures) < len(figures):
self.warnings.append(
f"{len(figures) - len(captioned_figures)} figures/tables without captions"
)
else:
print(" ℹ No figures or tables found")
def check_citations(self):
"""Check citation formatting."""
print("\n[CHECK] Citations")
# Count citations
citations = re.findall(r"@\w+", self.content)
if citations:
unique_citations = set(citations)
print(f" ✓ Found {len(citations)} citations ({len(unique_citations)} unique)")
# Check for bibliography
bib_match = re.search(r"#bibliography\(", self.content)
if bib_match:
print(" ✓ Bibliography command found")
else:
self.issues.append("Citations found but no bibliography command")
else:
print(" ℹ No citations found")
def check_math(self):
"""Check math equation formatting."""
print("\n[CHECK] Math Equations")
# Count all math expressions
all_math = re.findall(r"\$[^$]+\$", self.content)
# Count display math (has whitespace after opening $ and before closing $)
display_math = re.findall(r"\$\s+[^$]+\s+\$", self.content)
# Inline math = total - display
inline_count = len(all_math) - len(display_math)
if inline_count > 0:
print(f" ✓ Found {inline_count} inline math expressions")
if display_math:
print(f" ✓ Found {len(display_math)} display math expressions")
# Check for labeled equations
labeled_equations = re.findall(r"\$\s+[^$]+\s+\$\s*<([^>]+)>", self.content)
print(f" ✓ Labeled equations: {len(labeled_equations)}")
if len(labeled_equations) < len(display_math):
self.warnings.append(
f"{len(display_math) - len(labeled_equations)} display equations without labels"
)
if not all_math:
print(" ℹ No math expressions found")
def check_venue_specific(self):
"""Check venue-specific requirements."""
if not self.venue:
return
print(f"\n[CHECK] Venue-Specific Requirements ({self.venue.upper()})")
if self.venue == "ieee":
# IEEE specific checks
if "columns: 2" not in self.content:
self.issues.append("IEEE requires two-column format")
if "us-letter" not in self.content:
self.warnings.append("IEEE typically uses US Letter paper")
elif self.venue == "acm":
# ACM specific checks
if "columns: 2" not in self.content:
self.warnings.append("ACM typically uses two-column format")
elif self.venue in ["neurips", "icml", "iclr"]:
# ML conference checks
if "columns: 2" in self.content:
self.warnings.append(f"{self.venue.upper()} typically uses single-column format")
if "numbering:" in self.content:
self.warnings.append(f"{self.venue.upper()} typically doesn't number sections")
def run_checks(self) -> int:
"""Run all format checks."""
if not self.load_file():
return 1
print(f"[INFO] Checking format for: {self.typ_file}")
if self.venue:
print(f"[INFO] Venue: {self.venue.upper()}")
if self.strict:
print("[INFO] Strict mode enabled")
self.check_page_settings()
self.check_text_settings()
self.check_headings()
self.check_figures_tables()
self.check_citations()
self.check_math()
self.check_venue_specific()
# Print summary
print("\n" + "=" * 60)
print("SUMMARY")
print("=" * 60)
if self.issues:
print(f"\n❌ ISSUES ({len(self.issues)}):")
for issue in self.issues:
print(f" - {issue}")
if self.warnings:
print(f"\n⚠️ WARNINGS ({len(self.warnings)}):")
for warning in self.warnings:
print(f" - {warning}")
if not self.issues and not self.warnings:
print("\n✅ All checks passed!")
return 0
elif not self.issues:
print("\n✅ No critical issues found")
return 0 if not self.strict else 1
else:
print(f"\n❌ Found {len(self.issues)} critical issues")
return 1
def main():
parser = argparse.ArgumentParser(
description="Typst Format Checker - Validate academic paper formatting",
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog="""
Examples:
uv run python check_format.py main.typ # Basic check
uv run python check_format.py main.typ --strict # Strict mode (warnings as errors)
uv run python check_format.py main.typ --venue ieee # IEEE-specific checks
Supported Venues:
ieee IEEE conferences and journals
acm ACM conferences and journals
springer Springer journals
neurips NeurIPS, ICML, ICLR (ML conferences)
cvpr CVPR, ICCV, ECCV (CV conferences)
""",
)
parser.add_argument("typ_file", help="Typst file to check")
parser.add_argument("--strict", "-s", action="store_true", help="Treat warnings as errors")
parser.add_argument(
"--venue",
"-v",
choices=["ieee", "acm", "springer", "neurips", "cvpr"],
help="Check venue-specific requirements",
)
args = parser.parse_args()
# Validate input file
typ_path = Path(args.typ_file)
if not typ_path.exists():
print(f"[ERROR] File not found: {args.typ_file}")
sys.exit(1)
# Run checks
checker = FormatChecker(args.typ_file, args.strict, args.venue)
sys.exit(checker.run_checks())
if __name__ == "__main__":
main()
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |