dmc-core 0.3.6

Engine, CLI, watch mode, and collection builds for the dmc MDX compiler
Documentation
use dmc_diagnostic::Code;
use duck_diagnostic::{DiagnosticEngine, diag};
use rayon::iter::{IntoParallelRefIterator, ParallelIterator};
use std::path::PathBuf;

use serde::{Deserialize, Serialize};
use serde_json::Value;

use crate::engine::{
  cache::{FileCache, fingerprint},
  compile::Compiler,
  config::EngineConfig,
  sidecar::run_sidecar,
  utils::{CollectionReport, build_schema_ctx, build_velite_record, minify_js, wrap_mdx_module},
};

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct Collection {
  pub name: String,
  pub pattern: String,
  pub base_dir: PathBuf,
  #[serde(skip_serializing_if = "Option::is_none")]
  pub schema: Option<Value>,
  #[serde(skip_serializing_if = "std::ops::Not::not")]
  pub single: bool,
}

impl Collection {
  /// Compile matched files in parallel, validate frontmatter, optionally
  /// run JS sidecars + MDX module wrap + minify, write `{name}.json`.
  pub(crate) fn process(
    &self,
    cfg: &EngineConfig,
    diag_engine: &mut DiagnosticEngine<Code>,
  ) -> Result<CollectionReport, ()> {
    let walker = globwalk::GlobWalkerBuilder::from_patterns(&self.base_dir, &[&self.pattern]).build().map_err(|e| {
      diag_engine.emit(diag!(Code::IoRead, format!("globwalk {}: {}", self.pattern, e)));
    })?;

    let paths = walker.filter_map(|e| e.ok()).map(|e| e.path().to_path_buf()).collect::<Vec<PathBuf>>();

    let collection_schema = self.schema.as_ref().and_then(|d| {
      dmc_schema::compile_descriptor(d)
        .map_err(|e| {
          diag_engine.emit(diag!(Code::JsonDeserialize, format!("schema descriptor for `{}`: {}", self.name, e)));
        })
        .ok()
    });

    let cache = if cfg.cache_enabled { FileCache::open(cfg.output_dir.join(".cache").join("dmc")) } else { None };
    let cfg_fp = fingerprint(&(&cfg.compile, &cfg.include_html, &self.name, &self.schema, &cfg.output_format));

    let outcomes: Vec<Option<Value>> = paths
      .par_iter()
      .map(|path| {
        let mut local_diag_engine = DiagnosticEngine::<Code>::new();

        let source = match std::fs::read_to_string(path) {
          Ok(s) => s,
          Err(e) => {
            local_diag_engine.emit(diag!(Code::IoRead, format!("read source at {}: {}", path.display(), e)));
            local_diag_engine.print_all_compact();
            return None;
          },
        };

        let cache_key = cache.as_ref().map(|_| FileCache::key(source.as_bytes(), path, &cfg_fp));
        if let (Some(c), Some(k)) = (cache.as_ref(), cache_key.as_ref())
          && let Some(hit) = c.get(k)
        {
          local_diag_engine.print_all(&source);
          return Some(hit);
        }

        let local_compiler_cfg = cfg.compile.for_render();
        let use_sidecar = cfg.compile.has_js_plugins();

        let mut compiled = Compiler::compile_with_pipeline(&source, path, &local_compiler_cfg, &mut local_diag_engine);

        if use_sidecar && let Some(html) = run_sidecar(&compiled.content, cfg) {
          compiled.html = html;
        }

        if cfg.compile.mdx_output_format.as_deref() == Some("module") {
          compiled.body = wrap_mdx_module(&compiled.body, &compiled.imports);
        }
        if cfg.compile.mdx_minify {
          compiled.body = minify_js(&compiled.body);
        }

        let validated_frontmatter = match (&collection_schema, &compiled.frontmatter) {
          (Some(schema), fm) if !fm.is_null() => {
            let ctx = build_schema_ctx(path, &cfg.root, &compiled, cfg);
            match schema.parse(fm, &ctx) {
              Ok(v) => v,
              Err(e) => {
                local_diag_engine
                  .emit(diag!(Code::JsonDeserialize, format!("frontmatter validation at {}: {}", path.display(), e)));
                compiled.frontmatter.clone()
              },
            }
          },
          _ => compiled.frontmatter.clone(),
        };

        let include_html = cfg.include_html || use_sidecar;
        let rec = build_velite_record(compiled, validated_frontmatter, path, &self.base_dir, &self.name, include_html);

        // Cache only clean runs so diagnostics re-fire until the source is fixed.
        let dirty = local_diag_engine.error_count() + local_diag_engine.bug_count() > 0;
        if !dirty && let (Some(c), Some(k)) = (cache.as_ref(), cache_key.as_ref()) {
          c.put(k, &rec);
        }
        local_diag_engine.print_all(&source);

        Some(rec)
      })
      .collect();

    let mut records: Vec<Value> = Vec::with_capacity(outcomes.len());
    for r in outcomes.into_iter().flatten() {
      records.push(r);
    }

    let out_path = cfg.output_dir.join(format!("{}.json", self.name));
    let count = if self.single { if records.is_empty() { 0 } else { 1 } } else { records.len() };
    let json = if self.single {
      let single = records.into_iter().next().unwrap_or(Value::Null);
      serde_json::to_string_pretty(&single).unwrap()
    } else {
      serde_json::to_string_pretty(&records).unwrap()
    };

    std::fs::write(&out_path, json).map_err(|e| {
      diag_engine.emit(diag!(Code::IoWrite, format!("collection {} write at {}: {}", self.name, out_path.display(), e)))
    })?;

    Ok(CollectionReport { name: self.name.clone(), records: count, output_path: out_path })
  }
}