From 65824798e50c3b4d95fd35d64d214076c7a4c498 Mon Sep 17 00:00:00 2001 From: Jan Hohenheim Date: Mon, 22 Jan 2024 16:58:05 +0100 Subject: [PATCH 1/5] Fix lints --- crates/bevy_plugin/src/commands/command_registry.rs | 1 - crates/bevy_plugin/src/localization/strings_file/asset.rs | 2 +- crates/bevy_plugin/tests/utils/assertion.rs | 3 --- crates/bevy_plugin/tests/utils/mod.rs | 1 - .../src/compilation_steps/add_initial_value_registrations.rs | 2 +- crates/compiler/src/compiler.rs | 1 - crates/core/src/types.rs | 2 +- crates/core/src/yarn_fn/function_registry.rs | 3 +-- 8 files changed, 4 insertions(+), 11 deletions(-) diff --git a/crates/bevy_plugin/src/commands/command_registry.rs b/crates/bevy_plugin/src/commands/command_registry.rs index 268878bc..ef289a18 100644 --- a/crates/bevy_plugin/src/commands/command_registry.rs +++ b/crates/bevy_plugin/src/commands/command_registry.rs @@ -151,7 +151,6 @@ macro_rules! yarn_commands { } use crate::commands::command_registry::wait::Wait; -pub use yarn_commands; #[cfg(test)] mod tests { diff --git a/crates/bevy_plugin/src/localization/strings_file/asset.rs b/crates/bevy_plugin/src/localization/strings_file/asset.rs index 3c89e07a..bb215c6a 100644 --- a/crates/bevy_plugin/src/localization/strings_file/asset.rs +++ b/crates/bevy_plugin/src/localization/strings_file/asset.rs @@ -232,7 +232,7 @@ fn combine_comments(full_old_comment: &str, new_metadata: &str) -> String { let new_metadata = (!new_metadata.is_empty()).then_some(new_metadata); [translator_comment, new_metadata] .into_iter() - .filter_map(|s| s) + .flatten() .collect::>() .join(LINE_METADATA_PREFIX_SEPARATOR) } diff --git a/crates/bevy_plugin/tests/utils/assertion.rs b/crates/bevy_plugin/tests/utils/assertion.rs index a72d7efc..fec0b943 100644 --- a/crates/bevy_plugin/tests/utils/assertion.rs +++ b/crates/bevy_plugin/tests/utils/assertion.rs @@ -66,7 +66,6 @@ macro_rules! get_reader { &mut $asserter.execute_command_reader }; } -pub use get_reader; #[macro_export] macro_rules! assert_events { @@ -95,5 +94,3 @@ macro_rules! assert_events { )? }; } - -pub use assert_events; diff --git a/crates/bevy_plugin/tests/utils/mod.rs b/crates/bevy_plugin/tests/utils/mod.rs index 503dbd4d..4b3c0321 100644 --- a/crates/bevy_plugin/tests/utils/mod.rs +++ b/crates/bevy_plugin/tests/utils/mod.rs @@ -11,7 +11,6 @@ mod assertion; pub mod prelude { pub use super::*; - pub use assertion::*; } pub trait AppExt { diff --git a/crates/compiler/src/compilation_steps/add_initial_value_registrations.rs b/crates/compiler/src/compilation_steps/add_initial_value_registrations.rs index 5c5b5414..1c91f4f5 100644 --- a/crates/compiler/src/compilation_steps/add_initial_value_registrations.rs +++ b/crates/compiler/src/compilation_steps/add_initial_value_registrations.rs @@ -28,7 +28,7 @@ pub(crate) fn add_initial_value_registrations( }; if let Some(ref mut program) = compilation.program { let value = match &declaration.r#type { - Type::String => Operand::from(String::try_from(default_value).unwrap()), + Type::String => Operand::from(String::from(default_value)), Type::Number => Operand::from(f32::try_from(default_value).unwrap()), Type::Boolean => Operand::from(bool::try_from(default_value).unwrap()), _ => panic!("Cannot create initial value registration for type {}. This is a bug. Please report it at https://github.com/yarn-slinger/yarn_slinger/issues/new", declaration.r#type.format()), diff --git a/crates/compiler/src/compiler.rs b/crates/compiler/src/compiler.rs index efeaf16f..8a3380bf 100644 --- a/crates/compiler/src/compiler.rs +++ b/crates/compiler/src/compiler.rs @@ -9,7 +9,6 @@ mod add_tags_to_lines; pub(crate) mod antlr_rust_ext; pub(crate) mod run_compilation; pub(crate) mod utils; -pub use add_tags_to_lines::*; #[allow(missing_docs)] pub type Result = std::result::Result; diff --git a/crates/core/src/types.rs b/crates/core/src/types.rs index 782beb80..fd79b897 100644 --- a/crates/core/src/types.rs +++ b/crates/core/src/types.rs @@ -2,7 +2,7 @@ //! ## Implementation Notes //! - `IBridgeableType` is not implemented because it is not actually used anywhere. -pub use {function::*, r#type::*, r#type::*, type_util::*}; +pub use {function::*, r#type::*, type_util::*}; mod any; mod boolean; diff --git a/crates/core/src/yarn_fn/function_registry.rs b/crates/core/src/yarn_fn/function_registry.rs index bb0c7f3b..f7145fbb 100644 --- a/crates/core/src/yarn_fn/function_registry.rs +++ b/crates/core/src/yarn_fn/function_registry.rs @@ -181,8 +181,7 @@ mod tests { true.into(), 1.0.into(), ])) - .try_into() - .unwrap(); + .into(); assert!(result1); assert_eq!(result2, 3.0); From 7db89a58bf258d503e1f45bbe235a2751bb12b04 Mon Sep 17 00:00:00 2001 From: Jan Hohenheim Date: Mon, 22 Jan 2024 17:06:05 +0100 Subject: [PATCH 2/5] Fix lints --- crates/bevy_plugin/tests/utils/assertion.rs | 2 +- crates/bevy_plugin/tests/utils/mod.rs | 5 +++-- crates/yarn_slinger/tests/test_base/mod.rs | 1 + 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/crates/bevy_plugin/tests/utils/assertion.rs b/crates/bevy_plugin/tests/utils/assertion.rs index fec0b943..01756bf3 100644 --- a/crates/bevy_plugin/tests/utils/assertion.rs +++ b/crates/bevy_plugin/tests/utils/assertion.rs @@ -79,7 +79,7 @@ macro_rules! assert_events { }; ($asserter:ident, $app:ident contains $event:ident (n = $num:expr) $(with $pred:expr)?) => { let events = $app.world.resource::>(); - let reader = $crate::prelude::get_reader!($asserter, $event); + let reader = $crate::get_reader!($asserter, $event); let events: Vec<&$event> = reader.iter(&events).collect(); assert_eq!($num, events.len(), "Expected {} events of type {}, but found {}: {events:#?}", stringify!($num), stringify!($event), events.len()); $( diff --git a/crates/bevy_plugin/tests/utils/mod.rs b/crates/bevy_plugin/tests/utils/mod.rs index 4b3c0321..e29bd662 100644 --- a/crates/bevy_plugin/tests/utils/mod.rs +++ b/crates/bevy_plugin/tests/utils/mod.rs @@ -7,10 +7,11 @@ use bevy_yarn_slinger::prelude::*; use bevy_yarn_slinger::UnderlyingYarnLine; use std::path::{Path, PathBuf}; -mod assertion; +pub mod assertion; pub mod prelude { - pub use super::*; + #[allow(unused_imports)] // False positive + pub use super::{assertion::*, *}; } pub trait AppExt { diff --git a/crates/yarn_slinger/tests/test_base/mod.rs b/crates/yarn_slinger/tests/test_base/mod.rs index 7035808d..19e8638e 100644 --- a/crates/yarn_slinger/tests/test_base/mod.rs +++ b/crates/yarn_slinger/tests/test_base/mod.rs @@ -34,6 +34,7 @@ pub use text_provider::SharedTextProvider; use yarn_slinger::log::{self, LevelFilter, SetLoggerError}; pub mod prelude { + #[allow(unused_imports)] // False positive pub use crate::test_base::{extensions::*, paths::*, step::*, test_plan::*, *}; } From 71923de2a27312cecbc1a6c3e2d2f4103aa0c62d Mon Sep 17 00:00:00 2001 From: Jan Hohenheim Date: Mon, 22 Jan 2024 17:08:03 +0100 Subject: [PATCH 3/5] Fix some paths --- docs/src/SUMMARY.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 9fba0e16..5961eb10 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,22 +1,22 @@ - [Introduction](./introduction.md) - [Yarn Files](yarn_files.md) - - [Basics](yarn_files/basics.md) - - [Running Examples](yarn_files/running_examples.md) - - [Lines](yarn_files/lines.md) - - [Variables](yarn_files/variables.md) - - [Options](yarn_files/options.md) - - [Nodes](yarn_files/nodes.md) - - [Markup](yarn_files/markup.md) - - [Functions](yarn_files/functions.md) - - [Commands](yarn_files/commands.md) -- [Bevy Plugin](bevy_plugin.md) - - [Setup](bevy_plugin/setup.md) - - [Compiling Yarn Files](bevy_plugin/compiling_yarn_files.md) - - [`DialogRunner` and a High Level Overview](bevy_plugin/dialog_runner.md) - - [Localization](bevy_plugin/localization.md) - - [Assets](bevy_plugin/assets.md) - - [Variable Storage](bevy_plugin/variable_storage.md) - - [Custom Functions](bevy_plugin/custom_functions.md) - - [Custom Commands](bevy_plugin/custom_commands.md) - - [Dialog Views](bevy_plugin/dialog_views.md) + - [Basics](./yarn_files/basics.md) + - [Running Examples](./yarn_files/running_examples.md) + - [Lines](./yarn_files/lines.md) + - [Variables](./yarn_files/variables.md) + - [Options](./yarn_files/options.md) + - [Nodes](./yarn_files/nodes.md) + - [Markup](./yarn_files/markup.md) + - [Functions](./yarn_files/functions.md) + - [Commands](./yarn_files/commands.md) +- [Bevy Plugin](./bevy_plugin.md) + - [Setup](./bevy_plugin/setup.md) + - [Compiling Yarn Files](./bevy_plugin/compiling_yarn_files.md) + - [`DialogRunner` and a High Level Overview](./bevy_plugin/dialog_runner.md) + - [Localization](./bevy_plugin/localization.md) + - [Assets](./bevy_plugin/assets.md) + - [Variable Storage](./bevy_plugin/variable_storage.md) + - [Custom Functions](./bevy_plugin/custom_functions.md) + - [Custom Commands](./bevy_plugin/custom_commands.md) + - [Dialog Views](./bevy_plugin/dialog_views.md) - [Porting Yarn Slinger](./porting_yarn_slinger.md) From 2ba05033d90498dc1b15bc377c1099ff8ef6b069 Mon Sep 17 00:00:00 2001 From: Jan Hohenheim Date: Mon, 22 Jan 2024 17:12:29 +0100 Subject: [PATCH 4/5] Add some config to book --- docs/book.toml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/book.toml b/docs/book.toml index f10d6125..8e74746f 100644 --- a/docs/book.toml +++ b/docs/book.toml @@ -4,3 +4,10 @@ language = "en" multilingual = false src = "src" title = "Yarn Slinger Book" + +[output.html] +git-repository-url = "https://github.com/yarn-slinger/yarn-slinger" +git-repository-icon = "fa-github" +edit-url-template = "https://github.com/yarn-slinger/yarn-slinger/edit/main/docs/src/{path}" +site-url = "/yarn-slinger/" +cname = "https://yarn-slinger.github.io" From 60dca928a8f4fd8f36634bae7bc3ee0fac8002e7 Mon Sep 17 00:00:00 2001 From: Jan Hohenheim Date: Mon, 22 Jan 2024 17:15:08 +0100 Subject: [PATCH 5/5] Fix some paths --- docs/src/SUMMARY.md | 2 +- docs/src/introduction.md | 2 +- docs/src/working_with_yarn_slinger.md | 5 ----- 3 files changed, 2 insertions(+), 7 deletions(-) delete mode 100644 docs/src/working_with_yarn_slinger.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 5961eb10..4901aaae 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,5 +1,5 @@ - [Introduction](./introduction.md) -- [Yarn Files](yarn_files.md) +- [Yarn Files](./yarn_files.md) - [Basics](./yarn_files/basics.md) - [Running Examples](./yarn_files/running_examples.md) - [Lines](./yarn_files/lines.md) diff --git a/docs/src/introduction.md b/docs/src/introduction.md index a2f2c354..bf20912f 100644 --- a/docs/src/introduction.md +++ b/docs/src/introduction.md @@ -5,6 +5,6 @@ Yarn Slinger is a port of the widely used dialogue tool [Yarn Spinner](https://y Please click on the link that describes your situation the best. -- [I'm new to all of this](./working_with_yarn_slinger.md) +- [I'm new to all of this](./yarn_files.md) - [I have used Yarn Spinner for Unity before](./bevy_plugin.md) - [I want to port Yarn Slinger to another language than Rust or another engine than Bevy](./porting_yarn_slinger.md) diff --git a/docs/src/working_with_yarn_slinger.md b/docs/src/working_with_yarn_slinger.md deleted file mode 100644 index bb488396..00000000 --- a/docs/src/working_with_yarn_slinger.md +++ /dev/null @@ -1,5 +0,0 @@ -# Working with Yarn Slinger - - -They both share the idea of writing dialog in writer-friendly text files called *Yarn files*. We -will take a look at how to write these in the next chapter, [Yarn Files](yarn_files.md).