commit 9a474b7fd51fe8243c2f14c377cb8e28f51c8d95 Author: liv Date: Sun Mar 19 17:13:00 2023 +0100 feat: reconstruct shtola source diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6305d96 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +target/ + +.DS_Store +dest/ diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..1f14bef --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,1310 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 3 + +[[package]] +name = "adler" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe" + +[[package]] +name = "aho-corasick" +version = "0.7.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc936419f96fa211c1b9166887b38e5e40b19958e5b895be7c1f93adec7071ac" +dependencies = [ + "memchr", +] + +[[package]] +name = "android_system_properties" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "819e7219dbd41043ac279b19830f2efc897156490d7fd6ea916720117ee66311" +dependencies = [ + "libc", +] + +[[package]] +name = "ansi_term" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d52a9bb7ec0cf484c551830a7ce27bd20d67eac647e1befb56b0be4ee39a55d2" +dependencies = [ + "winapi", +] + +[[package]] +name = "atty" +version = "0.2.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8" +dependencies = [ + "hermit-abi", + "libc", + "winapi", +] + +[[package]] +name = "autocfg" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" + +[[package]] +name = "base64" +version = "0.21.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a4a4ddaa51a5bc52a6948f74c06d20aaaddb71924eab79b8c97a8c556e942d6a" + +[[package]] +name = "bincode" +version = "1.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1f45e9417d87227c7a56d22e471c6206462cba514c7590c09aff4cf6d1ddcad" +dependencies = [ + "serde", +] + +[[package]] +name = "bitflags" +version = "1.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" + +[[package]] +name = "block-buffer" +version = "0.10.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71" +dependencies = [ + "generic-array", +] + +[[package]] +name = "bstr" +version = "1.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3d4260bcc2e8fc9df1eac4919a720effeb63a3f0952f5bf4944adfa18897f09" +dependencies = [ + "memchr", + "serde", +] + +[[package]] +name = "bumpalo" +version = "3.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d261e256854913907f67ed06efbc3338dfe6179796deefc1ff763fc1aee5535" + +[[package]] +name = "cc" +version = "1.0.79" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "50d30906286121d95be3d479533b458f87493b30a4b5f79a607db8f5d11aa91f" + +[[package]] +name = "cfg-if" +version = "0.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4785bdd1c96b2a846b2bd7cc02e86b6b3dbf14e7e53446c4f54c92a361040822" + +[[package]] +name = "cfg-if" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" + +[[package]] +name = "chrono" +version = "0.4.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e3c5919066adf22df73762e50cffcde3a758f2a848b113b586d1f86728b673b" +dependencies = [ + "iana-time-zone", + "num-integer", + "num-traits", + "winapi", +] + +[[package]] +name = "chrono-tz" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2554a3155fec064362507487171dcc4edc3df60cb10f3a1fb10ed8094822b120" +dependencies = [ + "chrono", + "parse-zoneinfo", +] + +[[package]] +name = "clap" +version = "2.34.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a0610544180c38b88101fecf2dd634b174a62eef6946f84dfc6a7127512b381c" +dependencies = [ + "ansi_term", + "atty", + "bitflags", + "strsim", + "textwrap", + "unicode-width", + "vec_map", +] + +[[package]] +name = "codespan-reporting" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3538270d33cc669650c4b093848450d380def10c331d38c768e34cac80576e6e" +dependencies = [ + "termcolor", + "unicode-width", +] + +[[package]] +name = "comrak" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff3c476e1a33eb4df1212a02db79d0f788bbd760901f34f5897644623e0e4e74" +dependencies = [ + "clap", + "entities", + "lazy_static", + "pest", + "pest_derive", + "regex", + "shell-words", + "syntect", + "twoway", + "typed-arena", + "unicode_categories", + "xdg", +] + +[[package]] +name = "core-foundation-sys" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5827cebf4670468b8772dd191856768aedcb1b0278a04f989f7766351917b9dc" + +[[package]] +name = "cpufeatures" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "28d997bd5e24a5928dd43e46dc529867e207907fe0b239c3477d924f7f2ca320" +dependencies = [ + "libc", +] + +[[package]] +name = "crc32fast" +version = "1.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b540bd8bc810d3885c6ea91e2018302f68baba2129ab3e88f32389ee9370880d" +dependencies = [ + "cfg-if 1.0.0", +] + +[[package]] +name = "crypto-common" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1bfb12502f3fc46cca1bb51ac28df9d618d813cdc3d2f25b9fe775a34af26bb3" +dependencies = [ + "generic-array", + "typenum", +] + +[[package]] +name = "ctor" +version = "0.1.26" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6d2301688392eb071b0bf1a37be05c469d3cc4dbbd95df672fe28ab021e6a096" +dependencies = [ + "quote", + "syn 1.0.109", +] + +[[package]] +name = "cxx" +version = "1.0.93" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a9c00419335c41018365ddf7e4d5f1c12ee3659ddcf3e01974650ba1de73d038" +dependencies = [ + "cc", + "cxxbridge-flags", + "cxxbridge-macro", + "link-cplusplus", +] + +[[package]] +name = "cxx-build" +version = "1.0.93" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fb8307ad413a98fff033c8545ecf133e3257747b3bae935e7602aab8aa92d4ca" +dependencies = [ + "cc", + "codespan-reporting", + "once_cell", + "proc-macro2", + "quote", + "scratch", + "syn 2.0.2", +] + +[[package]] +name = "cxxbridge-flags" +version = "1.0.93" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "edc52e2eb08915cb12596d29d55f0b5384f00d697a646dbd269b6ecb0fbd9d31" + +[[package]] +name = "cxxbridge-macro" +version = "1.0.93" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "631569015d0d8d54e6c241733f944042623ab6df7bc3be7466874b05fcdb1c5f" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.2", +] + +[[package]] +name = "deunicode" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "850878694b7933ca4c9569d30a34b55031b9b139ee1fc7b94a527c4ef960d690" + +[[package]] +name = "digest" +version = "0.10.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8168378f4e5023e7218c89c891c0fd8ecdb5e5e4f18cb78f38cf245dd021e76f" +dependencies = [ + "block-buffer", + "crypto-common", +] + +[[package]] +name = "dirs" +version = "4.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca3aa72a6f96ea37bbc5aa912f6788242832f75369bdfdadcb0e38423f100059" +dependencies = [ + "dirs-sys", +] + +[[package]] +name = "dirs-sys" +version = "0.3.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1b1d1d91c932ef41c0f2663aa8b0ca0342d444d842c06914aa0a7e352d0bada6" +dependencies = [ + "libc", + "redox_users", + "winapi", +] + +[[package]] +name = "entities" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b5320ae4c3782150d900b79807611a59a99fc9a1d61d686faafc24b93fc8d7ca" + +[[package]] +name = "flate2" +version = "1.0.25" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a8a2db397cb1c8772f31494cb8917e48cd1e64f0fa7efac59fbd741a0a8ce841" +dependencies = [ + "crc32fast", + "miniz_oxide", +] + +[[package]] +name = "fnv" +version = "1.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1" + +[[package]] +name = "generic-array" +version = "0.14.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bff49e947297f3312447abdca79f45f4738097cc82b06e72054d2223f601f1b9" +dependencies = [ + "typenum", + "version_check", +] + +[[package]] +name = "getrandom" +version = "0.2.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c05aeb6a22b8f62540c194aac980f2115af067bfe15a0734d7277a768d396b31" +dependencies = [ + "cfg-if 1.0.0", + "libc", + "wasi", +] + +[[package]] +name = "globset" +version = "0.4.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "029d74589adefde59de1a0c4f4732695c32805624aec7b68d91503d4dba79afc" +dependencies = [ + "aho-corasick", + "bstr", + "fnv", + "log", + "regex", +] + +[[package]] +name = "globwalk" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93e3af942408868f6934a7b85134a3230832b9977cf66125df2f9edcfce4ddcc" +dependencies = [ + "bitflags", + "ignore", + "walkdir", +] + +[[package]] +name = "hashbrown" +version = "0.12.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888" + +[[package]] +name = "hermit-abi" +version = "0.1.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "62b467343b94ba476dcb2500d242dadbb39557df889310ac77c5d99100aaac33" +dependencies = [ + "libc", +] + +[[package]] +name = "humansize" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "02296996cb8796d7c6e3bc2d9211b7802812d36999a51bb754123ead7d37d026" + +[[package]] +name = "iana-time-zone" +version = "0.1.53" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "64c122667b287044802d6ce17ee2ddf13207ed924c712de9a66a5814d5b64765" +dependencies = [ + "android_system_properties", + "core-foundation-sys", + "iana-time-zone-haiku", + "js-sys", + "wasm-bindgen", + "winapi", +] + +[[package]] +name = "iana-time-zone-haiku" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0703ae284fc167426161c2e3f1da3ea71d94b21bedbcc9494e92b28e334e3dca" +dependencies = [ + "cxx", + "cxx-build", +] + +[[package]] +name = "id_tree" +version = "1.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bcd9db8dd5be8bde5a2624ed4b2dfb74368fe7999eb9c4940fd3ca344b61071a" +dependencies = [ + "snowflake", +] + +[[package]] +name = "ignore" +version = "0.4.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dbe7873dab538a9a44ad79ede1faf5f30d49f9a5c883ddbab48bce81b64b7492" +dependencies = [ + "globset", + "lazy_static", + "log", + "memchr", + "regex", + "same-file", + "thread_local", + "walkdir", + "winapi-util", +] + +[[package]] +name = "indexmap" +version = "1.9.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1885e79c1fc4b10f0e172c475f458b7f7b93061064d98c3293e98c5ba0c8b399" +dependencies = [ + "autocfg", + "hashbrown", +] + +[[package]] +name = "itoa" +version = "1.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "453ad9f582a441959e5f0d088b02ce04cfe8d51a8eaf077f12ac6d3e94164ca6" + +[[package]] +name = "js-sys" +version = "0.3.61" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "445dde2150c55e483f3d8416706b97ec8e8237c307e5b7b4b8dd15e6af2a0730" +dependencies = [ + "wasm-bindgen", +] + +[[package]] +name = "lazy_static" +version = "1.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646" + +[[package]] +name = "lazycell" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "830d08ce1d1d941e6b30645f1a0eb5643013d835ce3779a5fc208261dbe10f55" + +[[package]] +name = "libc" +version = "0.2.140" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "99227334921fae1a979cf0bfdfcc6b3e5ce376ef57e16fb6fb3ea2ed6095f80c" + +[[package]] +name = "line-wrap" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f30344350a2a51da54c1d53be93fade8a237e545dbcc4bdbe635413f2117cab9" +dependencies = [ + "safemem", +] + +[[package]] +name = "link-cplusplus" +version = "1.0.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ecd207c9c713c34f95a097a5b029ac2ce6010530c7b49d7fea24d977dede04f5" +dependencies = [ + "cc", +] + +[[package]] +name = "linked-hash-map" +version = "0.5.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0717cef1bc8b636c6e1c1bbdefc09e6322da8a9321966e8928ef80d20f7f770f" + +[[package]] +name = "log" +version = "0.4.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "abb12e687cfb44aa40f41fc3978ef76448f9b6038cad6aef4259d3c095a2382e" +dependencies = [ + "cfg-if 1.0.0", + "value-bag", +] + +[[package]] +name = "memchr" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d" + +[[package]] +name = "minifemme" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "be021794bb7965e43d1d41868cd875ac9002693a6335b83de33b88c979ed0b88" +dependencies = [ + "cfg-if 0.1.10", + "js-sys", + "log", + "serde", + "serde_derive", + "serde_json", + "wasm-bindgen", + "web-sys", +] + +[[package]] +name = "miniz_oxide" +version = "0.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b275950c28b37e794e8c55d88aeb5e139d0ce23fdbbeda68f8d7174abdf9e8fa" +dependencies = [ + "adler", +] + +[[package]] +name = "num-integer" +version = "0.1.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "225d3389fb3509a24c93f5c29eb6bde2586b98d9f016636dff58d7c6f7569cd9" +dependencies = [ + "autocfg", + "num-traits", +] + +[[package]] +name = "num-traits" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "578ede34cf02f8924ab9447f50c28075b4d3e5b269972345e7e0372b38c6cdcd" +dependencies = [ + "autocfg", +] + +[[package]] +name = "once_cell" +version = "1.17.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7e5500299e16ebb147ae15a00a942af264cf3688f47923b8fc2cd5858f23ad3" + +[[package]] +name = "onig" +version = "6.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8c4b31c8722ad9171c6d77d3557db078cab2bd50afcc9d09c8b315c59df8ca4f" +dependencies = [ + "bitflags", + "libc", + "once_cell", + "onig_sys", +] + +[[package]] +name = "onig_sys" +version = "69.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b829e3d7e9cc74c7e315ee8edb185bf4190da5acde74afd7fc59c35b1f086e7" +dependencies = [ + "cc", + "pkg-config", +] + +[[package]] +name = "parse-zoneinfo" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c705f256449c60da65e11ff6626e0c16a0a0b96aaa348de61376b249bc340f41" +dependencies = [ + "regex", +] + +[[package]] +name = "pathdiff" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8835116a5c179084a830efb3adc117ab007512b535bc1a21c991d3b32a6b44dd" + +[[package]] +name = "percent-encoding" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "478c572c3d73181ff3c2539045f6eb99e5491218eae919370993b890cdbdd98e" + +[[package]] +name = "pest" +version = "2.5.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8cbd939b234e95d72bc393d51788aec68aeeb5d51e748ca08ff3aad58cb722f7" +dependencies = [ + "thiserror", + "ucd-trie", +] + +[[package]] +name = "pest_derive" +version = "2.5.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a81186863f3d0a27340815be8f2078dd8050b14cd71913db9fbda795e5f707d7" +dependencies = [ + "pest", + "pest_generator", +] + +[[package]] +name = "pest_generator" +version = "2.5.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "75a1ef20bf3193c15ac345acb32e26b3dc3223aff4d77ae4fc5359567683796b" +dependencies = [ + "pest", + "pest_meta", + "proc-macro2", + "quote", + "syn 1.0.109", +] + +[[package]] +name = "pest_meta" +version = "2.5.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e3b284b1f13a20dc5ebc90aff59a51b8d7137c221131b52a7260c08cbc1cc80" +dependencies = [ + "once_cell", + "pest", + "sha2", +] + +[[package]] +name = "pkg-config" +version = "0.3.26" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ac9a59f73473f1b8d852421e59e64809f025994837ef743615c6d0c5b305160" + +[[package]] +name = "plist" +version = "1.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9bd9647b268a3d3e14ff09c23201133a62589c658db02bb7388c7246aafe0590" +dependencies = [ + "base64", + "indexmap", + "line-wrap", + "quick-xml", + "serde", + "time", +] + +[[package]] +name = "ppv-lite86" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5b40af805b3121feab8a3c29f04d8ad262fa8e0561883e7653e024ae4479e6de" + +[[package]] +name = "proc-macro2" +version = "1.0.52" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d0e1ae9e836cc3beddd63db0df682593d7e2d3d891ae8c9083d2113e1744224" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quick-xml" +version = "0.28.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5c1a97b1bc42b1d550bfb48d4262153fe400a12bab1511821736f7eac76d7e2" +dependencies = [ + "memchr", +] + +[[package]] +name = "quote" +version = "1.0.26" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4424af4bf778aae2051a77b60283332f386554255d722233d09fbfc7e30da2fc" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "rand" +version = "0.8.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "34af8d1a0e25924bc5b7c43c079c942339d8f0a8b57c39049bef581b46327404" +dependencies = [ + "libc", + "rand_chacha", + "rand_core", +] + +[[package]] +name = "rand_chacha" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88" +dependencies = [ + "ppv-lite86", + "rand_core", +] + +[[package]] +name = "rand_core" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c" +dependencies = [ + "getrandom", +] + +[[package]] +name = "redox_syscall" +version = "0.2.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fb5a58c1855b4b6819d59012155603f0b22ad30cad752600aadfcb695265519a" +dependencies = [ + "bitflags", +] + +[[package]] +name = "redox_users" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b033d837a7cf162d7993aded9304e30a83213c648b6e389db233191f891e5c2b" +dependencies = [ + "getrandom", + "redox_syscall", + "thiserror", +] + +[[package]] +name = "regex" +version = "1.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "48aaa5748ba571fb95cd2c85c09f629215d3a6ece942baa100950af03a34f733" +dependencies = [ + "aho-corasick", + "memchr", + "regex-syntax", +] + +[[package]] +name = "regex-syntax" +version = "0.6.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "456c603be3e8d448b072f410900c09faf164fbce2d480456f50eea6e25f9c848" + +[[package]] +name = "ryu" +version = "1.0.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f91339c0467de62360649f8d3e185ca8de4224ff281f66000de5eb2a77a79041" + +[[package]] +name = "safemem" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ef703b7cb59335eae2eb93ceb664c0eb7ea6bf567079d843e09420219668e072" + +[[package]] +name = "same-file" +version = "1.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93fc1dc3aaa9bfed95e02e6eadabb4baf7e3078b0bd1b4d7b6b0b68378900502" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "scratch" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1792db035ce95be60c3f8853017b3999209281c24e2ba5bc8e59bf97a0c590c1" + +[[package]] +name = "serde" +version = "1.0.157" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "707de5fcf5df2b5788fca98dd7eab490bc2fd9b7ef1404defc462833b83f25ca" + +[[package]] +name = "serde_derive" +version = "1.0.157" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78997f4555c22a7971214540c4a661291970619afd56de19f77e0de86296e1e5" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.2", +] + +[[package]] +name = "serde_json" +version = "1.0.94" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c533a59c9d8a93a09c6ab31f0fd5e5f4dd1b8fc9434804029839884765d04ea" +dependencies = [ + "itoa", + "ryu", + "serde", +] + +[[package]] +name = "serde_yaml" +version = "0.8.26" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "578a7433b776b56a35785ed5ce9a7e777ac0598aac5a6dd1b4b18a307c7fc71b" +dependencies = [ + "indexmap", + "ryu", + "serde", + "yaml-rust", +] + +[[package]] +name = "sha2" +version = "0.10.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82e6b795fe2e3b1e845bafcb27aa35405c4d47cdfc92af5fc8d3002f76cebdc0" +dependencies = [ + "cfg-if 1.0.0", + "cpufeatures", + "digest", +] + +[[package]] +name = "shell-words" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "24188a676b6ae68c3b2cb3a01be17fbf7240ce009799bb56d5b1409051e78fde" + +[[package]] +name = "shtola" +version = "0.4.2" +dependencies = [ + "comrak", + "globset", + "id_tree", + "log", + "minifemme", + "pathdiff", + "serde_json", + "serde_yaml", + "tera", + "walkdir", + "ware", +] + +[[package]] +name = "slug" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b3bc762e6a4b6c6fcaade73e77f9ebc6991b676f88bb2358bddb56560f073373" +dependencies = [ + "deunicode", +] + +[[package]] +name = "snowflake" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "27207bb65232eda1f588cf46db2fee75c0808d557f6b3cf19a75f5d6d7c94df1" + +[[package]] +name = "strsim" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ea5119cdb4c55b55d432abb513a0429384878c15dde60cc77b1c99de1a95a6a" + +[[package]] +name = "syn" +version = "1.0.109" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "syn" +version = "2.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "59d3276aee1fa0c33612917969b5172b5be2db051232a6e4826f1a1a9191b045" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "syntect" +version = "4.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8b20815bbe80ee0be06e6957450a841185fcf690fe0178f14d77a05ce2caa031" +dependencies = [ + "bincode", + "bitflags", + "flate2", + "fnv", + "lazy_static", + "lazycell", + "onig", + "plist", + "regex-syntax", + "serde", + "serde_derive", + "serde_json", + "walkdir", + "yaml-rust", +] + +[[package]] +name = "tera" +version = "1.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bf95b0d8a46da5fe3ea119394a6c7f1e745f9de359081641c99946e2bf55d4f2" +dependencies = [ + "chrono", + "chrono-tz", + "globwalk", + "humansize", + "lazy_static", + "percent-encoding", + "pest", + "pest_derive", + "rand", + "regex", + "serde", + "serde_json", + "slug", + "unic-segment", +] + +[[package]] +name = "termcolor" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "be55cf8942feac5c765c2c993422806843c9a9a45d4d5c407ad6dd2ea95eb9b6" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "textwrap" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d326610f408c7a4eb6f51c37c330e496b08506c9457c9d34287ecc38809fb060" +dependencies = [ + "unicode-width", +] + +[[package]] +name = "thiserror" +version = "1.0.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "978c9a314bd8dc99be594bc3c175faaa9794be04a5a5e153caba6915336cebac" +dependencies = [ + "thiserror-impl", +] + +[[package]] +name = "thiserror-impl" +version = "1.0.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f9456a42c5b0d803c8cd86e73dd7cc9edd429499f37a3550d286d5e86720569f" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.2", +] + +[[package]] +name = "thread_local" +version = "1.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3fdd6f064ccff2d6567adcb3873ca630700f00b5ad3f060c25b5dcfd9a4ce152" +dependencies = [ + "cfg-if 1.0.0", + "once_cell", +] + +[[package]] +name = "time" +version = "0.3.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cd0cbfecb4d19b5ea75bb31ad904eb5b9fa13f21079c3b92017ebdf4999a5890" +dependencies = [ + "itoa", + "serde", + "time-core", + "time-macros", +] + +[[package]] +name = "time-core" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2e153e1f1acaef8acc537e68b44906d2db6436e2b35ac2c6b42640fff91f00fd" + +[[package]] +name = "time-macros" +version = "0.2.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd80a657e71da814b8e5d60d3374fc6d35045062245d80224748ae522dd76f36" +dependencies = [ + "time-core", +] + +[[package]] +name = "twoway" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c57ffb460d7c24cd6eda43694110189030a3d1dfe418416d9468fd1c1d290b47" +dependencies = [ + "memchr", + "unchecked-index", +] + +[[package]] +name = "typed-arena" +version = "1.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a9b2228007eba4120145f785df0f6c92ea538f5a3635a612ecf4e334c8c1446d" + +[[package]] +name = "typenum" +version = "1.16.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "497961ef93d974e23eb6f433eb5fe1b7930b659f06d12dec6fc44a8f554c0bba" + +[[package]] +name = "ucd-trie" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9e79c4d996edb816c91e4308506774452e55e95c3c9de07b6729e17e15a5ef81" + +[[package]] +name = "unchecked-index" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "eeba86d422ce181a719445e51872fa30f1f7413b62becb52e95ec91aa262d85c" + +[[package]] +name = "unic-char-property" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a8c57a407d9b6fa02b4795eb81c5b6652060a15a7903ea981f3d723e6c0be221" +dependencies = [ + "unic-char-range", +] + +[[package]] +name = "unic-char-range" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0398022d5f700414f6b899e10b8348231abf9173fa93144cbc1a43b9793c1fbc" + +[[package]] +name = "unic-common" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "80d7ff825a6a654ee85a63e80f92f054f904f21e7d12da4e22f9834a4aaa35bc" + +[[package]] +name = "unic-segment" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e4ed5d26be57f84f176157270c112ef57b86debac9cd21daaabbe56db0f88f23" +dependencies = [ + "unic-ucd-segment", +] + +[[package]] +name = "unic-ucd-segment" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2079c122a62205b421f499da10f3ee0f7697f012f55b675e002483c73ea34700" +dependencies = [ + "unic-char-property", + "unic-char-range", + "unic-ucd-version", +] + +[[package]] +name = "unic-ucd-version" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96bd2f2237fe450fcd0a1d2f5f4e91711124f7857ba2e964247776ebeeb7b0c4" +dependencies = [ + "unic-common", +] + +[[package]] +name = "unicode-ident" +version = "1.0.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5464a87b239f13a63a501f2701565754bae92d243d4bb7eb12f6d57d2269bf4" + +[[package]] +name = "unicode-width" +version = "0.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c0edd1e5b14653f783770bce4a4dabb4a5108a5370a5f5d8cfe8710c361f6c8b" + +[[package]] +name = "unicode_categories" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "39ec24b3121d976906ece63c9daad25b85969647682eee313cb5779fdd69e14e" + +[[package]] +name = "value-bag" +version = "1.0.0-alpha.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2209b78d1249f7e6f3293657c9779fe31ced465df091bbd433a1cf88e916ec55" +dependencies = [ + "ctor", + "version_check", +] + +[[package]] +name = "vec_map" +version = "0.8.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1bddf1187be692e79c5ffeab891132dfb0f236ed36a43c7ed39f1165ee20191" + +[[package]] +name = "version_check" +version = "0.9.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" + +[[package]] +name = "walkdir" +version = "2.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "36df944cda56c7d8d8b7496af378e6b16de9284591917d307c9b4d313c44e698" +dependencies = [ + "same-file", + "winapi-util", +] + +[[package]] +name = "ware" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c620b6e5987577c1ecfab414d4b984617178a6bfee7b564b8e9dd449be5c934" + +[[package]] +name = "wasi" +version = "0.11.0+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423" + +[[package]] +name = "wasm-bindgen" +version = "0.2.84" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "31f8dcbc21f30d9b8f2ea926ecb58f6b91192c17e9d33594b3df58b2007ca53b" +dependencies = [ + "cfg-if 1.0.0", + "serde", + "serde_json", + "wasm-bindgen-macro", +] + +[[package]] +name = "wasm-bindgen-backend" +version = "0.2.84" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "95ce90fd5bcc06af55a641a86428ee4229e44e07033963a2290a8e241607ccb9" +dependencies = [ + "bumpalo", + "log", + "once_cell", + "proc-macro2", + "quote", + "syn 1.0.109", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-macro" +version = "0.2.84" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4c21f77c0bedc37fd5dc21f897894a5ca01e7bb159884559461862ae90c0b4c5" +dependencies = [ + "quote", + "wasm-bindgen-macro-support", +] + +[[package]] +name = "wasm-bindgen-macro-support" +version = "0.2.84" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2aff81306fcac3c7515ad4e177f521b5c9a15f2b08f4e32d823066102f35a5f6" +dependencies = [ + "proc-macro2", + "quote", + "syn 1.0.109", + "wasm-bindgen-backend", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-shared" +version = "0.2.84" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0046fef7e28c3804e5e38bfa31ea2a0f73905319b677e57ebe37e49358989b5d" + +[[package]] +name = "web-sys" +version = "0.3.61" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e33b99f4b23ba3eec1a53ac264e35a755f00e966e0065077d6027c0f575b0b97" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "winapi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" +dependencies = [ + "winapi-i686-pc-windows-gnu", + "winapi-x86_64-pc-windows-gnu", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" + +[[package]] +name = "winapi-util" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178" +dependencies = [ + "winapi", +] + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" + +[[package]] +name = "xdg" +version = "2.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c4583db5cbd4c4c0303df2d15af80f0539db703fa1c68802d4cbbd2dd0f88f6" +dependencies = [ + "dirs", +] + +[[package]] +name = "yaml-rust" +version = "0.4.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "56c1936c4cc7a1c9ab21a1ebb602eb942ba868cbd44a99cb7cdc5892335e1c85" +dependencies = [ + "linked-hash-map", +] diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..c96ef3f --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,4 @@ +[workspace] +members = [ + "shtola" +] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..77edddc --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + + Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + +The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + +0. Definitions. + +"This License" refers to version 3 of the GNU Affero General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + +An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +1. Source Code. + +The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + +The Corresponding Source for a work in source code form is that +same work. + +2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + +3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + +4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + +8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + +13. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + +17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + shtola and co: A static site generator and utilities + Copyright (C) 2023 Liv Hugger + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + +You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/fixtures/frontmatter/file.md b/fixtures/frontmatter/file.md new file mode 100644 index 0000000..80d984b --- /dev/null +++ b/fixtures/frontmatter/file.md @@ -0,0 +1,5 @@ +--- +hello: bro +--- + +hi diff --git a/fixtures/ignore/ignored.md b/fixtures/ignore/ignored.md new file mode 100644 index 0000000..e69de29 diff --git a/fixtures/ignore/not_ignored.md b/fixtures/ignore/not_ignored.md new file mode 100644 index 0000000..e69de29 diff --git a/fixtures/markdown/hello.md b/fixtures/markdown/hello.md new file mode 100644 index 0000000..f1749c8 --- /dev/null +++ b/fixtures/markdown/hello.md @@ -0,0 +1,3 @@ +# Hello! + +What's going _on_? diff --git a/fixtures/pretty_links/hi.html b/fixtures/pretty_links/hi.html new file mode 100644 index 0000000..e69de29 diff --git a/fixtures/pretty_links/subfolder/hello.html b/fixtures/pretty_links/subfolder/hello.html new file mode 100644 index 0000000..e69de29 diff --git a/fixtures/read_binary/my_binary b/fixtures/read_binary/my_binary new file mode 100644 index 0000000..3beeced Binary files /dev/null and b/fixtures/read_binary/my_binary differ diff --git a/fixtures/simple/hello.txt b/fixtures/simple/hello.txt new file mode 100644 index 0000000..32aad8c --- /dev/null +++ b/fixtures/simple/hello.txt @@ -0,0 +1 @@ +hi! diff --git a/fixtures/source_ignore/ignores b/fixtures/source_ignore/ignores new file mode 100644 index 0000000..2aaafc9 --- /dev/null +++ b/fixtures/source_ignore/ignores @@ -0,0 +1 @@ +one.txt diff --git a/fixtures/source_ignore/one.txt b/fixtures/source_ignore/one.txt new file mode 100644 index 0000000..e69de29 diff --git a/fixtures/source_ignore/two.txt b/fixtures/source_ignore/two.txt new file mode 100644 index 0000000..e69de29 diff --git a/fixtures/tera_layouts/3rdpage.html b/fixtures/tera_layouts/3rdpage.html new file mode 100644 index 0000000..e4618e7 --- /dev/null +++ b/fixtures/tera_layouts/3rdpage.html @@ -0,0 +1,5 @@ +--- +layout: root +--- + +

hiii

diff --git a/fixtures/tera_layouts/page.html b/fixtures/tera_layouts/page.html new file mode 100644 index 0000000..4f77d13 --- /dev/null +++ b/fixtures/tera_layouts/page.html @@ -0,0 +1,5 @@ +--- +layout: root +--- + +hello diff --git a/fixtures/tera_layouts/root.html b/fixtures/tera_layouts/root.html new file mode 100644 index 0000000..ae00184 --- /dev/null +++ b/fixtures/tera_layouts/root.html @@ -0,0 +1,7 @@ +--- +is_layout: true +--- + +

top layout

+ +{{content}} diff --git a/shtola/CHANGELOG.md b/shtola/CHANGELOG.md new file mode 100644 index 0000000..2ac0550 --- /dev/null +++ b/shtola/CHANGELOG.md @@ -0,0 +1,70 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [0.4.2] - 2021-11-10 + +### Changed + +- Enabled the Markdown processor to accept raw HTML. + +## [0.4.1] - 2021-11-10 + +### Fixed + +- Excluded existing `index.html` files from path rewriting. + +## [0.4.0] - 2021-11-10 + +### Added + +- Added a plugin to rewrite HTML files into `/index.html` paths. + +## [0.3.0] - 2021-11-09 + +### Added + +- Added Tera layouts support. +- Added this here changelog. +- Added a new function, `Shtola#source_ignores`, to load your ignores from + an external file (something like a .gitignore). +- Added the capability to read binary (e.g. non-UTF-8 encoded files), which stores + them in a new `ShFile` field: `raw_content`. If you want to exclude binaries, + filter out `file.raw_content.is_some()`. + +### Changed + +- The chosen destination is now always automatically ignored. + +### Fixed + +- Markdown: Improved the extension filter so that it doesn't panic every time it + finds a file without an extension (like dotfiles or just files without dots) + +## [0.2.1] - 2021-07-07 + +### Changed + +- Enabled docs.rs to build all features. + +## [0.2.0] - 2021-07-07 + +### Added + +- Implemented `Default` for `ShFile`. + +### Changed + +- Inlined plugins into the crate itself. This means that now, you control the plugins shtola comes with + not via installing extra crates, but via enabling crate features on the main `shtola` crate. This saves me + a stupid amount of maintenance overhead. +- Upgraded `ware` from 1.0 to 2.0. This is a larger refactor that changes the way shtola plugins work. For reference, + see the docs.rs page, examples and tests. +- Updated the main example to actually do something cool. It now pulls the system time. + +### Fixed + +- Removed a line break that caused the link to docs.rs to break. diff --git a/shtola/Cargo.toml b/shtola/Cargo.toml new file mode 100644 index 0000000..6ee5118 --- /dev/null +++ b/shtola/Cargo.toml @@ -0,0 +1,38 @@ +[package] +name = "shtola" +description = "Minimal static site generator" +version = "0.4.2" +authors = ["Liv "] +edition = "2021" +repository = "https://codeberg.org/shadows_withal/shtola" +documentation = "https://docs.rs/shtola" +homepage = "https://codeberg.org/shadows_withal/shtola" +readme = "README.md" +license = "AGPL-3.0-or-later" + +[features] +full = ["markdown", "tera_layouts"] +markdown = ["comrak"] +tera_layouts = ["tera", "id_tree"] + +[dependencies] +log = "~0.4" +walkdir = "~2.3" +ware = "~2.0" +pathdiff = "~0.2" +globset = "~0.4" +serde_json = "~1.0" +serde_yaml = "~0.8" + +# Markdown +comrak = { version = "~0.12", optional = true } + +# Tera Layouts +tera = { version = "~1.12", optional = true } +id_tree = { version = "~1.8", optional = true } + +[dev_dependencies] +minifemme = "~1.0" + +[package.metadata.docs.rs] +all-features = true diff --git a/shtola/README.md b/shtola/README.md new file mode 100644 index 0000000..0d5c0cc --- /dev/null +++ b/shtola/README.md @@ -0,0 +1,41 @@ +# shtola + +Shtola is a library for generic file processing. It enables you to build your +own applications that function as static site generators! Here's an example: + +```rust +use shtola::{Plugin, RefIR, ShFile, Shtola}; +use std::time::SystemTime; + +fn plugin() -> Plugin { + Box::new(|mut ir: RefIR| { + // Let's create our file in the IR (intermediate representation) file hash map! + let current_time = SystemTime::now(); + ir.files.insert( + "current_time.txt".into(), + ShFile { + content: format!("{:?}", current_time).into(), + ..ShFile::default() + }, + ); + }) +} + +fn main() { + let mut s = Shtola::new(); + s.source("fixtures/empty"); + s.destination("fixtures/dest_systemtime"); + s.register(plugin()); + s.build().expect("Build failed!"); + // Now we have a "current_time.txt" file in our destination directory that + // contains the current system time! +} +``` + +## Installation + +Add the latest version of Shtola to your `Cargo.toml`. + +## Documentation + +See https://docs.rs/shtola diff --git a/shtola/examples/simple.rs b/shtola/examples/simple.rs new file mode 100644 index 0000000..dd93b4f --- /dev/null +++ b/shtola/examples/simple.rs @@ -0,0 +1,26 @@ +use shtola::{RefIR, ShFile, Shtola}; +use std::path::PathBuf; + +fn main() { + minifemme::start(minifemme::LevelFilter::Info, minifemme::LogMode::Pretty); + let mut s = Shtola::new(); + s.source("fixtures/simple"); + s.destination("fixtures/dest_write"); + s.clean(true); + let mw = Box::new(|mut ir: RefIR| { + // Get the file contents first + // We have to clone here because otherwise there'll be an immutable ref lying around, + // which prevents us from writing to the HashMap later on. + let file = ir.files.get(&PathBuf::from("hello.txt")).unwrap().clone(); + ir.files.insert( + "hello.txt".into(), + ShFile { + frontmatter: file.frontmatter, + content: "hello".into(), + raw_content: None, + }, + ); + }); + s.register(mw); + s.build().unwrap(); +} diff --git a/shtola/examples/systemtime.rs b/shtola/examples/systemtime.rs new file mode 100644 index 0000000..3a4b7c3 --- /dev/null +++ b/shtola/examples/systemtime.rs @@ -0,0 +1,27 @@ +use shtola::{Plugin, RefIR, ShFile, Shtola}; +use std::time::SystemTime; + +fn plugin() -> Plugin { + Box::new(|mut ir: RefIR| { + // Let's create our file in the IR (intermediate representation) file hash map! + let current_time = SystemTime::now(); + ir.files.insert( + "current_time.txt".into(), + ShFile { + content: format!("{:?}", current_time).into(), + ..ShFile::default() + }, + ); + }) +} + +fn main() { + minifemme::start(minifemme::LevelFilter::Info, minifemme::LogMode::Pretty); + let mut s = Shtola::new(); + s.source("fixtures/empty"); + s.destination("fixtures/dest_systemtime"); + s.register(plugin()); + s.build().expect("Build failed!"); + // Now we have a "current_time.txt" file in our destination directory that + // contains the current system time! +} diff --git a/shtola/examples/tera_layouts.rs b/shtola/examples/tera_layouts.rs new file mode 100644 index 0000000..ba374fd --- /dev/null +++ b/shtola/examples/tera_layouts.rs @@ -0,0 +1,11 @@ +use shtola::{plugins, Shtola}; + +fn main() { + minifemme::start(minifemme::LevelFilter::Info, minifemme::LogMode::Pretty); + let mut s = Shtola::new(); + s.source("fixtures/tera_layouts"); + s.destination("fixtures/tera_layouts/dest"); + s.clean(true); + s.register(plugins::tera_layouts::plugin()); + s.build().unwrap(); +} diff --git a/shtola/src/frontmatter.rs b/shtola/src/frontmatter.rs new file mode 100644 index 0000000..102a9da --- /dev/null +++ b/shtola/src/frontmatter.rs @@ -0,0 +1,25 @@ +use serde_json::{json, Value}; +use serde_yaml::from_str; + +pub fn lexer(text: &str) -> (String, String) { + if text.starts_with("---\n") { + let slice_after_marker = &text[4..]; + let marker_end = slice_after_marker.find("---\n").unwrap(); + let yaml_slice = &text[4..marker_end + 4]; + let content_slice = &text[marker_end + 2 * 4..]; + ( + yaml_slice.trim().to_string(), + content_slice.trim().to_string(), + ) + } else { + (String::new(), text.to_string()) + } +} + +pub fn to_json(matter: &str) -> Value { + if matter.len() == 0 { + return json!(null); + } + let yaml: Value = from_str(matter).unwrap(); + yaml +} diff --git a/shtola/src/lib.rs b/shtola/src/lib.rs new file mode 100644 index 0000000..0e054fd --- /dev/null +++ b/shtola/src/lib.rs @@ -0,0 +1,339 @@ +//! With Shtola, you can build your own static site generators easily. All that +//! Shtola itself does is read files and frontmatter, run them through a bunch +//! of user-provided plugins, and write the result back to disk. +//! +//! As a demonstration of Shtola's basic piping feature, see this example: +//! ``` +//! use shtola::Shtola; +//! +//! let mut m = Shtola::new(); +//! m.source("../fixtures/simple"); +//! m.destination("../fixtures/dest/doctest_example"); +//! m.clean(true); +//! m.build().unwrap(); +//! ``` +//! +//! A "plugin" is just a boxed function that takes a `RefMut` to an `IR` (intermediate +//! representation) struct. The plugin may modify the IR freely: +//! +//! ``` +//! use shtola::{Plugin, ShFile, RefIR}; +//! +//! fn plugin() -> Plugin { +//! Box::new(|mut ir: RefIR| { +//! ir.files.insert("myFile".into(), ShFile::empty()); +//! }) +//! } +//! ``` + +use globset::{Glob, GlobSet, GlobSetBuilder}; +use log::{debug, info, trace}; +use pathdiff::diff_paths; +use serde_json::json; +use std::cell::RefMut; +use std::default::Default; +use std::fs; +use std::io::{BufRead, BufReader, Read, Write}; +use std::path::{Path, PathBuf}; +use walkdir::WalkDir; + +pub use log; +pub use serde_json as json; +pub use std::collections::HashMap; +pub use ware::Ware; + +/// Convenience type for a `RefMut`. +pub type RefIR<'a> = RefMut<'a, IR>; +/// Convenience type to return from plugin functions. +pub type Plugin = Box ()>; + +mod frontmatter; +pub mod plugins; + +/// The main library struct. +pub struct Shtola { + ware: Ware, + ir: IR, +} + +impl Shtola { + /// Creates a new empty Shtola struct. + pub fn new() -> Shtola { + let config: Config = Default::default(); + let ir = IR { + files: HashMap::new(), + config, + metadata: HashMap::new(), + }; + Shtola { + ware: Ware::new(), + ir, + } + } + + /// Appends glob-matched paths to the ignore list. If a glob path matches, the + /// file is excluded from the IR. + /// ``` + /// use shtola::Shtola; + /// + /// let mut m = Shtola::new(); + /// m.ignores(&mut vec!["node_modules".into(), "vendor/bundle/".into()]) + /// ``` + pub fn ignores(&mut self, vec: &mut Vec) { + self.ir.config.ignores.append(vec); + self.ir.config.ignores.dedup(); + } + + /// Reads paths to ignore from a file. This file needs to have one single path + /// per line. The most common use for this would be to read your project's `.gitignore`. + /// ``` + /// use std::path::Path; + /// use shtola::Shtola; + /// + /// let mut m = Shtola::new(); + /// m.source_ignores(Path::new(".gitignore")); + /// ``` + pub fn source_ignores(&mut self, path: &Path) -> Result<(), std::io::Error> { + let sourcepath = self.ir.config.source.clone().canonicalize()?; + let file = fs::File::open(path)?; + let reader = BufReader::new(file); + let mut ignores: Vec = reader.lines().map(|l| l.unwrap()).collect(); + self.ignores(&mut ignores); + self.ignores(&mut vec![path + .canonicalize()? + .strip_prefix(sourcepath) + .unwrap_or(path) + .to_str() + .unwrap() + .to_string()]); + Ok(()) + } + + /// Sets the source directory to read from. Should be relative. + pub fn source>(&mut self, path: T) { + self.ir.config.source = fs::canonicalize(path.into()).unwrap(); + } + + /// Sets the destination path to write to. This directory will be created on + /// calling this function if it doesn't exist. + pub fn destination + Clone>(&mut self, path: T) { + fs::create_dir_all(path.clone().into()).expect("Unable to create destination directory!"); + self.ir.config.destination = fs::canonicalize(path.into()).unwrap(); + } + + /// Sets whether the destination directory should be removed before building. + /// The removal only happens once calling [`Shtola::build`](#method.build). + /// Default is `false`. + pub fn clean(&mut self, b: bool) { + self.ir.config.clean = b; + } + + /// Sets whether frontmatter should be parsed. Default is `true`. + pub fn frontmatter(&mut self, b: bool) { + self.ir.config.frontmatter = b; + } + + /// Registers a new plugin function in its middleware chain. + /// + /// ``` + /// use shtola::{Shtola, RefIR}; + /// + /// let mut m = Shtola::new(); + /// let plugin = Box::new(|mut ir: RefIR| ()); + /// m.register(plugin); + /// ``` + pub fn register(&mut self, func: Box) { + self.ware.wrap(func); + } + + /// Performs the build process. This does a couple of things: + /// - If [`Shtola::clean`](#method.clean) is set, removes and recreates the + /// destination directory + /// - Reads from the source file and ignores files as it's been configured + /// - Parses front matter for the remaining files + /// - Runs the middleware chain, executing all plugins + /// - Writes the result back to the destination directory + pub fn build(&mut self) -> Result { + trace!("Starting IR config: {:?}", self.ir.config); + if self.ir.config.clean { + info!("Cleaning before build..."); + debug!("Removing {:?}", &self.ir.config.destination); + fs::remove_dir_all(&self.ir.config.destination)?; + debug!("Recreating {:?}", &self.ir.config.destination); + fs::create_dir_all(&self.ir.config.destination) + .expect("Unable to recreate destination directory!"); + } + + let path_clone = self.ir.config.destination.clone(); + let pathstr = path_clone.to_str().expect("No destination provided!"); + self.ignores(&mut vec![pathstr.to_string()]); + let mut builder = GlobSetBuilder::new(); + for item in &self.ir.config.ignores { + builder.add(Glob::new(item).unwrap()); + } + let set = builder.build().unwrap(); + info!("Reading files..."); + let files = read_dir(&self.ir.config.source, self.ir.config.frontmatter, set)?; + trace!("{} file(s) read", &files.len()); + + self.ir.files = files; + info!("Running plugins..."); + let result_ir = self.ware.run(self.ir.clone()); + info!("Writing to disk..."); + write_dir(result_ir.clone(), &self.ir.config.destination)?; + info!("OK, done"); + Ok(result_ir) + } +} + +/// The intermediate representation that's passed to plugins. Includes global +/// metadata, the files with frontmatter and the global config. +#[derive(Debug, Clone)] +pub struct IR { + /// The filestate, contained in a `HashMap`. + pub files: HashMap, + /// The configuration. + pub config: Config, + /// Global metadata managed as a `HashMap` that keep JSON values as values. + pub metadata: HashMap, +} + +/// Configuration struct. +#[derive(Debug, Clone)] +pub struct Config { + /// Files that are to be ignored. + pub ignores: Vec, + /// Source to read from. + pub source: PathBuf, + /// Destination to write to. + pub destination: PathBuf, + /// Whether to clean the destination directory. + pub clean: bool, + /// Whether to parse frontmatter. + pub frontmatter: bool, +} + +impl Default for Config { + fn default() -> Self { + Config { + ignores: vec![".git/**/*".into()], + source: PathBuf::from("."), + destination: PathBuf::from("./dest"), + clean: false, + frontmatter: true, + } + } +} + +/// Shtola's file representation, with frontmatter included. +#[derive(Debug, Clone)] +pub struct ShFile { + /// The frontmatter. + pub frontmatter: json::Value, + /// The file contents (without frontmatter). UTF-8-encoded. + pub content: Vec, + /// Raw content for anything that can't be read as UTF-8. + pub raw_content: Option>, +} + +impl Default for ShFile { + fn default() -> ShFile { + ShFile { + content: Vec::new(), + frontmatter: json::Value::Null, + raw_content: None, + } + } +} + +impl ShFile { + /// Creates an empty ShFile. Useful for deleting files using + /// [`HashMap::difference`](struct.HashMap.html#method.difference): + /// + /// ``` + /// use shtola::{Plugin, RefIR, ShFile, HashMap}; + /// use std::path::PathBuf; + /// + /// fn plugin() -> Plugin { + /// Box::new(|mut ir: RefIR| { + /// ir.files.insert("empty-file.md".into(), ShFile::empty()); + /// }) + /// } + /// ``` + pub fn empty() -> ShFile { + ShFile { + frontmatter: json!(null), + content: Vec::new(), + raw_content: None, + } + } +} + +fn read_dir( + source: &PathBuf, + frontmatter: bool, + set: GlobSet, +) -> Result, std::io::Error> { + let mut result = HashMap::new(); + let iters = WalkDir::new(source) + .into_iter() + .filter_entry(|e| { + let path = diff_paths(e.path(), source).unwrap(); + !set.is_match(path) + }) + .filter(|e| !e.as_ref().ok().unwrap().file_type().is_dir()); + for entry in iters { + let entry = entry?; + let path = entry.path(); + let file: ShFile; + let mut content = Vec::new(); + debug!("Reading file at {:?}", &path); + fs::File::open(path)?.read_to_end(&mut content)?; + if let Ok(content_string) = std::str::from_utf8(&content) { + if frontmatter { + let (matter, content) = frontmatter::lexer(content_string); + if matter.len() > 0 { + debug!("Lexing frontmatter for {:?}", &path); + } + let json = frontmatter::to_json(&matter); + file = ShFile { + frontmatter: json, + content: content.into(), + raw_content: None, + }; + } else { + file = ShFile { + frontmatter: json!(null), + content, + raw_content: None, + }; + } + } else { + // Not valid UTF-8, store as binary + file = ShFile { + frontmatter: json!(null), + content: Vec::new(), + raw_content: Some(content), + } + } + + let rel_path = diff_paths(path, source).unwrap(); + result.insert(rel_path, file); + } + Ok(result) +} + +fn write_dir(ir: IR, dest: &PathBuf) -> Result<(), std::io::Error> { + for (path, file) in ir.files { + let dest_path = dest.join(&path); + debug!("Writing {:?} to {:?}", &path, &dest_path); + fs::create_dir_all(dest_path.parent().unwrap()) + .expect("Unable to create destination subdirectory!"); + if let Some(raw) = file.raw_content { + fs::File::create(dest_path)?.write_all(&raw)?; + } else { + fs::File::create(dest_path)?.write_all(&file.content)?; + } + } + Ok(()) +} diff --git a/shtola/src/plugins/markdown.rs b/shtola/src/plugins/markdown.rs new file mode 100644 index 0000000..2361dde --- /dev/null +++ b/shtola/src/plugins/markdown.rs @@ -0,0 +1,53 @@ +use crate::log::{debug, info}; +use crate::{Plugin, RefIR, ShFile}; +use comrak::{markdown_to_html, ComrakOptions}; + +pub fn plugin() -> Plugin { + Box::new(|mut ir: RefIR| { + info!("Starting Markdown processing"); + let mut markdown_options = ComrakOptions::default(); + markdown_options.render.unsafe_ = true; + let files = ir.files.clone(); + let markdown_files = files.iter().filter(|(p, _)| match p.extension() { + Some(ext) => ext == "md", + None => false, + }); + for (path, file) in markdown_files { + debug!("Processing {:?}", &path); + let mut p = path.clone(); + p.set_extension("html"); + ir.files.remove(&path.to_path_buf()); + ir.files.insert( + p, + ShFile { + content: markdown_to_html( + std::str::from_utf8(&file.content).unwrap(), + &markdown_options, + ) + .into(), + frontmatter: file.frontmatter.clone(), + raw_content: None, + }, + ); + } + info!("Finished Markdown processing"); + }) +} + +#[test] +fn it_works() { + use crate::Shtola; + use std::path::PathBuf; + + let mut s = Shtola::new(); + s.source("../fixtures/markdown"); + s.destination("../fixtures/dest/markdown"); + s.clean(true); + s.register(plugin()); + let r = s.build().unwrap(); + let file: &ShFile = r.files.get(&PathBuf::from("hello.html")).unwrap(); + assert_eq!( + std::str::from_utf8(&file.content).unwrap(), + "

Hello!

\n

What's going on?

\n" + ) +} diff --git a/shtola/src/plugins/mod.rs b/shtola/src/plugins/mod.rs new file mode 100644 index 0000000..ea32c68 --- /dev/null +++ b/shtola/src/plugins/mod.rs @@ -0,0 +1,7 @@ +#[cfg(feature = "markdown")] +pub mod markdown; + +#[cfg(feature = "tera_layouts")] +pub mod tera_layouts; + +pub mod pretty_links; diff --git a/shtola/src/plugins/pretty_links.rs b/shtola/src/plugins/pretty_links.rs new file mode 100644 index 0000000..10cf679 --- /dev/null +++ b/shtola/src/plugins/pretty_links.rs @@ -0,0 +1,46 @@ +use std::path::Path; + +use crate::log::{debug, info}; +use crate::{Plugin, RefIR}; + +pub fn plugin() -> Plugin { + Box::new(|mut ir: RefIR| { + info!("Prettifying links..."); + let files = ir.files.clone(); + let html_files = files.iter().filter(|(p, _)| match p.extension() { + Some(ext) => ext == "html" && p.file_name().unwrap() != "index.html", + None => false, + }); + for (path, file) in html_files { + let basename = path.file_stem().unwrap(); + let mut new_path = match path.parent() { + Some(parent) => parent, + None => Path::new(""), + } + .to_path_buf(); + new_path.push(basename); + new_path.push(path.file_name().unwrap()); + new_path.set_file_name("index.html"); + debug!("{:?} -> {:?}", path, new_path); + ir.files.remove(&path.to_path_buf()); + ir.files.insert(new_path, file.clone()); + } + }) +} + +#[test] +fn it_works() { + use crate::Shtola; + use std::path::PathBuf; + + let mut s = Shtola::new(); + s.source("../fixtures/pretty_links"); + s.destination("../fixtures/dest/pretty_links"); + s.clean(true); + s.register(plugin()); + let r = s.build().unwrap(); + assert!(r.files.contains_key(&PathBuf::from("hi/index.html"))); + assert!(r + .files + .contains_key(&PathBuf::from("subfolder/hello/index.html"))); +} diff --git a/shtola/src/plugins/tera_layouts.rs b/shtola/src/plugins/tera_layouts.rs new file mode 100644 index 0000000..816fee0 --- /dev/null +++ b/shtola/src/plugins/tera_layouts.rs @@ -0,0 +1,198 @@ +use std::collections::HashMap; +use std::path::PathBuf; +use std::str::from_utf8; + +use id_tree::InsertBehavior::*; +use id_tree::Node; +use id_tree::NodeId; +use id_tree::Tree; +use serde_json::Value; +use tera::Context; +use tera::Tera; + +use crate::log; +use crate::ShFile; +use crate::{Plugin, RefIR}; + +// WARNING! This plugin uses a very unoptimized algorithm and lots of unwraps. +// Needs refactoring at some point. + +pub fn plugin() -> Plugin { + Box::new(|mut ir: RefIR| { + let mut tree: Tree = Tree::new(); + let mut children: Vec = Vec::new(); + // Empty root node + let root_id = tree.insert(Node::new(PathBuf::default()), AsRoot).unwrap(); + + // Find layouts with no parent layouts + let ancestor_layouts: HashMap<&PathBuf, NodeId> = ir + .files + .iter() + .filter(|(_, v)| { + if let Value::Object(obj) = v.frontmatter.clone() { + obj.contains_key("is_layout") && !obj.contains_key("layout") + } else { + false + } + }) + .map(|(path, _)| { + // Add them as secondary nodes and re-map them into a hashmap + let id = tree + .insert(Node::new(path.clone()), UnderNode(&root_id)) + .unwrap(); + (path, id) + }) + .collect(); + + ancestor_layouts.iter().for_each(|(_, node_id)| { + treeify_for(&mut tree, node_id, &ir, &mut children); + }); + + log::debug!("Layout tree:\n{}", print_tree(&tree)); + + // Iterate over each child node, and render layouts in reverse order + // of the ancestor subtree. + children.iter().for_each(|id| { + let path = tree.get(id).unwrap().data(); + log::debug!("Rendering {:?}", path); + let ancestors: Vec<&Node> = tree.ancestors(&id).unwrap().collect(); + let mut reviter = ancestors.iter().rev().peekable(); + let mut acc: Option = None; + reviter.next(); // Root node, empty + + if reviter.len() > 1 { + // Poor man's `iter::fold`, we can't peek inside of an already borrowed iterator + while let Some(&node) = reviter.next() { + let mut context = Context::new(); + if let Some(next_node) = reviter.peek() { + let val = ir.files.get(next_node.data()).unwrap(); + context.insert("content", from_utf8(&val.content).unwrap()); + + match acc { + None => { + let layout = ir.files.get(node.data()).unwrap(); + acc = Some( + Tera::one_off( + from_utf8(&layout.content).unwrap(), + &context, + false, + ) + .unwrap(), + ) + } + Some(layout) => { + acc = Some(Tera::one_off(layout.as_ref(), &context, false).unwrap()) + } + } + } + } + } else { + // Direct child of layout, so we just get the layout and put it in the accumulator + let node = reviter.next().unwrap(); + acc = Some( + from_utf8(&ir.files.get(node.data()).unwrap().content) + .unwrap() + .to_string(), + ); + } + + // Finally, render the child node into the accumulated layout + let mut context = Context::new(); + let node_contents = ir.files.get(path).unwrap(); + context.insert("content", from_utf8(&node_contents.content).unwrap()); + let rendered = Tera::one_off(acc.unwrap().as_ref(), &context, false).unwrap(); + + // Remove the old file + let mut file = node_contents.clone(); + ir.files.remove(path); + + // Insert the new file + file.content = rendered.into(); + ir.files.insert(path.to_path_buf(), file); + }); + + // Remove layouts from files + tree.traverse_level_order(&root_id) + .unwrap() + .for_each(|node| { + let file = ir.files.get(node.data()); + if let Some(file) = file { + if let Value::Object(obj) = file.frontmatter.clone() { + if obj.contains_key("is_layout") { + ir.files.remove(node.data()); + } + } + } + }); + }) +} + +fn treeify_for( + tree: &mut Tree, + node: &NodeId, + ir: &RefIR, + final_children: &mut Vec, +) { + let layout_name = tree.get(node).unwrap().data().file_stem().unwrap(); + // Find the layout's children (e.g. HTML files that use this layout) + let children: HashMap<&PathBuf, &ShFile> = ir + .files + .iter() + .filter(|(_, file)| { + if let Value::Object(obj) = file.frontmatter.clone() { + obj.contains_key("layout") + && obj.get("layout").unwrap().as_str() == layout_name.to_str() + } else { + false + } + }) + .collect(); + + if !children.is_empty() { + // Insert children into tree + children.iter().for_each(|(path, file)| { + let node_id = tree + .insert(Node::new(path.clone().to_path_buf()), UnderNode(node)) + .unwrap(); + + // If not a layout, insert into final children + let fm = file.frontmatter.clone(); + let val = fm.as_object().unwrap(); + if !val.contains_key("is_layout") { + final_children.push(node_id.clone()); + } else { + // If a layout, recurse + treeify_for(tree, &node_id, ir, final_children); + } + }) + } +} + +fn print_tree(tree: &Tree) -> String { + let mut s: String = String::new(); + tree.write_formatted(&mut s).unwrap(); + s +} + +#[test] +fn it_works() { + use crate::Shtola; + use std::str::from_utf8; + + let mut s = Shtola::new(); + s.source("../fixtures/tera_layouts"); + s.destination("../fixtures/dest/tera_layouts"); + s.clean(true); + s.register(plugin()); + let r = s.build().unwrap(); + let file1 = r.files.get(&PathBuf::from("page.html")).unwrap(); + let file2 = r.files.get(&PathBuf::from("3rdpage.html")).unwrap(); + assert_eq!( + from_utf8(&file1.content).unwrap(), + "

top layout

\n\nhello" + ); + assert_eq!( + from_utf8(&file2.content).unwrap(), + "

top layout

\n\n

hiii

" + ); +} diff --git a/shtola/tests/shtola.rs b/shtola/tests/shtola.rs new file mode 100644 index 0000000..2f70d1c --- /dev/null +++ b/shtola/tests/shtola.rs @@ -0,0 +1,153 @@ +use shtola::json::json; +use shtola::{RefIR, ShFile, Shtola}; +use std::fs; +use std::path::{Path, PathBuf}; + +#[test] +fn read_works() { + let mut s = Shtola::new(); + s.source("../fixtures/simple"); + s.destination("../fixtures/dest/read"); + let r = s.build().unwrap(); + assert_eq!(r.files.len(), 1); + let keys: Vec<&PathBuf> = r.files.keys().collect(); + assert_eq!(keys[0].to_str().unwrap(), "hello.txt"); +} + +#[test] +fn clean_works() { + let mut s = Shtola::new(); + s.source("../fixtures/simple"); + s.destination("../fixtures/dest/clean"); + s.clean(true); + fs::create_dir_all("../fixtures/dest/clean").unwrap(); + fs::write("../fixtures/dest/clean/blah.foo", "").unwrap(); + s.build().unwrap(); + let fpath = PathBuf::from("../fixtures/dest/clean/blah.foo"); + assert_eq!(fpath.exists(), false); +} + +#[test] +fn write_works() { + let mut s = Shtola::new(); + s.source("../fixtures/simple"); + s.destination("../fixtures/dest/write"); + s.clean(true); + let mw = Box::new(|mut ir: RefIR| { + let file = ir.files.get(&PathBuf::from("hello.txt")).unwrap().clone(); + ir.files.insert( + "hello.txt".into(), + ShFile { + content: "hello".into(), + frontmatter: file.frontmatter.clone(), + raw_content: None, + }, + ); + }); + s.register(mw); + s.build().unwrap(); + let dpath = PathBuf::from("../fixtures/dest/write/hello.txt"); + assert!(dpath.exists()); + let file = &fs::read(dpath).unwrap(); + let fstring = String::from_utf8_lossy(file); + assert_eq!(fstring, "hello"); +} + +#[test] +fn read_works_with_binaries() { + let mut s = Shtola::new(); + s.source("../fixtures/read_binary"); + s.destination("../fixtures/dest/read_binary"); + let r = s.build().unwrap(); + assert_eq!(r.files.len(), 1); + let (name, file) = r.files.iter().next().unwrap(); + assert_eq!(name.to_str().unwrap(), "my_binary"); + assert!(file.raw_content.is_some()); +} + +#[test] +fn write_works_with_binaries() { + let mut s = Shtola::new(); + s.source("../fixtures/read_binary"); + s.destination("../fixtures/dest/write_binary"); + s.clean(true); + s.build().unwrap(); + let dpath = PathBuf::from("../fixtures/dest/write_binary/my_binary"); + assert!(dpath.exists()); + let file = fs::read(dpath).unwrap(); + let fres = String::from_utf8(file); + assert!(fres.is_err()); +} + +#[test] +fn frontmatter_works() { + let mut s = Shtola::new(); + s.source("../fixtures/frontmatter"); + s.destination("../fixtures/dest/frontmatter"); + s.clean(true); + let r = s.build().unwrap(); + let (_, matter_file) = r.files.iter().last().unwrap(); + let frontmatter = matter_file.frontmatter.get("hello").unwrap(); + assert_eq!(frontmatter, "bro"); +} + +#[test] +fn no_frontmatter_works() { + let mut s = Shtola::new(); + s.source("../fixtures/frontmatter"); + s.destination("../fixtures/dest/no_frontmatter"); + s.clean(true); + s.frontmatter(false); + let r = s.build().unwrap(); + let (_, matter_file) = r.files.iter().last().unwrap(); + assert!(matter_file.frontmatter.is_null()); +} + +#[test] +fn ignore_works() { + let mut s = Shtola::new(); + s.source("../fixtures/ignore"); + s.destination("../fixtures/dest/ignore"); + s.ignores(&mut vec!["ignored.md".to_string()]); + s.clean(true); + let r = s.build().unwrap(); + assert_eq!(r.files.len(), 1); + let (path, _) = r.files.iter().last().unwrap(); + assert_eq!(path.to_str().unwrap(), "not_ignored.md"); +} + +#[test] +fn source_ignore_works() { + let mut s = Shtola::new(); + s.source("../fixtures/source_ignore"); + s.destination("../fixtures/dest/source_ignore"); + s.source_ignores(Path::new("../fixtures/source_ignore/ignores")) + .unwrap(); + s.clean(true); + let r = s.build().unwrap(); + assert_eq!(r.files.len(), 1); + let (path, _) = r.files.iter().last().unwrap(); + assert_eq!(path.to_str().unwrap(), "two.txt"); +} + +#[test] +fn metadata_works() { + let mut s = Shtola::new(); + s.source("../fixtures/simple"); + s.destination("../fixtures/dest/metadata"); + s.clean(true); + let mw1 = Box::new(|mut ir: RefIR| { + ir.metadata.insert("test".into(), json!("foo")); + ir.metadata.insert("test2".into(), json!({"bar": "baz"})); + }); + + let mw2 = Box::new(|mut ir: RefIR| { + ir.metadata.insert("test".into(), json!(["a", "b", "c"])); + }); + + s.register(mw1); + s.register(mw2); + let r = s.build().unwrap(); + assert_eq!(r.metadata.get("test").unwrap(), &json!(["a", "b", "c"])); + assert_eq!(r.metadata.get("test2").unwrap(), &json!({"bar": "baz"})); +}