Skip to main content

ferrichess_study/
lib.rs

1//! Convert compact chess study text into validated move trees and deterministic
2//! PGN.
3//!
4//! The normal conversion path is [`convert_single_raw`] followed by
5//! [`PgnWriter::render`]:
6//!
7//! ```
8//! use ferrichess_study::{
9//!     convert_single_raw, PgnWriter, RepertoireRole, RepertoireSide,
10//!     SingleRawMetadata,
11//! };
12//!
13//! let metadata = SingleRawMetadata {
14//!     course_title: "Example study".to_owned(),
15//!     event: "Open games".to_owned(),
16//!     chapter_slug: "open-games".to_owned(),
17//!     index: "001".to_owned(),
18//!     repertoire_side: RepertoireSide::White,
19//!     repertoire_role: RepertoireRole::Main,
20//! };
21//!
22//! let document = convert_single_raw("1. e4e52. Nf3Nc6", &metadata)?;
23//! let pgn = PgnWriter::render(&document)?;
24//! assert!(pgn.contains("1. e4 e5 2. Nf3 Nc6 *"));
25//! # Ok::<(), ferrichess_study::PgnError>(())
26//! ```
27//!
28//! See the crate README for the compact input format, conversion model, and
29//! pre-1.0 compatibility policy.
30
31pub mod course;
32pub mod diagnostics;
33pub mod domain;
34pub mod pgn;
35pub mod raw;
36pub mod tree;
37
38#[cfg(test)]
39mod test_support;
40
41pub use course::{
42    ChapterMetadata, CourseDocumentError, CourseDocuments, CourseInfo, CourseKind, CourseMetadata,
43    CurriculumClassification, DocumentMerge, LichessChapter, LichessMetadata, MetadataError,
44    NamedDocument, RawCourseLine, RepertoireSettings, SourceAttribution, generate_course_documents,
45};
46pub use diagnostics::{canonical_tree_json, parser_trace_json};
47pub use domain::{Annotation, DepthLimit, PositionKey, RepertoireRole, RepertoireSide, SourceId};
48pub use pgn::{
49    Header, Headers, PgnDocument, PgnError, PgnWriter, SingleRawMetadata, convert_single_raw,
50};
51pub use raw::{EmbeddedMove, ParsedMove, RawLineParse, RawParser, SourceSpan};
52pub use tree::{
53    BuiltRawTree, ClassifiedRawLine, CommentFragment, CommentReason, CommentVariationDecision,
54    MergeConflict, MergeError, MergeReport, MoveTree, MoveTreeMerger, Node, NodeId, RawLineRecord,
55    RawTreeBuilder, TreeError,
56};