Add feature flags to reduce dependencies

.gitignore

@@ -25,3 +25,5 @@ stage
 
 # nixos dependencies snippet
 shell.nix
+# vim temporary files
+**/.*.sw*

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.10.0 (unreleased)
+
+### Breaking
+- Remove `toc` variable in section/page context and pass it to `page.toc` and `section.toc` instead so they are
+accessible everywhere
+- [Slugification](https://en.wikipedia.org/wiki/Slug_(web_publishing)#Slug) of page paths is now optional. By default, every path will be slugified as it is happening right now.
+To keep non-ASCII characters,  set `slugify_paths = true` in your config.
+
+### Other
+- Add zenburn syntax highlighting theme
+- Fix `zola init .`
+- Add `total_pages` to paginator
+- Do not prepend URL prefix to links that start with a scheme
+- Allow skipping anchor checking in `zola check` for some URL prefixes
+- Allow skipping prefixes in `zola check`
+- Check for path collisions when building the site
+
 ## 0.9.0 (2019-09-28)
 
 ### Breaking

Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name = "zola"
-version = "0.9.0"
+version = "0.10.0"
 authors = ["Vincent Prouillet <[email protected]>"]
+edition = "2018"
 license = "MIT"
 readme = "README.md"
 description = "A fast static site generator with everything built-in"
@@ -16,6 +17,20 @@ clap = "2"
 [[bin]]
 name = "zola"
 
+[features]
+default = ["request", "serve"]
+request = ["rebuild/request", "site/request"]
+serve = [
+    "hyper",
+    "hyper-staticfile",
+    "tokio",
+    "notify",
+    "ws",
+    "ctrlc",
+    "open",
+    "globset",
+]
+
 [dependencies]
 atty = "0.2.11"
 clap = "2"
@@ -25,19 +40,20 @@ termcolor = "1.0.4"
 # Used in init to ensure the url given as base_url is a valid one
 url = "2"
 # Below is for the serve cmd
-actix-files = "0.1"
-actix-web = { version = "1.0", default-features = false, features = [] }
-notify = "4"
-ws = "0.9"
-ctrlc = "3"
-open = "1.2"
-globset = "0.4"
+hyper = { version = "0.13", default-features = false, features = ["runtime"], optional = true }
+hyper-staticfile = { version = "0.5", optional = true }
+tokio = { version = "0.2", default-features = false, features = [], optional = true }
+notify = { version = "4", optional = true }
+ws = { version = "0.9", optional = true }
+ctrlc = { version = "3", optional = true }
+open = { version = "1.2", optional = true }
+globset = { version = "0.4", optional = true }
 
-site = { path = "components/site" }
+site = { path = "components/site", default-features = false }
 errors = { path = "components/errors" }
 front_matter = { path = "components/front_matter" }
 utils = { path = "components/utils" }
-rebuild = { path = "components/rebuild" }
+rebuild = { path = "components/rebuild", default-features = false }
 
 [workspace]
 members = [

EXAMPLES.md

@@ -24,3 +24,4 @@
 | [maxdeviant.com](https://maxdeviant.com/)                          |                                                      |
 | [Uwes Blog](https://uwe-arzt.de)                                   | https://github.com/uwearzt/site-uwe-arzt             |
 | [ozkriff.games](https://ozkriff.games)                             | https://github.com/ozkriff/ozkriff.github.io-src     |
+| [Sylvain Kerkour](https://kerkour.fr)                              | https://gitlab.com/z0mbie42/kerkour.fr               |

azure-pipelines.yml

@@ -19,9 +19,9 @@ stages:
             linux-stable:
               imageName: 'ubuntu-16.04'
               rustup_toolchain: stable
-            linux-1.35:
+            linux-1.39:
               imageName: 'ubuntu-16.04'
-              rustup_toolchain: 1.35.0
+              rustup_toolchain: 1.39.0
         pool:
           vmImage: $(imageName)
         steps:

build.rs

@@ -1,6 +1,3 @@
-#[macro_use]
-extern crate clap;
-
 // use clap::Shell;
 
 include!("src/cli.rs");

components/config/Cargo.toml

@@ -2,6 +2,7 @@
 name = "config"
 version = "0.1.0"
 authors = ["Vincent Prouillet <[email protected]>"]
+edition = "2018"
 
 [dependencies]
 toml = "0.5"

components/config/examples/generate_sublime.rs

@@ -2,8 +2,11 @@
 //! syntect, not as a helpful example for beginners.
 //! Although it is a valid example for serializing syntaxes, you probably won't need
 //! to do this yourself unless you want to cache your own compiled grammars.
-extern crate syntect;
+
+use std::collections::HashMap;
+use std::collections::HashSet;
 use std::env;
+use std::iter::FromIterator;
 use syntect::dumps::*;
 use syntect::highlighting::ThemeSet;
 use syntect::parsing::SyntaxSetBuilder;
@@ -26,10 +29,25 @@ fn main() {
             builder.add_from_folder(package_dir, true).unwrap();
             let ss = builder.build();
             dump_to_file(&ss, packpath_newlines).unwrap();
+            let mut syntaxes: HashMap<String, HashSet<String>> = HashMap::new();
 
-            for s in ss.syntaxes() {
-                if !s.file_extensions.is_empty() {
-                    println!("- {} -> {:?}", s.name, s.file_extensions);
+            for s in ss.syntaxes().iter() {
+                syntaxes
+                    .entry(s.name.clone())
+                    .and_modify(|e| {
+                        for ext in &s.file_extensions {
+                            e.insert(ext.clone());
+                        }
+                    })
+                    .or_insert_with(|| HashSet::from_iter(s.file_extensions.iter().cloned()));
+            }
+            let mut keys = syntaxes.keys().collect::<Vec<_>>();
+            keys.sort_by(|a, b| a.to_lowercase().cmp(&b.to_lowercase()));
+            for k in keys {
+                if !syntaxes[k].is_empty() {
+                    let mut extensions_sorted = syntaxes[k].iter().cloned().collect::<Vec<_>>();
+                    extensions_sorted.sort();
+                    println!("- {} -> {:?}", k, extensions_sorted);
                 }
             }
         }

components/config/src/config.rs

@@ -3,14 +3,14 @@ use std::path::{Path, PathBuf};
 
 use chrono::Utc;
 use globset::{Glob, GlobSet, GlobSetBuilder};
+use serde_derive::{Deserialize, Serialize};
 use syntect::parsing::{SyntaxSet, SyntaxSetBuilder};
 use toml;
 use toml::Value as Toml;
 
-use errors::Result;
-use errors::Error;
-use highlighting::THEME_SET;
-use theme::Theme;
+use crate::highlighting::THEME_SET;
+use crate::theme::Theme;
+use errors::{bail, Error, Result};
 use utils::fs::read_file_with_error;
 
 // We want a default base url for tests
@@ -86,7 +86,22 @@ impl Default for Taxonomy {
     }
 }
 
-type TranslateTerm  = HashMap<String, String>;
+type TranslateTerm = HashMap<String, String>;
+
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(default)]
+pub struct LinkChecker {
+    /// Skip link checking for these URL prefixes
+    pub skip_prefixes: Vec<String>,
+    /// Skip anchor checking for these URL prefixes
+    pub skip_anchor_prefixes: Vec<String>,
+}
+
+impl Default for LinkChecker {
+    fn default() -> LinkChecker {
+        LinkChecker { skip_prefixes: Vec::new(), skip_anchor_prefixes: Vec::new() }
+    }
+}
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[serde(default)]
@@ -115,6 +130,8 @@ pub struct Config {
     /// key into different language.
     translations: HashMap<String, TranslateTerm>,
 
+    /// Whether to slugify page and taxonomy URLs (disable for UTF-8 URLs)
+    pub slugify_paths: bool,
     /// Whether to highlight all code blocks found in markdown files. Defaults to false
     pub highlight_code: bool,
     /// Which themes to use for code highlighting. See Readme for supported themes
@@ -152,6 +169,8 @@ pub struct Config {
     #[serde(skip_serializing, skip_deserializing)] // not a typo, 2 are need
     pub extra_syntax_set: Option<SyntaxSet>,
 
+    pub link_checker: LinkChecker,
+
     /// All user params set in [extra] in the config
     pub extra: HashMap<String, Toml>,
 
@@ -317,9 +336,16 @@ impl Config {
             Error::msg(format!("Translation for language '{}' is missing", lang.as_ref()))
         })?;
 
-        terms.get(key.as_ref()).ok_or_else(|| {
-            Error::msg(format!("Translation key '{}' for language '{}' is missing", key.as_ref(), lang.as_ref()))
-        }).map(|term| term.to_string())
+        terms
+            .get(key.as_ref())
+            .ok_or_else(|| {
+                Error::msg(format!(
+                    "Translation key '{}' for language '{}' is missing",
+                    key.as_ref(),
+                    lang.as_ref()
+                ))
+            })
+            .map(|term| term.to_string())
     }
 }
 
@@ -330,6 +356,7 @@ impl Default for Config {
             title: None,
             description: None,
             theme: None,
+            slugify_paths: true,
             highlight_code: false,
             highlight_theme: "base16-ocean-dark".to_string(),
             default_language: "en".to_string(),
@@ -346,6 +373,7 @@ impl Default for Config {
             translations: HashMap::new(),
             extra_syntaxes: Vec::new(),
             extra_syntax_set: None,
+            link_checker: LinkChecker::default(),
             extra: HashMap::new(),
             build_timestamp: Some(1),
         }
@@ -551,4 +579,44 @@ ignored_content = ["*.{graphml,iso}", "*.py?"]
         assert!(g.is_match("foo.py3"));
         assert!(!g.is_match("foo.py"));
     }
+
+    #[test]
+    fn link_checker_skip_anchor_prefixes() {
+        let config_str = r#"
+title = "My site"
+base_url = "example.com"
+
+[link_checker]
+skip_anchor_prefixes = [
+    "https://caniuse.com/#feat=",
+    "https://github.com/rust-lang/rust/blob/",
+]
+        "#;
+
+        let config = Config::parse(config_str).unwrap();
+        assert_eq!(
+            config.link_checker.skip_anchor_prefixes,
+            vec!["https://caniuse.com/#feat=", "https://github.com/rust-lang/rust/blob/"]
+        );
+    }
+
+    #[test]
+    fn link_checker_skip_prefixes() {
+        let config_str = r#"
+title = "My site"
+base_url = "example.com"
+
+[link_checker]
+skip_prefixes = [
+    "http://[2001:db8::]/",
+    "https://www.example.com/path",
+]
+        "#;
+
+        let config = Config::parse(config_str).unwrap();
+        assert_eq!(
+            config.link_checker.skip_prefixes,
+            vec!["http://[2001:db8::]/", "https://www.example.com/path",]
+        );
+    }
 }

components/config/src/highlighting.rs

@@ -1,9 +1,10 @@
+use lazy_static::lazy_static;
 use syntect::dumps::from_binary;
 use syntect::easy::HighlightLines;
 use syntect::highlighting::ThemeSet;
 use syntect::parsing::SyntaxSet;
 
-use Config;
+use crate::config::Config;
 
 lazy_static! {
     pub static ref SYNTAX_SET: SyntaxSet = {

components/config/src/lib.rs

@@ -1,20 +1,7 @@
-#[macro_use]
-extern crate serde_derive;
-extern crate chrono;
-extern crate globset;
-extern crate toml;
-#[macro_use]
-extern crate lazy_static;
-extern crate syntect;
-
-#[macro_use]
-extern crate errors;
-extern crate utils;
-
 mod config;
 pub mod highlighting;
 mod theme;
-pub use config::{Config, Language, Taxonomy};
+pub use crate::config::{Config, Language, LinkChecker, Taxonomy};
 
 use std::path::Path;
 

components/config/src/theme.rs

@@ -1,9 +1,10 @@
 use std::collections::HashMap;
 use std::path::PathBuf;
 
+use serde_derive::{Deserialize, Serialize};
 use toml::Value as Toml;
 
-use errors::Result;
+use errors::{bail, Result};
 use utils::fs::read_file_with_error;
 
 /// Holds the data from a `theme.toml` file.

components/errors/Cargo.toml

@@ -2,9 +2,10 @@
 name = "errors"
 version = "0.1.0"
 authors = ["Vincent Prouillet <[email protected]>"]
+edition = "2018"
 
 [dependencies]
-tera = "1.0.0-beta.10"
+tera = "1"
 toml = "0.5"
 image = "0.22"
 syntect = "=3.2.0"

components/errors/src/lib.rs

@@ -1,8 +1,3 @@
-extern crate image;
-extern crate syntect;
-extern crate tera;
-extern crate toml;
-
 use std::convert::Into;
 use std::error::Error as StdError;
 use std::fmt;
@@ -63,6 +58,18 @@ impl Error {
     pub fn chain(value: impl ToString, source: impl Into<Box<dyn StdError>>) -> Self {
         Self { kind: ErrorKind::Msg(value.to_string()), source: Some(source.into()) }
     }
+
+    /// Create an error from a list of path collisions, formatting the output
+    pub fn from_collisions(collisions: Vec<(&str, Vec<String>)>) -> Self {
+        let mut msg = String::from("Found path collisions:\n");
+
+        for (path, filepaths) in collisions {
+            let row = format!("- `{}` from files {:?}\n", path, filepaths);
+            msg.push_str(&row);
+        }
+
+        Self { kind: ErrorKind::Msg(msg), source: None }
+    }
 }
 
 impl From<&str> for Error {