Skip to content

docs: initial documentation for MetaSSR #14

docs: initial documentation for MetaSSR

docs: initial documentation for MetaSSR #14

Triggered via pull request August 22, 2024 19:21
@hulxvhulxv
synchronize #7
docs
Status Success
Total duration 31s
Artifacts

clippy.yml

on: pull_request
clippy_check
23s
clippy_check
Fit to window
Zoom out
Zoom in

Annotations

13 warnings
an implementation of `From` is preferred since it gives you `Into<_>` for free where the reverse isn't true: metassr-cli/src/cli/builder.rs#L71
warning: an implementation of `From` is preferred since it gives you `Into<_>` for free where the reverse isn't true --> metassr-cli/src/cli/builder.rs:71:1 | 71 | impl Into<server::BuildingType> for BuildingType { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: `impl From<Local> for Foreign` is allowed by the orphan rules, for more information see https://doc.rust-lang.org/reference/items/implementations.html#trait-implementation-coherence = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#from_over_into = note: `#[warn(clippy::from_over_into)]` on by default help: replace the `Into` implementation with `From<cli::builder::BuildingType>` | 71 ~ impl From<BuildingType> for server::BuildingType { 72 ~ fn from(val: BuildingType) -> Self { 73 ~ match val { 74 ~ BuildingType::SSG => server::BuildingType::StaticSiteGeneration, 75 ~ BuildingType::SSR => server::BuildingType::ServerSideRendering, |
name `SSR` contains a capitalized acronym: metassr-cli/src/cli/builder.rs#L68
warning: name `SSR` contains a capitalized acronym --> metassr-cli/src/cli/builder.rs:68:5 | 68 | SSR, | ^^^ help: consider making the acronym lowercase, except the initial letter: `Ssr` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#upper_case_acronyms
name `SSG` contains a capitalized acronym: metassr-cli/src/cli/builder.rs#L66
warning: name `SSG` contains a capitalized acronym --> metassr-cli/src/cli/builder.rs:66:5 | 66 | SSG, | ^^^ help: consider making the acronym lowercase, except the initial letter: `Ssg` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#upper_case_acronyms = note: `#[warn(clippy::upper_case_acronyms)]` on by default
this import is redundant: metassr-cli/src/cli/creator.rs#L2
warning: this import is redundant --> metassr-cli/src/cli/creator.rs:2:1 | 2 | use metassr_create; | ^^^^^^^^^^^^^^^^^^^ help: remove it entirely | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#single_component_path_imports = note: `#[warn(clippy::single_component_path_imports)]` on by default
unused variable: `path`: crates/metassr-server/src/handler.rs#L49
warning: unused variable: `path` --> crates/metassr-server/src/handler.rs:49:28 | 49 | Path(path): Path<HashMap<String, String>>| async move { | ^^^^ help: if this is intentional, prefix it with an underscore: `_path`
unused variable: `params`: crates/metassr-server/src/handler.rs#L48
warning: unused variable: `params` --> crates/metassr-server/src/handler.rs:48:29 | 48 | move |Query(params): Query<HashMap<String, String>>, | ^^^^^^ help: if this is intentional, prefix it with an underscore: `_params` | = note: `#[warn(unused_variables)]` on by default
this expression creates a reference which is immediately dereferenced by the compiler: crates/metassr-create/src/lib.rs#L36
warning: this expression creates a reference which is immediately dereferenced by the compiler --> crates/metassr-create/src/lib.rs:36:43 | 36 | let template = self.template.load(&self)?; | ^^^^^ help: change this to: `self` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_borrow = note: `#[warn(clippy::needless_borrow)]` on by default
direct implementation of `ToString`: crates/metassr-create/src/templates.rs#L20
warning: direct implementation of `ToString` --> crates/metassr-create/src/templates.rs:20:1 | 20 | / impl ToString for Template { 21 | | fn to_string(&self) -> String { 22 | | match *self { 23 | | Self::Javascript => "javascript", ... | 27 | | } 28 | | } | |_^ | = help: prefer implementing `Display` instead = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#to_string_trait_impl = note: `#[warn(clippy::to_string_trait_impl)]` on by default
you should consider adding a `Default` implementation for `Rand`: crates/metassr-utils/src/rand.rs#L11
warning: you should consider adding a `Default` implementation for `Rand` --> crates/metassr-utils/src/rand.rs:11:5 | 11 | / pub fn new() -> Self { 12 | | let val = RandomState::new().build_hasher().finish() as i64; 13 | | Self(val.abs()) 14 | | } | |_____^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#new_without_default = note: `#[warn(clippy::new_without_default)]` on by default help: try adding this | 10 + impl Default for Rand { 11 + fn default() -> Self { 12 + Self::new() 13 + } 14 + } |
methods called `new` usually return `Self`: crates/html-generator/src/html_props.rs#L17
warning: methods called `new` usually return `Self` --> crates/html-generator/src/html_props.rs:17:5 | 17 | / pub fn new() -> HtmlPropsBuilder { 18 | | HtmlPropsBuilder::new() 19 | | } | |_____^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#new_ret_no_self = note: `#[warn(clippy::new_ret_no_self)]` on by default
direct implementation of `ToString`: crates/html-generator/src/builder.rs#L26
warning: direct implementation of `ToString` --> crates/html-generator/src/builder.rs:26:1 | 26 | / impl ToString for HtmlOutput { 27 | | fn to_string(&self) -> String { 28 | | self.0.clone() 29 | | } 30 | | } | |_^ | = help: prefer implementing `Display` instead = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#to_string_trait_impl = note: `#[warn(clippy::to_string_trait_impl)]` on by default
clippy_check
The following actions uses node12 which is deprecated and will be forced to run on node16: actions-rs/clippy-check@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
clippy_check
The following actions use a deprecated Node.js version and will be forced to run on node20: actions-rs/clippy-check@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/