From dff80355d4fdc5e1ddba15d145160d83f7a2d189 Mon Sep 17 00:00:00 2001 From: Alexandre Pasmantier Date: Tue, 5 Nov 2024 01:05:26 +0100 Subject: [PATCH] docs and linting --- .github/workflows/ci.yml | 22 +++++++++++++++------- crates/television/previewers.rs | 6 ++++++ crates/television/previewers/basic.rs | 6 ++++++ crates/television/previewers/directory.rs | 6 ++++++ crates/television/previewers/env.rs | 6 ++++++ crates/television/previewers/files.rs | 6 ++++++ 6 files changed, 45 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c060dc8..70b6385 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -56,12 +56,20 @@ jobs: uses: actions/checkout@v4 - name: Install Rust toolchain uses: dtolnay/rust-toolchain@nightly - - uses: Swatinem/rust-cache@v2 - - name: Check documentation - env: - RUSTDOCFLAGS: -D warnings - run: cargo doc --no-deps --document-private-items --all-features --workspace --examples + - name: Configure cache + uses: Swatinem/rust-cache@v2 + - name: Setup pages + id: pages + uses: actions/configure-pages@v4 + - name: Clean docs folder + run: cargo clean --doc + - name: Build docs + run: cargo doc --no-deps + - name: Add redirect + run: echo '' > target/doc/index.html + - name: Remove lock file + run: rm target/doc/.lock - name: Upload artifact - uses: actions/upload-pages-artifact@v2 + uses: actions/upload-pages-artifact@v3 with: - path: "target/docs" + path: target/doc diff --git a/crates/television/previewers.rs b/crates/television/previewers.rs index 62e9fce..de1a7dd 100644 --- a/crates/television/previewers.rs +++ b/crates/television/previewers.rs @@ -87,6 +87,12 @@ pub struct Previewer { env_var: EnvVarPreviewer, } +impl Default for Previewer { + fn default() -> Self { + Previewer::new() + } +} + impl Previewer { pub fn new() -> Self { Previewer { diff --git a/crates/television/previewers/basic.rs b/crates/television/previewers/basic.rs index f02f55b..3709eeb 100644 --- a/crates/television/previewers/basic.rs +++ b/crates/television/previewers/basic.rs @@ -5,6 +5,12 @@ use crate::previewers::{Preview, PreviewContent}; pub struct BasicPreviewer {} +impl Default for BasicPreviewer { + fn default() -> Self { + BasicPreviewer::new() + } +} + impl BasicPreviewer { pub fn new() -> Self { BasicPreviewer {} diff --git a/crates/television/previewers/directory.rs b/crates/television/previewers/directory.rs index 2298349..15d7a1c 100644 --- a/crates/television/previewers/directory.rs +++ b/crates/television/previewers/directory.rs @@ -15,6 +15,12 @@ pub struct DirectoryPreviewer { cache: Arc>, } +impl Default for DirectoryPreviewer { + fn default() -> Self { + DirectoryPreviewer::new() + } +} + impl DirectoryPreviewer { pub fn new() -> Self { DirectoryPreviewer { diff --git a/crates/television/previewers/env.rs b/crates/television/previewers/env.rs index 60b64ee..daf17fb 100644 --- a/crates/television/previewers/env.rs +++ b/crates/television/previewers/env.rs @@ -8,6 +8,12 @@ pub struct EnvVarPreviewer { cache: HashMap>, } +impl Default for EnvVarPreviewer { + fn default() -> Self { + EnvVarPreviewer::new() + } +} + impl EnvVarPreviewer { pub fn new() -> Self { EnvVarPreviewer { diff --git a/crates/television/previewers/files.rs b/crates/television/previewers/files.rs index 78a76ca..d59c29f 100644 --- a/crates/television/previewers/files.rs +++ b/crates/television/previewers/files.rs @@ -31,6 +31,12 @@ pub struct FilePreviewer { //image_picker: Arc>, } +impl Default for FilePreviewer { + fn default() -> Self { + FilePreviewer::new() + } +} + impl FilePreviewer { pub fn new() -> Self { let syntax_set = SyntaxSet::load_defaults_nonewlines();