Written by @Weicao-CatilGrass
diff --git a/docs/_zh_CN/pages/2-implementing-fallbacks.md b/docs/_zh_CN/pages/2-implementing-fallbacks.md index 5ed7242..a7c04d0 100644 --- a/docs/_zh_CN/pages/2-implementing-fallbacks.md +++ b/docs/_zh_CN/pages/2-implementing-fallbacks.md @@ -133,7 +133,9 @@ thread 'main' (90772) panicked at src/bin/your-bin.rs:30:5: Renderer "ResultGreetSomeone" not found! note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace ``` - + + 以上便是 **Mingling** 的回退机制，在接下来的章节中，您将学习如何使用 `Picker` 解析复杂的用户输入。 +Written by @Weicao-CatilGrass
diff --git a/docs/_zh_CN/pages/3-parsing-complex-arguments.md b/docs/_zh_CN/pages/3-parsing-complex-arguments.md new file mode 100644 index 0000000..17e8f93 --- /dev/null +++ b/docs/_zh_CN/pages/3-parsing-complex-arguments.md @@ -0,0 +1,365 @@ ++ 使用 Mingling Picker 解析复杂的用户输入 +
+ +## 引言 + + 在前文的示例中，我们成功创建了带有 `"greet"` 子命令的命令行程序，可以输出用户输入的第一个参数。 + + 您也注意到了，示例当中使用的方式近乎直接操作字符串，不够语义化，这不利于长期维护。 + +```rust +let name = args.first().cloned().unwrap_or_else(|| "World".to_string()); +``` + + 而本章节将会引入新的 **Mingling** 特性：`Picker`，它提供轻量且和 **Mingling** 类型路由高度契合的命令解析方案。 + + 要启用 `Picker`，您需要修改 `Cargo.toml` ✏️ + +```toml +[dependencies] +mingling = { + version = "...", + features = ["parser"] +} +``` + + 好了，多的不说，让我们上手编辑代码，重写前文的解析代码 ✏️ + +```rust +#[chain] +fn handle_greet_entry(prev: GreetEntry) -> NextProcess { + // 前文中使用的方式： + // let args = prev.inner; + // let name = args.first().cloned().unwrap_or_else(|| "World".to_string()); + + // 引入 Picker 后使用的方式 + let name = prev.pick_or((), "World").unpack(); + + ResultGreetSomeone::new(name) +} +``` + + `Picker` 为所有 `Into+ Written by @Weicao-CatilGrass +
diff --git a/docs/_zh_CN/pages/4-implementing-help-display.md b/docs/_zh_CN/pages/4-implementing-help-display.md new file mode 100644 index 0000000..57179d7 --- /dev/null +++ b/docs/_zh_CN/pages/4-implementing-help-display.md @@ -0,0 +1,4 @@ ++ 用 help 宏为命令实现帮助文档 +
diff --git a/docs/_zh_CN/pages/5-implementing-completion.md b/docs/_zh_CN/pages/5-implementing-completion.md new file mode 100644 index 0000000..f0729f7 --- /dev/null +++ b/docs/_zh_CN/pages/5-implementing-completion.md @@ -0,0 +1,4 @@ ++ 使用 Mingling Completion 实现全动态补全系统 +
diff --git a/docs/pages/1-creating-your-first-program.md b/docs/pages/1-creating-your-first-program.md index 75c5081..1dacb82 100644 --- a/docs/pages/1-creating-your-first-program.md +++ b/docs/pages/1-creating-your-first-program.md @@ -250,6 +250,8 @@ Hello, World! ~> your-bin greet Alice Hello, Alice! ``` + + At this point, you have successfully created a basic **Mingling** command-line program. The next chapter will explain how to implement a fallback mechanism for your command-line program to handle cases where a command or renderer does not exist.Written by @Weicao-CatilGrass diff --git a/docs/pages/2-implementing-fallbacks.md b/docs/pages/2-implementing-fallbacks.md index a820fa1..685d238 100644 --- a/docs/pages/2-implementing-fallbacks.md +++ b/docs/pages/2-implementing-fallbacks.md @@ -134,6 +134,8 @@ Renderer "ResultGreetSomeone" not found! note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace ``` + The above is the fallback mechanism of **Mingling**. In the next chapter, you will learn how to use `Picker` to parse complex user inputs. +
Written by @Weicao-CatilGrass
diff --git a/docs/pages/3-parsing-complex-arguments.md b/docs/pages/3-parsing-complex-arguments.md new file mode 100644 index 0000000..285e17d --- /dev/null +++ b/docs/pages/3-parsing-complex-arguments.md @@ -0,0 +1,365 @@ ++ Use Mingling Picker to parse complex user input +
+ +## Intro + + In the prev. example, we built a CLI app with a `"greet"` subcommand that outputs the user's first arg. + + You may have noticed the approach used was almost direct string manipulation—not very semantic, and hard to maintain long-term. + +```rust +let name = args.first().cloned().unwrap_or_else(|| "World".to_string()); +``` + + This chapter introduces a new **Mingling** feature: `Picker`. It provides a lightweight parsing solution that meshes well with **Mingling**'s typed routing. + + To enable `Picker`, edit `Cargo.toml` ✏️ + +```toml +[dependencies] +mingling = { + version = "...", + features = ["parser"] +} +``` + + Enough talk, let's get coding and rewrite the parsing logic from the prev. section ✏️ + +```rust +#[chain] +fn handle_greet_entry(prev: GreetEntry) -> NextProcess { + // Prev. approach: + // let args = prev.inner; + // let name = args.first().cloned().unwrap_or_else(|| "World".to_string()); + + // New approach with Picker + let name = prev.pick_or((), "World").unpack(); + + ResultGreetSomeone::new(name) +} +``` + + `Picker` implements `pick`, `pick_or`, and `pick_or_route` for anything `Into+ Written by @Weicao-CatilGrass +
diff --git a/docs/pages/4-implementing-help-display.md b/docs/pages/4-implementing-help-display.md new file mode 100644 index 0000000..625863e --- /dev/null +++ b/docs/pages/4-implementing-help-display.md @@ -0,0 +1,4 @@ ++ Implement help documentation for commands using the help macro +
diff --git a/docs/pages/5-implementing-completion.md b/docs/pages/5-implementing-completion.md new file mode 100644 index 0000000..7622775 --- /dev/null +++ b/docs/pages/5-implementing-completion.md @@ -0,0 +1,4 @@ ++ Implementing a fully dynamic completion system using Mingling Completion +
-- cgit