Skip to main content

OmniScript Format v1.0

PRODUCTION READY

Released: October 15, 2025

Welcome to v1.0!

OmniScript Format v1.0 is a major milestone representing months of development, testing, and refinement. This release marks the official production release with all core features implemented, tested, and ready for use.

What's New

@chart - Data Visualization

Create interactive charts with multiple types and styling options.

@chart {
  type: "bar";
  title: "Sales by Quarter";
  data: [
    { label: "Q1"; values: [100, 120, 90]; },
    { label: "Q2"; values: [150, 140, 160]; }
  ];
  options: {
    xAxis: "Quarter";
    yAxis: "Revenue ($K)";
    legend: true;
  };
}

Supported Types:

  • Bar charts
  • Line charts
  • Pie charts
  • Scatter plots
  • Area charts

Rendering:

  • PDF: Chart.js
  • DOCX: Data tables
  • PPTX: Native charts
Learn More →

@diagram - Visual Diagrams

Create flowcharts, sequence diagrams, Gantt charts, and mind maps.

@diagram {
  type: "flowchart";
  engine: "mermaid";
  title: "User Authentication";
  code: "graph TD
    A[Login] --> B{Valid?}
    B -->|Yes| C[Dashboard]
    B -->|No| D[Error]";
}

Supported Types:

  • Flowcharts
  • Sequence diagrams
  • Gantt charts
  • Mind maps

Engines:

  • Mermaid (default)
  • Graphviz
Learn More →

@code - Syntax Highlighting

Display code with line numbers and syntax highlighting for 50+ languages.

@code {
  language: "typescript";
  caption: "Server Example";
  lineNumbers: true;
  highlight: [3, 4];
  code: "import express from 'express';
    const app = express();
    app.listen(3000);";
}

Features:

  • 50+ language support (via Prism.js)
  • Optional line numbers
  • Line highlighting
  • Captions
Learn More →

Complete Feature List

Core Features

  • ✅ Zero-dependency parser
  • ✅ 7 block types
  • ✅ 4 export formats
  • ✅ 10+ themes
  • ✅ Full TypeScript
  • ✅ Backward compatible

Advanced Features

  • ✅ 5 chart types
  • ✅ 4 diagram types
  • ✅ 2 diagram engines
  • ✅ 50+ code languages
  • ✅ Line highlighting
  • ✅ Custom styling

Quality Assurance

  • ✅ 152 tests (100% pass)
  • ✅ Code review complete
  • ✅ Security hardened
  • ✅ Performance optimized
  • ✅ Production-ready

Packages

  • 📦 omniscript-parser@1.0.0
  • 📦 omniscript-converters@1.0.0
  • 📦 omniscript-cli@1.0.0
  • 📦 omniscript-vscode@0.1.0
  • 📦 omniscript-examples@1.0.0

Breaking Changes

None!

v1.0 is fully backward compatible with v0.5. All existing OSF documents continue to work without modification.

Migration Guide

From v0.5 to v1.0

Good news: No migration needed! v1.0 is fully backward compatible.

All v0.5 documents work unchanged:

@meta { title: "My Doc"; }
@doc { # Content }
@slide { title: "Slide"; }
// ✅ Works perfectly in v1.0

Start using v1.0 features immediately:

@meta { title: "My Doc"; version: "1.0"; }
@doc { # Content }
@chart { type: "bar"; /* new! */ }
// ✅ Mix v0.5 and v1.0 blocks

Recommended Updates:

  1. Update packages: npm update omniscript-*
  2. Add version to @meta: version: "1.0";
  3. Explore new blocks (@chart, @diagram, @code)

Test Results

152/152 Tests Passing (100%)

Unit Tests:

  • Parser: 26/26 ✅
  • Converters: 73/73 ✅
  • CLI: 29/29 ✅

Integration Tests:

  • End-to-end: 5/5 ✅
  • File validation: 3/3 ✅
  • Examples: 16/16 ✅
View Full Test Report →

Known Issues

Minor (P2) - Non-Blocking

These issues do not block v1.0 release but are tracked for v1.0.1:

  • Chart color array bounds checking
  • Code language validation against Prism.js
  • Sheet data optional chaining edge cases
  • CDN dependencies for Chart.js/Mermaid

Track issues on GitHub

What's Next (v1.1)

Planned Features:

  • @table block - Markdown-style tables
  • @include directive - Import external files
  • @variables - Template variables
  • @loops - Repeat blocks dynamically
  • Conditional rendering
  • Custom themes system
  • Plugin architecture
  • More export formats (HTML, Markdown, LaTeX)
View Full Roadmap →

Thank You

Thank you for using OmniScript Format! We're excited to see what you build with v1.0.

Happy documenting! 🚀