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 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
//! <span align=center>
//!
//! 
//!
//! [](https://crates.io/crates/cuteness)
//! [](https://docs.rs/cuteness)
//!
//! </span>
//!
//! ---
//!
//! ***Cuteness*** is a static site generator. It generates a [Rocket](https://rocket.rs) web-server and builds the Markdown[^4] source files. It was created to offer extreme configuration and an easy configuration API using [TOML](https://toml.io/), and that's mainly what we're going to talk about here.
//!
//! * [`cuteconfig.toml`](#cuteconfig)
//! * [`[misc]`](#config.misc)
//! * [`[config]`](#config.config)
//! * [The front-matter](#frontmatter)
//! * [Example](#frontmatter.example)
//! * [Templating](#templating)
//! * [`{{page.*}}`](#templating.page)
//! * [Example](#templating.page.example)
//! * [`{{outer.*}}`](#templating.outer)
//! * [Example](#templating.outer.example)
//! * [Source files](#sourcefiles)
//! * [`SUMMARY.toml`](#sourcefiles.summary)
//! * [Subcommands](#subcommands)
//! * [`init`](#subcommands.init)
//! * [`build`](#subcommands.build)
//! * [`setup`](#subcommands.setup)
//! * [`update`](#subcommands.update)
//! * [`clean`](#subcommands.clean)
//! * [`uninstall`](#subcommands.uninstall)
//! * [`help`](#subcommands.help)
//! * [Styles](#styles)
//! * [Using Sass](#styles.sass)
//! * [Not using Sass](#styles.css)
//! * [Routing](#routing)
//! * [Preprocessors](#preprocessors)
//!
//! ## `cuteconfig.toml` <a name="cuteconfig"></a>
//!
//!
//! `cuteconfig.toml` is the file used to store configuration settings. It's default configuration in the current version is: ([latest version](https://github.com/blyxyas/cuteness/blob/main/cuteconfig.default.toml))
//!
//! ```toml
//! # cuteconfig.default.toml
//! [misc]
//! latex = true # Should cuteness build with KaTeX support?
//! html_lang = "en" # What language should HTML use?
//! syntax_highlighting = true
//!
//! [config]
//! # Put any custom templates here :D
//! ```
//!
//! ### `[misc]` <a name="config.misc"></a>
//!
//! This section handles miscellaneous settings, usually related to preprocessors and very case-specific tools.
//!
//! * `latex`: Enables LaTeX[^1] equations.
//! * `html_lang`: Changes the starting `<html>` tag (e.g. *"es"* `<html lang="es">`).
//! * `syntax_highlighting`: Enables syntax highlighting using [`highlight.js`](https://highlightjs.org/).
//!
//! ### `[config]` <a name="config.config"></a>
//!
//! This section is used to store user-provided configurations. It can store any [TOML value](https://toml.io/en/v1.0.0#keyvalue-pair) (*strings, integers, arrays...*).
//!
//! ---
//!
//! All these sections can be used in your documents with `{{outer.*}}` (e.g. `{{outer.misc.html_lang}}`), we'll see more about templating in the next section.
//!
//! ## The front-matter <a name="frontmatter"></a>
//!
//! A front-matter is the initial heading before your Markdown contents. This heading contains some configuration options used to generate the webpage. Currently, the only mandatory field is `title`.
//!
//! * `title`: The current page's title.
//! * `pageconf` *(optional)*: User-provided page configuration (Key-value pairs).
//! * `additional_css` *(optional)*: Additional CSS files needed to properly render the page. **(`index.css` is imported by default)**
//!
//! ### Example <a name="frontmatter.example"></a>
//!
//! ```md
//! # my_file.md
//! ---
//! title: "My file"
//! ---
//!
//! Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc est, semper non
//! maximus et, mattis in leo. Nullam luctus, ligula id venenatis consequat, ligula
//! odio convallis eros, sed scelerisque tortor elit vitae massa. Aliquam efficitur
//! tempus purus sit amet eleifend. Mauris vel ex iaculis, iaculis nisl id, finibus
//! justo. Morbi gravida vel velit eget ultricies. In orci purus, porta ut nibh
//! blandit, vestibulum lobortis augue. Vestibulum venenatis finibus tellus, sit amet
//! venenatis elit rutrum ut. Donec posuere ipsum efficitur tortor viverra dignissim.
//! Donec urna libero, molestie id libero vitae, bibendum rutrum leo. Praesent
//! suscipit tincidunt ultrices. Sed finibus neque blandit velit venenatis volutpat.
//! In id dui sit amet quam ullamcorper viverra. In rutrum ante sapien, et tincidunt
//! ligula dignissim id. Curabitur hendrerit sagittis orci, in rhoncus dui venenatis
//! sit amet. Nunc sed enim arcu.
//! ```
//!
//! In this case, the front-matter only contains `title`, that being *"My file"*
//!
//! ## Templating <a name="templating"></a>
//!
//! ***Cuteness*** uses [`Handlebars-rs`](https://github.com/sunng87/handlebars-rust)[^3] and it exposes a templating API to the user with `page` and `outer`.
//!
//! ### `{{page.*}}` <a name="templating.page"></a>
//!
//! `{{page.*}}` is the interface that you can access in order to use page configuration. For example, you can use `{{page.title}}` to access the page's title.
//!
//! #### Example <a name="templating.page.example"></a>
//!
//! ```md
//! # my_file.md
//! ---
//! title: "My file"
//! pageconf: {
//! software-version: "0.7.2",
//! status: "beta"
//! }
//! ---
//!
//! Now I can use {{page.title}} to access this page's title.
//! Currently, our software is in version {{page.pageconf.software-version}}, that means that we're in a {{page.pageconf.status}} version.
//! ```
//!
//! This will get rendered to:
//!
//! ```html
//! <!-- [...] -->
//! <body>
//! <div class="wrapper">
//! <div class="cutesidebar">
//! <ul>
//!
//! <li><a href="introduction">Chapter 1: Introduction</a></li>
//! </ul>
//! </div>
//! <div class="main-content">
//! <p>Now I can use My file to access this page’s title.
//! Currently, our software is in version 0.7.2, that means that we’re in a beta version. </p>
//! </div>
//! </div>
//! </body>
//! <!-- [...] -->
//! ```
//!
//! ### `{{outer.*}}` <a name="templating.outer"></a>
//!
//! `{{outer.*}}` is the interface to use if you want to access global settings found in `cuteconfig.toml`.
//!
//! #### Example <a name="templating.outer.example"></a>
//!
//! ```toml
//! # cuteconfig.toml
//! # [...]
//! [config]
//! authors = [
//! "Alejandra González",
//! "Alejandra's cat, Keepy 🐱"
//! ]
//! # [...]
//! ```
//!
//! ```hbs
//! # my_file.md
//! ---
//! title: "My file"
//! ---
//!
//! Now I can list the authors of the page:
//!
//! **Authors:**
//!
//! {{#each outer.config.authors}}
//! - {{this}}
//!
//! {{/each}}
//! ```
//!
//! This will render to:
//!
//! ```html
//! <!-- [...] -->
//! <body>
//! <div class="wrapper">
//! <div class="cutesidebar">
//! <ul>
//!
//! <li><a href="introduction">Chapter 1: Introduction</a></li>
//! </ul>
//! </div>
//! <div class="main-content">
//! <p>Now I can list the authors of the page:</p>
//! <p><strong>Authors:</strong></p>
//! <p></p>
//! - Alejandra González
//! <p></p>
//! - Alejandra's cat, Keepy 🐱
//! <p></p>
//!
//! </div>
//! </div>
//! </body>
//!
//! <!-- [...] -->
//!
//! ```
//!
//! ## Source files <a name="sourcefiles"></a>
//!
//! A normal file tree looks something like this:
//! ```text
//! .
//! ├── cuteconfig.toml
//! ├── src
//! │ └── introduction.md
//! │ └── [Other .md files]
//! └── SUMMARY.toml
//! ```
//!
//! All your Markdown files are located at the `src` directory; both `cuteconfig.toml` and `SUMMARY.toml` are located in the root directory. This is the default tree (generated by [`cuteness init`](#subcommands.init)) and it's the recommended way to start writing your contents.
//!
//! When creating a new file, you'll have to start the file writing a [front-matter](#frontmatter) and then the contents of your file. As explained in [*Templating*](#templating), you can use [Handlebars templates](https://handlebarsjs.com/).
//!
//! ## `SUMMARY.toml` <a name="sourcefiles.summary"></a>
//!
//! `SUMMARY.toml` is the file used to manage public links. The example `SUMMARY.toml` file (generated by [`cuteness init`](#subcommands.init)) looks like this:
//!
//! ```toml
//! [[map]]
//! title = "Chapter 1: Introduction"
//! url = "introduction"
//! ```
//!
//! It contains a table (`map`), this table can be used multiple times to define different routes (Indicated by `[[` double brackets `]]`).
//!
//! ```toml
//! [[map]]
//! title = "Chapter 1: ..."
//! # [...]
//!
//! # Another page
//!
//! [[map]]
//! title = "Chapter 2: ..."
//! # [...]
//! ```
//!
//! `[[map]]` tables contain some fields like `title` and `url`, the following section will explain them.
//!
//! * `title`: Page's title, this will be used for things such as the [`<title>`](https://developer.mozilla.org/docs/Web/HTML/Element/title) tag in the HTML's head or the sidebar.
//!
//! * `url`: URL to the page, i. e. if the source page is at "\<root\>/src/my_file.md", write "my_file".
// FIXME: TO CONTRIBUTORS: This section needs to be updated every time a new field is added to SummaryConfig @ main.rs or Map @ main.rs
//!
//! ([Up-to-date version here](https://github.com/blyxyas/cuteness/blob/main/SUMMARY.default.toml))
//!
//! Server routing and routes displayed to the user don't need to be the same.
//!
//! # Subcommands <a name="subcommands"></a>
//! ## `init` <a name="subcommands.init"></a>
//!
//! `cuteness init` is the command used to initialize a dummy directory, ready to be written. It will create:
//!
//! * `src` directory.
//! * `introduction.md` inside `src` with some [default contents](https://raw.githubusercontent.com/blyxyas/cuteness/main/introduction.default.md).
//! * `SUMMARY.toml` in the root directory with [default contents](https://github.com/blyxyas/cuteness/blob/main/SUMMARY.default.toml).
//! * `cuteconfig.toml` in the root directory with [default contents](https://github.com/blyxyas/cuteness/blob/main/cuteconfig.default.toml).
//!
//! You can start by writing on `introduction.md`, then executing `cuteness build`, executing `cargo run --manifest-path <output directory, default: www>/routing/Cargo.toml` and going to *http://localhost:8080/introduction*
//!
//! ## `build` <a name="subcommands.build"></a>
//!
//! `cuteness build` is used to build the project, it will create an output directory containing the built version (using all your configurations) of your `src` directory. If there are `.sass` files in the directory `src/styles` it will also compile those.
//!
//! ## `setup` <a name="subcommands.setup"></a>
//!
//! `cuteness setup` is a one-time command, it's used to get all necessary template files from the web. **It requires internet connection**. You can think of it as an enhanced `git clone` that only clones necessary files.
//!
//! **NOTE**: This command will create a directory called `cuteness-config` at your Cargo home (usually `~/.cargo/` on Unix systems) and store there all your internal configurations. (Do not edit manually.)
//!
//! ## `update` <a name="subcommands.update"></a>
//!
//! `cuteness update` will update the internal templates and styles to the latest version; you can think of it as an enhanced `git pull`.
//!
//! ## `clean` <a name="subcommands.clean"></a>
//!
//! `cuteness clean` will delete the output directory (default: `www`). It's not usually necessary.
//!
//! ## `uninstall` <a name="subcommands.uninstall"></a>
//!
//! `cuteness uninstall` will delete the internal templating and styling files stored in `<CARGO HOME>/cuteness-config/`.
//!
//! **This will not uninstall the binary**, you'll have to use `cargo uninstall cuteness`. This subcommand needs to be executed before doing that so it's a clean uninstall.
//!
//! ## `help` <a name="subcommands.help"></a>
//!
//! `cuteness help` displays a help message.
//!
//! # Styles <a name="styles"></a>
//!
//! Styling files are stored at `src/styles` and can be imported in a per-page basis using the `additional_css` optional key on the [page's front-matter](#frontmatter).
//!
//! The special built-in `index.css` file is always imported, this file contains basic layout options for the correct display of your page. You can check the Sass source of `index.css` [here](https://github.com/blyxyas/cuteness/blob/main/src-styles/index.sass).
//!
//! ## Using Sass <a name="styles.sass"></a>
//!
//! You can use [Sass](https://sass-lang.com/) as a preprocessor for your files, just activate the feature `sass` when installing the binary (enabled by default) and store your `.sass` files in `src/styles` as any other `.css` file. They will be compiled with `cuteness build`.
//!
//! ## Not using Sass <a name="styles.css"></a>
//!
//! Almost the same, just locate your `.css` files at `src/styles` and they will not get compiled, but only copied to the output directory.
//!
//! # Routing <a name="routing"></a>
//!
//! When using `cuteness build`, an output directory containing some static files and a simple web-server will be generated which you can access by going to *http://localhost:8080/*
//!
//! As the project is still in development, efforts about using actual servers available on the internet are still very far from being started.
//!
//! # Preprocessors <a name="preprocessors"></a>
//!
//! The files content are preprocessed before being written, these preprocessors are used to change \"straight quotes\" to “curly quotes”, or to change emojicodes "`:cat:`" to actual emojis 🐱. These preprocessors are applied automatically and should not cause any problems.
//!
#![doc = ::document_features::document_features!()]
//! [^1]: The tool specifically uses [KaTeX](https://katex.org/), specialized on equations.
//!
//! [^3]: `Handlebars-rs` uses the [Handlebars templating language](https://handlebarsjs.com/)
//!
//! [^4]: Specifically, our parser ([`pulldown-cmark`](https://docs.rs/pulldown-cmark/latest/pulldown_cmark/)) uses the [CommonMark](https://commonmark.org/) specification.
//!
//! [^5]: There are some ideas about porting the generated web-server to Rust. As the project isn't v1.0 yet, this may change in the future.
use core::panic;
use std::{
borrow::Cow,
fs::{create_dir, remove_dir_all},
path::{Path, PathBuf},
process::Command,
};
use anyhow::{Context, Result};
use emojis::get_by_shortcode;
use lazy_static::lazy_static;
use regex::Regex;
use serde::{Deserialize, Serialize};
use serde_json::json;
lazy_static! {
static ref REQUOTE: Regex = Regex::new("\"(.*?)\"").unwrap();
static ref REEMOJI: Regex = Regex::new(":(.*?):").unwrap();
pub static ref CONFIG_PATH: PathBuf = home::cargo_home()
.expect("Couldn't get Cargo home")
.join("cuteness-config");
// Regex for < and >
static ref RELTGT: Regex = Regex::new("<(.*?)>").unwrap();
}
const REPO_URL: &str = "https://github.com/blyxyas/cuteness.git";
/// Replace straight quotes (") with curly quotes, U+201C (“) and U+201D (”)
#[inline(always)]
pub fn curly_quotes(content: &str) -> Cow<'_, str> {
REQUOTE.replace_all(content, "“$1”")
}
/// Replaces all emojicodes (:cat:) to real emojis
#[inline(always)]
pub fn emojis(content: &str) -> String {
let mut result = <&str>::clone(&content).to_string();
for cap in REEMOJI.find_iter(content) {
if let Some(emoji) = get_by_shortcode(&content[cap.start() + 1..cap.end() - 1]) {
result = content.replace(cap.as_str(), emoji.as_str());
};
}
result
}
#[inline]
pub fn params_in_path(path: &Path) -> Vec<String> {
let mut result = Vec::new();
{
for cap in RELTGT.find_iter(&path.to_string_lossy()) {
result.push(path.to_string_lossy()[cap.start() + 1..cap.end() - 1].to_string());
}
}
result
}
#[inline]
pub fn setup() {
if CONFIG_PATH.exists() {
return;
}
create_dir(CONFIG_PATH.as_path())
.unwrap_or_else(|e| panic!("Couldn't create directory `{}`: {e}", CONFIG_PATH.display()));
// Initialize git repo
Command::new("git")
.current_dir(CONFIG_PATH.as_path())
.args(["init"])
.status()
.expect("Couldn't initialize repository");
// Add this repo as remote
Command::new("git")
.current_dir(CONFIG_PATH.as_path())
.args(["remote", "add", "origin", REPO_URL])
.status()
.expect("Couldn't add remote");
// Enable sparse checkout
Command::new("git")
.current_dir(CONFIG_PATH.as_path())
.args(["config", "core.sparseCheckout", "true"])
.status()
.expect("Couldn't enable `core.sparseCheckout`");
// Add templates to sparse-checkout
std::fs::write(
CONFIG_PATH
.join(".git")
.join("info")
.join("sparse-checkout"),
"templates/*",
)
.unwrap_or_else(|e| {
panic!(
"Couldn't write to {}: {e}",
CONFIG_PATH
.join(".git")
.join("info")
.join("sparse-checkout")
.display()
)
});
Command::new("echo")
.current_dir(CONFIG_PATH.as_path())
.args(["templates/*", ">>", ".git/info/sparse-checkout"])
.status()
.expect("Couldn't add templates to `.git/info/sparse-checkout`");
// Pull
Command::new("git")
.current_dir(CONFIG_PATH.as_path())
.args(["pull", "--depth=1", "origin", "main"])
.status()
.expect("Couldn't pull");
println!("Cuteness was successfully configured!");
}
#[inline]
pub fn check_for_updates() {
Command::new("git")
.current_dir(CONFIG_PATH.as_path())
.args(["pull", "--depth=1", "origin", "main", "--rebase"])
.status()
.expect("Couldn't pull");
println!("Repository updated!");
}
#[inline]
pub fn uninstall() {
let config_path = CONFIG_PATH.as_path();
if config_path.exists() {
remove_dir_all(config_path).unwrap_or_else(|e| {
panic!(
"Couldn't remove directory {}: {e}",
<&Path>::clone(&config_path).display()
)
});
}
}
pub fn init() {
create_dir("src").unwrap_or_else(|e| panic!("Couldn't create directory 'src': {e}"));
std::fs::write(
"cuteconfig.toml",
include_bytes!("../defaults/cuteconfig.toml"),
)
.unwrap_or_else(|e| panic!("Couldn't create `cuteconfig.toml`: {e}"));
std::fs::write("SUMMARY.toml", include_bytes!("../defaults/SUMMARY.toml"))
.unwrap_or_else(|e| panic!("Couldn't create `SUMMARY.md`: {e}"));
std::fs::write(
"src/introduction.md",
include_bytes!("../defaults/introduction.md"),
)
.unwrap_or_else(|e| panic!("Couldn't create `src/introduction.md`: {e}"));
}
/// As the feature "sass" is enabled, we're going to let Sass take care of the job.
#[cfg(feature = "sass")]
#[cold]
#[inline(never)]
pub fn compile_styles(outdir: &str, sass_bin: &str) -> anyhow::Result<()> {
// Compile custom styles
Command::new(sass_bin)
.arg(format!("src/styles:{}", &outdir))
.status()?;
Ok(())
}
/// As the feature "sass" isn't activated, all `.sass` (actually, all not `.css`) files are ignored. `*.css` files are copied to the output directory `styles` subdirectory.
#[cfg(not(feature = "sass"))]
#[cold]
#[inline(never)]
pub fn compile_styles(indir: &str, outdir: &str) {
// Just move the files to the new directory
let paths = fs::read_dir("src/styles").context("Couldn't open directory `src/styles`")?;
for path in paths {
let path = path.context("Couldn't process a path in directory")?;
if !Path::new(&outdir).exists() {
fs::create_dir(&outdir)
.with_context(|| format!("Couldn't create directory {}", &outdir));
}
let mut f = File::create(format!(
"{}/{}",
&outdir,
&path.file_name().to_string_lossy()
))
.with_context(|| {
format!(
"Couldn't open file `{}/{}`: {e}",
&outdir,
&path.file_name().to_string_lossy()
)
})?;
if path.file_name().to_string_lossy().ends_with(".css") {
f.write_if_different(
fs::read_to_string(path.path())
.context("Couldn't read path")?
.as_bytes(),
format!("{}/static", &path.path().to_string_lossy()),
)
}
}
}
#[derive(Serialize, Deserialize, PartialEq, Default)]
pub enum Method {
#[default]
GET,
POST,
}
pub fn parse_admonish(admonish: &str, reg: &handlebars::Handlebars) -> Result<Option<String>> {
let split = admonish.split_whitespace().collect::<Vec<&str>>();
if !(split[0] == "admonish") {
return Ok(None);
};
let kind;
let title;
if split.len() == 1 {
kind = "note";
} else {
kind = parse_admonishkind(split[1]);
}
if split.len() < 3 {
title = String::from("Note")
} else {
title = split[2..].join(" ");
}
let template = reg.render_template(
&std::fs::read_to_string(&format!(
"{}/templates/admonish.html.hbs",
CONFIG_PATH.display(),
))
.with_context(|| {
format!("Couldn't read file <CONFIG PATH>/templates/admonish.html.hbs",)
})?,
&json!({
"title": title,
"kind": kind
}),
)?;
Ok(Some(template))
}
fn parse_admonishkind(s: &str) -> &str {
match s.to_lowercase().as_str() {
"info" => s,
"warning" => s,
"example" => s,
"tip" => s,
"bug" => s,
"tldr" => s,
"done" => s,
"help" => s,
"fail" => s,
"danger" => s,
"quote" => s,
_ => "note",
}
}