diff --git a/.gitignore b/.gitignore index ed088133..06e70689 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,9 @@ # Ignora directorios de compilación **/target +# Ignora directorios de archivos estáticos +**/static + # Archivos de log **/log/*.log* diff --git a/Cargo.lock b/Cargo.lock index 433ce60d..1ad66c7c 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -20,6 +20,15 @@ dependencies = [ "zerocopy", ] +[[package]] +name = "aho-corasick" +version = "0.7.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc936419f96fa211c1b9166887b38e5e40b19958e5b895be7c1f93adec7071ac" +dependencies = [ + "memchr", +] + [[package]] name = "aho-corasick" version = "1.1.4" @@ -933,7 +942,7 @@ version = "0.4.18" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "52dfc19153a48bde0cbd630453615c8151bce3a5adfac7a0aebfbf0a1e1f57e3" dependencies = [ - "aho-corasick", + "aho-corasick 1.1.4", "bstr", "log", "regex-automata", @@ -965,6 +974,16 @@ dependencies = [ "rand", ] +[[package]] +name = "hashbrown" +version = "0.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "43a3c133739dddd0d2990f9a4bdf8eb4b21ef50e4851ca85ab661199821d510e" +dependencies = [ + "ahash", + "bumpalo", +] + [[package]] name = "hashbrown" version = "0.14.5" @@ -1495,6 +1514,17 @@ dependencies = [ "unicase", ] +[[package]] +name = "minify-js" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1fa5546ee8bd66024113e506cabe4230e76635a094c06ea2051b66021dda92e" +dependencies = [ + "aho-corasick 0.7.20", + "lazy_static", + "parse-js", +] + [[package]] name = "miniz_oxide" version = "0.8.9" @@ -1721,7 +1751,6 @@ version = "0.1.0" dependencies = [ "pagetop", "pagetop-build", - "tokio", ] [[package]] @@ -1731,7 +1760,6 @@ dependencies = [ "pagetop", "pagetop-build", "serde", - "tokio", ] [[package]] @@ -1739,9 +1767,18 @@ name = "pagetop-build" version = "0.3.2" dependencies = [ "grass", + "minify-js", "pagetop-statics", ] +[[package]] +name = "pagetop-htmx" +version = "0.1.0" +dependencies = [ + "pagetop", + "pagetop-build", +] + [[package]] name = "pagetop-macros" version = "0.3.0" @@ -1812,6 +1849,19 @@ dependencies = [ "windows-link", ] +[[package]] +name = "parse-js" +version = "0.20.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2742b5e32dcb5930447ed9f9e401a7dfd883867fc079c4fac44ae8ba3593710e" +dependencies = [ + "aho-corasick 0.7.20", + "bumpalo", + "hashbrown 0.13.2", + "lazy_static", + "memchr", +] + [[package]] name = "pastey" version = "0.2.2" @@ -2094,7 +2144,7 @@ version = "0.4.14" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "6e1dd4122fc1595e8162618945476892eefca7b88c52820e74af6262213cae8f" dependencies = [ - "aho-corasick", + "aho-corasick 1.1.4", "memchr", "regex-syntax", ] diff --git a/Cargo.toml b/Cargo.toml index fb4dc225..03a5944a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -36,6 +36,7 @@ indexmap = "2.14" indoc = "2.0" itoa = "1.0" mime_guess = "2.0" +minify-js = "0.6" parking_lot = "0.12" pastey = "0.2" path-slash = "0.2" diff --git a/README.md b/README.md index 89fade06..35023682 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
+
Prepara un conjunto de archivos estáticos o archivos SCSS compilados para ser incluidos en el binario de un proyecto PageTop.
+Genera o prepara archivos estáticos para servirlos o incluirlos en un proyecto PageTop.
[](https://docs.rs/pagetop-build) [](https://crates.io/crates/pagetop-build) @@ -19,81 +19,77 @@ configurables, basadas en HTML, CSS y JavaScript. ## Guía rápida -Añadir en el archivo `Cargo.toml` del proyecto: +La convención recomendada para extensiones, temas o aplicaciones basadas en **PageTop** es separar +los archivos fuente de los generados siguiendo el patrón `assets/` -> `static/`: -```toml -[build-dependencies] -pagetop-build = { ... } -``` +- **`assets/`** - archivos versionados en el repositorio, por ejemplo archivos SCSS, JavaScript de + terceros, fuentes, etc. Todo lo que hay aquí se sube al repositorio y será la fuente para generar + el directorio final `static/`. +- **`static/`** - archivos generados en tiempo de compilación a partir de `assets/`. Se añade a + `.gitignore` y nunca se sube al repositorio. +- **`build.rs`** - orquesta la transformación: genera `static/` desde `assets/` para servirlos o + incluirlos en el proyecto. -Y crear un archivo `build.rs` a la altura de `Cargo.toml` para indicar cómo se van a incluir los -archivos estáticos o cómo se van a compilar los archivos SCSS para el proyecto. Casos de uso: +Durante el desarrollo, `static/` existe en disco y los archivos se sirven desde ahí. En producción, +el directorio no existe y los recursos salen del binario. La macro +[`serve_static_files!`](https://docs.rs/pagetop/latest/pagetop/macro.serve_static_files.html) +gestiona esta dualidad de forma transparente. -### Incluir archivos estáticos desde un directorio +### Funciones de transformación -Hay que preparar una carpeta en el proyecto con todos los archivos que se quieren incluir, por -ejemplo `static`, y añadir el siguiente código en `build.rs` para crear el conjunto de recursos: +Estas funciones se usan en el `build.rs` de cada proyecto para generar `static/` a partir de +`assets/`. Todas crean el directorio padre del destino si no existe y devuelven `io::Result<()>` +para poder propagarse con `?` en caso de error. + +- `compile_scss()` - compila un archivo SCSS a CSS minificado. +- `copy_dir()` - copia recursivamente un directorio completo. Útil para copiar todos los archivos de + `assets/` o de un subdirectorio a `static/` sin transformación. +- `copy_file()` - copia un archivo al destino. +- `copy_file_replacing()` - copia un archivo aplicando una lista de sustituciones de texto en su + contenido; útil para actualizar referencias internas (p.ej. `sourceMappingURL`) al renombrar + archivos. +- `minify_js()` - minifica un archivo JavaScript. + +### Incluir los archivos estáticos en el proyecto + +Una vez generado `static/`, usaremos `StaticFilesBundle` para incluir su contenido en el binario. Se +pueden crear tantos paquetes de recursos como sea necesario, siempre que tengan nombres distintos: ```rust,no_run use pagetop_build::StaticFilesBundle; fn main() -> std::io::Result<()> { - StaticFilesBundle::from_dir("./static", None) - .with_name("guides") + StaticFilesBundle::from_dir("./static/css", None) + .with_name("app_css") + .build()?; + StaticFilesBundle::from_dir("./static/fonts", None) + .with_name("app_fonts") .build() } ``` -Si es necesario, se puede añadir un filtro para seleccionar archivos específicos de la carpeta, por -ejemplo: +Si es necesario excluir algunos archivos del paquete de recursos (p. ej. los archivos `.map` que no +son necesarios en producción), se puede pasar una función de filtro: ```rust,no_run use pagetop_build::StaticFilesBundle; use std::path::Path; fn main() -> std::io::Result<()> { - fn only_pdf_files(path: &Path) -> bool { - // Selecciona únicamente los archivos con extensión `.pdf`. - path.extension().map_or(false, |ext| ext == "pdf") - } - - StaticFilesBundle::from_dir("./static", Some(only_pdf_files)) - .with_name("guides") + StaticFilesBundle::from_dir("./static/js", Some(only_js)) + .with_name("app_js") .build() } + +fn only_js(path: &Path) -> bool { + path.extension().map_or(false, |ext| ext == "js") +} ``` -### Compilar archivos SCSS a CSS - -Se puede compilar un archivo SCSS, que podría importar otros a su vez, para preparar un recurso con -el archivo CSS minificado obtenido. Por ejemplo: - -```rust,no_run -use pagetop_build::StaticFilesBundle; - -fn main() -> std::io::Result<()> { - StaticFilesBundle::from_scss("./styles/main.scss", "styles.min.css") - .with_name("main_styles") - .build() -} -``` - -Este código compila el archivo `main.scss` de la carpeta `static` del proyecto, y prepara un recurso -llamado `main_styles` que contiene el archivo `styles.min.css` obtenido. - -## Archivos generados - -Cada conjunto de recursos [`StaticFilesBundle`] genera un archivo en el directorio estándar -[OUT_DIR](https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts) -donde se incluye el código necesario para compilar el proyecto. Por ejemplo, para -`with_name("guides")` se genera un archivo llamado `guides.rs`. - -No hay ningún problema en generar más de un conjunto de recursos para cada proyecto siempre que se -usen nombres diferentes. - -Normalmente no habrá que acceder a estos módulos; sólo declarar el nombre del conjunto de recursos -en [`serve_static_files!`](https://docs.rs/pagetop/latest/pagetop/macro.serve_static_files.html) -para configurar un servicio web que sirva los archivos desde la ruta indicada. Por ejemplo: +Cada paquete de recursos genera un archivo `.rs` en +[OUT_DIR](https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts). +No es necesario acceder a él directamente: el nombre asignado con `.with_name()` se usa como +identificador en `serve_static_files!` para configurar la ruta del servicio: ```rust,ignore use pagetop::prelude::*; @@ -101,14 +97,47 @@ use pagetop::prelude::*; pub struct MyExtension; impl Extension for MyExtension { - /// Registra los recursos de `guides` en el router bajo `/ruta/a/guides`. fn configure_router(&self, mut router: Router) -> Router { - serve_static_files!(router, [guides] => "/ruta/a/guides"); + serve_static_files!(router, ["./static/css", app_css] => "/public/css"); router } } ``` +## Ejemplo completo + +```rust,no_run +use pagetop_build::StaticFilesBundle; +use pagetop_build::{compile_scss, copy_file, copy_file_replacing, minify_js}; +use std::path::Path; + +fn main() -> std::io::Result<()> { + // Regenera `static/` desde cero sólo si hay cambios en `assets/`. + println!("cargo:rerun-if-changed=assets"); + let _ = std::fs::remove_dir_all("static"); + + // Genera `static/` a partir de `assets/`. + compile_scss("assets/main.scss", "static/css/main.min.css")?; + copy_file("assets/fonts/icon.woff2", "static/fonts/icon.woff2")?; + copy_file_replacing( + "assets/lib.min.js", + "static/js/app.min.js", + &[("lib.min.js.map", "app.min.js.map")], + )?; + minify_js("assets/shell.js", "static/js/shell.min.js")?; + + // Prepara los paquetes de recursos para incluir en el proyecto. + StaticFilesBundle::from_dir("./static/css", None).with_name("app_css").build()?; + StaticFilesBundle::from_dir("./static/js", Some(only_js)).with_name("app_js").build()?; + StaticFilesBundle::from_dir("./static/fonts", None).with_name("app_fonts").build() +} + +// Los `.map` no se incluyen, se servirán desde disco durante el desarrollo. +fn only_js(path: &Path) -> bool { + path.extension().map_or(false, |ext| ext == "js") +} +``` + ## Advertencia **PageTop** es un proyecto personal para aprender [Rust](https://www.rust-lang.org/es) y conocer su diff --git a/helpers/pagetop-build/src/lib.rs b/helpers/pagetop-build/src/lib.rs index a6194c5f..5a9d24bb 100644 --- a/helpers/pagetop-build/src/lib.rs +++ b/helpers/pagetop-build/src/lib.rs @@ -3,7 +3,7 @@Prepara un conjunto de archivos estáticos o archivos SCSS compilados para ser incluidos en el binario de un proyecto PageTop.
+Genera o prepara archivos estáticos para servirlos o incluirlos en un proyecto PageTop.
[](https://docs.rs/pagetop-build) [](https://crates.io/crates/pagetop-build) @@ -20,81 +20,77 @@ configurables, basadas en HTML, CSS y JavaScript. ## Guía rápida -Añadir en el archivo `Cargo.toml` del proyecto: +La convención recomendada para extensiones, temas o aplicaciones basadas en **PageTop** es separar +los archivos fuente de los generados siguiendo el patrón `assets/` -> `static/`: -```toml -[build-dependencies] -pagetop-build = { ... } -``` +- **`assets/`** - archivos versionados en el repositorio, por ejemplo archivos SCSS, JavaScript de + terceros, fuentes, etc. Todo lo que hay aquí se sube al repositorio y será la fuente para generar + el directorio final `static/`. +- **`static/`** - archivos generados en tiempo de compilación a partir de `assets/`. Se añade a + `.gitignore` y nunca se sube al repositorio. +- **`build.rs`** - orquesta la transformación: genera `static/` desde `assets/` para servirlos o + incluirlos en el proyecto. -Y crear un archivo `build.rs` a la altura de `Cargo.toml` para indicar cómo se van a incluir los -archivos estáticos o cómo se van a compilar los archivos SCSS para el proyecto. Casos de uso: +Durante el desarrollo, `static/` existe en disco y los archivos se sirven desde ahí. En producción, +el directorio no existe y los recursos salen del binario. La macro +[`serve_static_files!`](https://docs.rs/pagetop/latest/pagetop/macro.serve_static_files.html) +gestiona esta dualidad de forma transparente. -### Incluir archivos estáticos desde un directorio +### Funciones de transformación -Hay que preparar una carpeta en el proyecto con todos los archivos que se quieren incluir, por -ejemplo `static`, y añadir el siguiente código en `build.rs` para crear el conjunto de recursos: +Estas funciones se usan en el `build.rs` de cada proyecto para generar `static/` a partir de +`assets/`. Todas crean el directorio padre del destino si no existe y devuelven `io::Result<()>` +para poder propagarse con `?` en caso de error. + +- `compile_scss()` - compila un archivo SCSS a CSS minificado. +- `copy_dir()` - copia recursivamente un directorio completo. Útil para copiar todos los archivos de + `assets/` o de un subdirectorio a `static/` sin transformación. +- `copy_file()` - copia un archivo al destino. +- `copy_file_replacing()` - copia un archivo aplicando una lista de sustituciones de texto en su + contenido; útil para actualizar referencias internas (p.ej. `sourceMappingURL`) al renombrar + archivos. +- `minify_js()` - minifica un archivo JavaScript. + +### Incluir los archivos estáticos en el proyecto + +Una vez generado `static/`, usaremos `StaticFilesBundle` para incluir su contenido en el binario. Se +pueden crear tantos paquetes de recursos como sea necesario, siempre que tengan nombres distintos: ```rust,no_run use pagetop_build::StaticFilesBundle; fn main() -> std::io::Result<()> { - StaticFilesBundle::from_dir("./static", None) - .with_name("guides") + StaticFilesBundle::from_dir("./static/css", None) + .with_name("app_css") + .build()?; + StaticFilesBundle::from_dir("./static/fonts", None) + .with_name("app_fonts") .build() } ``` -Si es necesario, se puede añadir un filtro para seleccionar archivos específicos de la carpeta, por -ejemplo: +Si es necesario excluir algunos archivos del paquete de recursos (p. ej. los archivos `.map` que no +son necesarios en producción), se puede pasar una función de filtro: ```rust,no_run use pagetop_build::StaticFilesBundle; use std::path::Path; fn main() -> std::io::Result<()> { - fn only_pdf_files(path: &Path) -> bool { - // Selecciona únicamente los archivos con extensión `.pdf`. - path.extension().map_or(false, |ext| ext == "pdf") - } - - StaticFilesBundle::from_dir("./static", Some(only_pdf_files)) - .with_name("guides") + StaticFilesBundle::from_dir("./static/js", Some(only_js)) + .with_name("app_js") .build() } + +fn only_js(path: &Path) -> bool { + path.extension().map_or(false, |ext| ext == "js") +} ``` -### Compilar archivos SCSS a CSS - -Se puede compilar un archivo SCSS, que podría importar otros a su vez, para preparar un recurso con -el archivo CSS minificado obtenido. Por ejemplo: - -```rust,no_run -use pagetop_build::StaticFilesBundle; - -fn main() -> std::io::Result<()> { - StaticFilesBundle::from_scss("./styles/main.scss", "styles.min.css") - .with_name("main_styles") - .build() -} -``` - -Este código compila el archivo `main.scss` de la carpeta `static` del proyecto, y prepara un recurso -llamado `main_styles` que contiene el archivo `styles.min.css` obtenido. - -## Archivos generados - -Cada conjunto de recursos [`StaticFilesBundle`] genera un archivo en el directorio estándar -[OUT_DIR](https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts) -donde se incluye el código necesario para compilar el proyecto. Por ejemplo, para -`with_name("guides")` se genera un archivo llamado `guides.rs`. - -No hay ningún problema en generar más de un conjunto de recursos para cada proyecto siempre que se -usen nombres diferentes. - -Normalmente no habrá que acceder a estos módulos; sólo declarar el nombre del conjunto de recursos -en [`serve_static_files!`](https://docs.rs/pagetop/latest/pagetop/macro.serve_static_files.html) -para configurar un servicio web que sirva los archivos desde la ruta indicada. Por ejemplo: +Cada paquete de recursos genera un archivo `.rs` en +[OUT_DIR](https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts). +No es necesario acceder a él directamente: el nombre asignado con `.with_name()` se usa como +identificador en `serve_static_files!` para configurar la ruta del servicio: ```rust,ignore use pagetop::prelude::*; @@ -102,39 +98,77 @@ use pagetop::prelude::*; pub struct MyExtension; impl Extension for MyExtension { - /// Registra los recursos de `guides` en el router bajo `/ruta/a/guides`. fn configure_router(&self, mut router: Router) -> Router { - serve_static_files!(router, [guides] => "/ruta/a/guides"); + serve_static_files!(router, ["./static/css", app_css] => "/public/css"); router } } ``` + +## Ejemplo completo + +```rust,no_run +use pagetop_build::StaticFilesBundle; +use pagetop_build::{compile_scss, copy_file, copy_file_replacing, minify_js}; +use std::path::Path; + +fn main() -> std::io::Result<()> { + // Regenera `static/` desde cero sólo si hay cambios en `assets/`. + println!("cargo:rerun-if-changed=assets"); + let _ = std::fs::remove_dir_all("static"); + + // Genera `static/` a partir de `assets/`. + compile_scss("assets/main.scss", "static/css/main.min.css")?; + copy_file("assets/fonts/icon.woff2", "static/fonts/icon.woff2")?; + copy_file_replacing( + "assets/lib.min.js", + "static/js/app.min.js", + &[("lib.min.js.map", "app.min.js.map")], + )?; + minify_js("assets/shell.js", "static/js/shell.min.js")?; + + // Prepara los paquetes de recursos para incluir en el proyecto. + StaticFilesBundle::from_dir("./static/css", None).with_name("app_css").build()?; + StaticFilesBundle::from_dir("./static/js", Some(only_js)).with_name("app_js").build()?; + StaticFilesBundle::from_dir("./static/fonts", None).with_name("app_fonts").build() +} + +// Los `.map` no se incluyen, se servirán desde disco durante el desarrollo. +fn only_js(path: &Path) -> bool { + path.extension().map_or(false, |ext| ext == "js") +} +``` */ #![doc( - html_favicon_url = "https://git.cillero.es/manuelcillero/pagetop/raw/branch/main/static/favicon.ico" + html_favicon_url = "https://git.cillero.es/manuelcillero/pagetop/raw/branch/main/assets/favicon.ico" )] use grass::{Options, OutputStyle, from_path}; -use pagetop_statics::{ResourceDir, resource_dir}; +use minify_js::{Session, TopLevelMode, minify}; +use pagetop_statics::resource_dir; -use std::fs::{File, create_dir_all, remove_dir_all}; -use std::io::Write; -use std::path::Path; +use std::fs::{File, copy as fs_copy, create_dir_all, read_dir}; +use std::io::{self, Write}; +use std::path::{Path, PathBuf}; -/// Prepara un conjunto de recursos para ser incluidos en el binario del proyecto. +// **< StaticFilesBundle >************************************************************************** + +/// Prepara un paquete de recursos para incluir en el binario del proyecto. pub struct StaticFilesBundle { - resource_dir: ResourceDir, + dir: PathBuf, + filter: Option(dir: P, filter: Option (path: P, target_name: &str) -> Self
- where
- P: AsRef (src: P, dst: Q) -> io::Result<()>
+where
+ P: AsRef (src: P, dst: Q) -> io::Result<()>
+where
+ P: AsRef (src: P, dst: Q) -> io::Result<()>
+where
+ P: AsRef (src: P, dst: Q, replacements: &[(&str, &str)]) -> io::Result<()>
+where
+ P: AsRef (src: P, dst: Q) -> io::Result<()>
+where
+ P: AsRef
+
PageTop
@@ -86,7 +86,7 @@ estructurar e inicializar la aplicación de forma modular.
#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc(
- html_favicon_url = "https://git.cillero.es/manuelcillero/pagetop/raw/branch/main/static/favicon.ico"
+ html_favicon_url = "https://git.cillero.es/manuelcillero/pagetop/raw/branch/main/assets/favicon.ico"
)]
// Alias para que las rutas absolutas `::pagetop::...` generadas por las macros funcionen en el
@@ -138,14 +138,14 @@ pub use pagetop_statics::{StaticFile, resource};
pub use getter_methods::Getters;
-/// Contenedor para un conjunto de recursos embebidos.
+/// Contenedor para un paquete de recursos embebidos.
#[derive(AutoDefault)]
pub struct StaticResources {
bundle: HashMap<&'static str, StaticFile>,
}
impl StaticResources {
- /// Crea un contenedor para un conjunto de recursos generado por `build.rs` (consultar
+ /// Crea un contenedor para un paquete de recursos generado por `build.rs` (consultar
/// [`pagetop_build`](https://docs.rs/pagetop-build)).
pub fn new(bundle: HashMap<&'static str, StaticFile>) -> Self {
Self { bundle }