Skip to content

3.0.0

Choose a tag to compare

@github-actions github-actions released this 02 Jul 01:00

3.0.0 - 2026-07-02

✨ New Features

  • Project renamed to OpenFCPXMLKit: Pipeline Neo is now OpenFCPXMLKit. All code, APIs, documentation, and tooling use OpenFCPXMLKit naming exclusively — the OpenFCPXMLKit module, the OpenFCPXMLKit-CLI binary, and the OFKXML* cross-platform XML types. Existing FCPXML parsing, creation, and manipulation APIs remain source-compatible; the product name and module are what changed.
  • Production's Best Friend–style Excel reports: A new reporting subsystem builds structured, multi-sheet .xlsx workbooks from an FCPXML/FCPXMLD, modelled on Production's Best Friend report layouts. Sheets include Role Inventory (Selected Roles plus per-role sheets), Markers, Keywords, Titles & Generators, Transitions, Video & Audio Effects, Speed Change Effects, and a Summary sheet with per-role duration totals and percentages. Workbook export is XLKit-backed with Production's Best Friend–style formatting (black header rows, role and marker colour coding, numeric percentage cells, column auto-fit).
  • Reporting API: FinalCutPro.FCPXML.buildReport(options:) with ReportBuilder, typed Report/section/row models, and ReportOptions presets (.full, .markersOnly, .roleInventoryOnly, .summaryOnly, and more), plus role exclusions, project-name filtering, progress callbacks, and RoleDisplayPreference. ReportExcelExport renders any Report to a workbook or writes it to an .xlsx file.
  • CLI --report: New REPORT command on OpenFCPXMLKit-CLI. --report alone exports the role inventory; --report-full adds every optional sheet; per-section flags (--report-markers, --report-keywords, --report-titles-generators, --report-transitions, --report-effects, --report-speed-change-effects, --report-summary) select individual sheets, and --exclude-role / --report-project refine the output. Writes {project-name}.xlsx to the output directory.
  • Extraction presets: Added TitlesExtractionPreset and EffectsExtractionPreset alongside the existing presets to drive report-oriented element extraction.

🔧 Improvements

  • Dependencies: Added XLKit for Excel workbook generation (Reporting/Excel).
  • Test suite: Expanded to 877 tests with dedicated reporting and extraction coverage (role inventory, markers, keywords, titles, transitions, effects, speed-change effects, summary, Excel export, role display/exclusion, and extraction scope/presets). Test files and classes are standardised on the FCPXML prefix, with the module-named umbrella OpenFCPXMLKitTests as the sole exception.
  • Documentation: New manual chapter 19 — Reporting & Excel Export; updated CLI and Extraction chapters, the manual index/README, and examples. AGENT.md, ARCHITECTURE.md, .cursorrules, and Tests/README.md updated for the reporting subsystem, OpenFCPXMLKit naming, and the standardised FCPXML-prefixed test naming.

🐛 Bug Fixes

  • None in this release.