risedev_docslt/
risedev-docslt.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::io::Write;
16use std::path::{Path, PathBuf};
17
18use anyhow::Result;
19use itertools::Itertools;
20use thiserror_ext::AsReport;
21use tracing::*;
22
23#[derive(Clone, PartialEq, Eq, PartialOrd, Ord)]
24struct Position {
25    filepath: PathBuf,
26    line_no: usize,
27}
28
29struct SltBlock {
30    position: Position,
31    content: String,
32}
33
34/// Extracts all `slt` code blocks from a file.
35fn extract_slt(filepath: &Path) -> Vec<SltBlock> {
36    let content = std::fs::read_to_string(filepath).unwrap();
37
38    let mut blocks = vec![];
39    let mut iter = content.lines().enumerate();
40    while let Some((i, line)) = iter.next() {
41        if !line.trim_end().ends_with("```slt") {
42            continue;
43        }
44        let mut content = String::new();
45        loop {
46            let Some((i, mut line)) = iter.next() else {
47                panic!("unexpected end of file at {}", filepath.display());
48            };
49            line = line.trim();
50            // skip empty lines
51            if line.is_empty() {
52                continue;
53            }
54            if !(line.starts_with("///") || line.starts_with("//!")) {
55                panic!("expect /// or //! at {}:{}", filepath.display(), i + 1);
56            }
57            line = &line[3..];
58            if line.trim() == "```" {
59                break;
60            }
61            // strip one leading space
62            content += line.strip_prefix(' ').unwrap_or(line);
63            content += "\n";
64        }
65        blocks.push(SltBlock {
66            position: Position {
67                filepath: filepath.into(),
68                line_no: i + 1,
69            },
70            content,
71        });
72    }
73    blocks
74}
75
76fn main() -> Result<()> {
77    tracing_subscriber::fmt()
78        .with_max_level(tracing::Level::INFO)
79        .without_time()
80        .with_target(false)
81        .with_level(true)
82        .init();
83
84    // output directory
85    let slt_dir = PathBuf::from("e2e_test/generated/docslt");
86    fs_err::remove_dir_all(&slt_dir).ok();
87    fs_err::create_dir_all(&slt_dir)?;
88
89    for entry in glob::glob("src/**/*.rs")? {
90        let path = match entry {
91            Ok(path) => path,
92            Err(e) => {
93                error!("{}", e.as_report());
94                continue;
95            }
96        };
97        let blocks = extract_slt(&path);
98        if blocks.is_empty() {
99            continue;
100        }
101        info!("found {} blocks at {}", blocks.len(), path.display());
102
103        let slt_filename = path
104            .components()
105            .map(|comp| comp.as_os_str().to_str().unwrap())
106            .filter(|name| *name != "src")
107            .join("__")
108            .replace(".rs", ".slt");
109        let mut slt_file = fs_err::File::create(slt_dir.join(slt_filename))?;
110        write!(
111            slt_file,
112            "\
113            # DO NOT MODIFY THIS FILE\n\
114            # This file is generated from `{}` at {}.\n\
115            \n\
116            statement ok\n\
117            set RW_IMPLICIT_FLUSH to true;\n",
118            path.display(),
119            chrono::Utc::now()
120        )?;
121        for block in blocks {
122            write!(
123                slt_file,
124                "\n\
125                # ==== `slt` @ L{} ====\n\
126                \n\
127                {}\n",
128                block.position.line_no, block.content
129            )?;
130        }
131    }
132    Ok(())
133}
risedev_docslt/risedev-docslt.rs

risedev_docslt/
risedev-docslt.rs
