1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
// ┌───────────────────────────────────────────────────────────────────────────┐
// │ │
// │ ██████╗ ██████╗ ██████╗ Copyright (C) 2022, The Prospective Company │
// │ ██╔══██╗██╔══██╗██╔═══██╗ │
// │ ██████╔╝██████╔╝██║ ██║ This file is part of the Procss library, │
// │ ██╔═══╝ ██╔══██╗██║ ██║ distributed under the terms of the │
// │ ██║ ██║ ██║╚██████╔╝ Apache License 2.0. The full license can │
// │ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ be found in the LICENSE file. │
// │ │
// └───────────────────────────────────────────────────────────────────────────┘
//! A simple CSS parsing and transformation framework. Procss can be used to
//! quickly bundle a collection of CSS+ files, or write your own custom
//! transforms.
//!
//! # Usage
//!
//! Procss's parser understands a nested superset of CSS (which we refer to as
//! CSS+), similar to the [CSS nesting proposal](https://www.w3.org/TR/css-nesting-1/),
//! or languages like [Sass](https://sass-lang.com). Start with source CSS+
//! as a [`str`], use [crate::parse] or [crate::parse_unchecked] to generate
//! an [`ast::Tree`].
//!
//! ```
//! use procss::{ast, parse};
//!
//! let ast = procss::parse("div{.open{color:red;}}").unwrap();
//! ```
//!
//! The resulting [`ast::Tree`] can be converted to a de-nested [`ast::Css`]
//! with the [`ast::Tree::flatten_tree`] method, which itself can then be
//! rendered as a plain browser-readable CSS string via the
//! [`RenderCss::as_css_string`] trait method.
//!
//! ```
//! # use procss::{parse, ast};
//! # let ast = procss::parse("div{.open{color:red;}}").unwrap();
//! use procss::RenderCss;
//!
//! let flat: ast::Css = ast.flatten_tree();
//! let css: String = flat.as_css_string();
//! assert_eq!(css, "div .open{color:red;}");
//! ```
//!
//! Intermediate structs [`ast::Css::transform`] amd [`ast::Tree::transform`]
//! can be used to recursively mutate a tree for a variety of node structs in
//! the [`ast`] module. Some useful Example of such transforms can be
//! found in the [`transformers`] module.
//!
//! ```
//! # use procss::{parse, RenderCss};
//! use procss::transformers;
//!
//! let test = "
//! @mixin test {color: red;}
//! div {@include test;}
//! ";
//!
//! let mut ast = procss::parse(test).unwrap();
//! transformers::apply_mixin(&mut ast);
//! let flat = ast.flatten_tree().as_css_string();
//! assert_eq!(flat, "div{color:red;}");
//! ```
//!
//! For coordinating large builds on a tree of CSS files, the [`BuildCss`]
//! struct can parse and minify, applying all transforms (including
//! [`transformers::apply_import`]) as the compilation is left-folded over the
//! inputs.
//!
//! ```
//! let mut build = procss::BuildCss::new("./src");
//! build.add("controls/menu.scss");
//! build.add("logout.scss"); // imports "controls/menu.scss"
//! build.add("my_app.scss"); // imports "controls/menu.scss" and "logout.scss"
//! build.compile().unwrap().write("./dist").unwrap();
//! ```
#![feature(assert_matches)]
#![feature(path_file_prefix)]
pub mod ast;
mod parser;
mod render;
mod transform;
pub mod transformers;
mod utils;
use std::collections::HashMap;
use std::fs;
use std::path::PathBuf;
use anyhow::{anyhow, Context};
use nom::error::convert_error;
use nom::Err;
use self::ast::Tree;
use self::parser::ParseCss;
pub use self::render::RenderCss;
/// Parse CSS text to a [`Tree`] (where it can be further manipulated),
/// capturing detailed error reporting for a moderate performance impact (using
/// [`nom::error::VerboseError`]).
///
/// # Example
///
/// ```rust
/// let ast = procss::parse("div { .open { color: red; }}").unwrap();
/// ```
pub fn parse(input: &str) -> anyhow::Result<Tree<'_>> {
let (rest, x) = Tree::parse(input).map_err(|err| match err {
Err::Error(e) | Err::Failure(e) => {
anyhow!("Error parsing, unknown:\n{}", convert_error(input, e))
}
Err::Incomplete(needed) => anyhow!("Error parsing, unexpected input:\n {:?}", needed),
})?;
if rest.is_empty() {
Ok(x)
} else {
Err(anyhow!("Error parsing, unreachable:\n {}", rest))
}
}
/// Parse CSS text to a [`Tree`], without capturing error details, for maximum
/// performance without any error details when parsing fails.
///
/// # Example
///
/// ```rust
/// let ast = procss::parse_unchecked("div { .open { color: red; }}").unwrap();
/// ```
pub fn parse_unchecked(input: &str) -> anyhow::Result<Tree<'_>> {
let (rest, x) = Tree::parse::<()>(input)?;
if rest.is_empty() {
Ok(x)
} else {
Err(anyhow!("Error parsing, unreachable:\n {}", rest))
}
}
/// A CSS+ project build, comprising a collection of CSS+ files which may
/// reference eachother (via `@import`).
pub struct BuildCss<'a> {
paths: Vec<String>,
contents: HashMap<&'a str, String>,
trees: HashMap<&'a str, ast::Tree<'a>>,
css: HashMap<&'a str, ast::Css<'a>>,
rootdir: &'static str,
}
/// The compiled output of a [`BuildCss`] collection, obtained from
/// [`BuildCss::compile`].
pub struct CompiledCss<'a>(&'a BuildCss<'a>);
/// An incremental build struct for compiling a project's CSS sources.
///
/// # Example
///
/// ```
/// let mut build = procss::BuildCss::new("./src");
/// build.add("app.scss");
/// build.compile().unwrap().write("./dist").unwrap();
/// ```
impl<'a> BuildCss<'a> {
/// Create a new [`BuildCss`] rooted at `rootdir`.
pub fn new(rootdir: &'static str) -> Self {
Self {
paths: Default::default(),
contents: Default::default(),
trees: Default::default(),
css: Default::default(),
rootdir,
}
}
/// Add a file `path` to this build.
pub fn add(&mut self, path: &str) {
self.paths.push(path.to_owned());
}
/// Compile this [`BuildCss`] start-to-finish, applying all transforms along
/// the way.
pub fn compile(&'a mut self) -> anyhow::Result<CompiledCss<'a>> {
for path in &self.paths {
let inpath = PathBuf::from(self.rootdir).join(path);
let contents = if cfg!(debug_assertions) {
"div{}".to_owned()
} else {
fs::read_to_string(inpath)?
};
self.contents.insert(path, contents);
}
for (path, contents) in &self.contents {
self.trees.insert(path, parse(contents)?);
}
let trees = self.trees.clone();
for (path, tree) in self.trees.iter_mut() {
transformers::apply_import(&trees)(tree);
transformers::apply_mixin(tree);
transformers::apply_var(tree);
let mut flat = tree.flatten_tree();
transformers::inline_url(self.rootdir)(&mut flat);
self.css.insert(path, flat);
}
Ok(CompiledCss(self))
}
}
impl<'a> CompiledCss<'a> {
/// Write this struct's compiled data to `outdir`, preserving the relative
/// subdirectory structure of the `input` sources passed to
/// [`BuildCss::add`], relative to `outdir`.
pub fn write(self, outdir: &'static str) -> anyhow::Result<()> {
for (path, css) in &self.0.css {
let outpath = PathBuf::from(path);
let outfile = format!(
"{}.css",
outpath
.file_prefix()
.context("No Prefix")?
.to_string_lossy()
);
let outdir = PathBuf::from(outdir).join(outpath.parent().unwrap());
if !cfg!(debug_assertions) {
fs::create_dir_all(outdir.clone()).unwrap_or_default();
fs::write(outdir.join(outfile), css.as_css_string())?;
}
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use std::assert_matches::assert_matches;
use super::*;
#[test]
fn test_verbose_error() {
assert_matches!(
parse("div{color:red").map(|x| x.as_css_string()).as_deref(),
Err(_)
)
}
#[test]
fn test_parse_unchecked() {
assert_matches!(
parse_unchecked("div{color:red}")
.map(|x| x.as_css_string())
.as_deref(),
Ok("div{color:red;}")
)
}
}