From ec9edc294fd5e7e29977fc7b0e6fb953422bc0e2 Mon Sep 17 00:00:00 2001 From: ι­ζ›Ήε…ˆη”Ÿ <1992414357@qq.com> Date: Wed, 19 Aug 2026 05:54:00 +0800 Subject: chore: reorganize dev tools into dev/ directory and consolidate configs Move CI, dev tools, and configs from root-level scattered locations into a unified `dev/` directory structure. Update all references across build scripts, documentation, and editor configurations. Also consolidate editor config generation into build.rs for automated synchronization of rust-analyzer settings across VS Code and Zed. --- docs/LICENSE | 21 -- docs/_zh_CN/index.html | 2 +- docs/dev/README.md | 2 +- docs/dev/index.html | 2 +- docs/dev/pages/abouts/ci.md | 72 ++--- docs/dev/pages/abouts/code-verify-system.md | 20 +- docs/doc.html | 111 -------- docs/example-pages/examples.json | 393 ---------------------------- docs/example-viewer.html | 4 +- docs/examples.html | 4 +- docs/examples.json | 393 ++++++++++++++++++++++++++++ docs/index.html | 111 ++++++++ docs/licenses/docsify.md | 21 ++ 13 files changed, 578 insertions(+), 578 deletions(-) delete mode 100644 docs/LICENSE delete mode 100644 docs/doc.html delete mode 100644 docs/example-pages/examples.json create mode 100644 docs/examples.json create mode 100644 docs/index.html create mode 100644 docs/licenses/docsify.md (limited to 'docs') diff --git a/docs/LICENSE b/docs/LICENSE deleted file mode 100644 index bec4d76..0000000 --- a/docs/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2021 docsifyjs - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/docs/_zh_CN/index.html b/docs/_zh_CN/index.html index ad21062..d0b9234 100644 --- a/docs/_zh_CN/index.html +++ b/docs/_zh_CN/index.html @@ -41,7 +41,7 @@ " >πŸŒ— 主钘 - English Docs + English Docs
diff --git a/docs/dev/README.md b/docs/dev/README.md index 9289fcf..29b7568 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md @@ -4,7 +4,7 @@ Internal development documentation for the Mingling codebase β€” design notes, issue discussions, and architectural decisions.

-This site is separate from the [Helpdoc](https://mingling-rs.github.io/mingling/docs/doc.html). +This site is separate from the [Helpdoc](https://mingling-rs.github.io/mingling/docs/index.html). The helpdoc is user-facing: `tutorials`, `feature guides`, and `how-to content` for developers _using_ Mingling to build CLI applications. diff --git a/docs/dev/index.html b/docs/dev/index.html index 1bfb5c5..327e397 100644 --- a/docs/dev/index.html +++ b/docs/dev/index.html @@ -125,7 +125,7 @@ " >πŸŒ“ Theme - πŸ“– Helpdoc + πŸ“– Helpdoc
diff --git a/docs/dev/pages/abouts/ci.md b/docs/dev/pages/abouts/ci.md index f9a58be..37015eb 100644 --- a/docs/dev/pages/abouts/ci.md +++ b/docs/dev/pages/abouts/ci.md @@ -3,7 +3,7 @@ CI workflow and local execution guide for Mingling

-Mingling's CI process is built into the project itself: the execution logic lives in `mingling_ci/`, a separate crate **built on the Mingling framework** β€” it dogfoods the very library it validates. You can run it locally via the `cargo ci` command, which produces the same results as the `CI` workflow in GitHub Actions. +Mingling's CI process is built into the project itself: the execution logic lives in `dev/ci/`, a separate crate **built on the Mingling framework** β€” it dogfoods the very library it validates. You can run it locally via the `cargo ci` command, which produces the same results as the `CI` workflow in GitHub Actions. During development, you can run `cargo ci ` at any time to verify that your code hasn't introduced regressions. @@ -13,7 +13,7 @@ An alias is defined in `.cargo/config.toml` at the project root: ```toml [alias] -ci = "run --manifest-path mingling_ci/Cargo.toml --bin ci --quiet --" +ci = "run --manifest-path dev/ci/Cargo.toml --bin ci --quiet --" ``` Run a single step: @@ -40,38 +40,38 @@ Every CI step is one subcommand. `cargo ci` with no subcommand prints the help p ### UTILS -| Command | What it does | -| --------------- | ----------------------------------------------------------------------- | +| Command | What it does | +| ---------------- | --------------------------------------------------------------------------------------- | | `report-collect` | Assembles the collected logs in `.temp/reports/collect/` into `.temp/reports/result.md` | -| `report-clean` | Deletes all collected logs and the generated report | -| `git-lock` | Locks the workspace for a CI run (temporary commit, see below) | -| `git-unlock` | Restores the workspace and checks idempotency (see below) | -| `show-manifests` | Prints every crate path that CI will check | -| `show-features` | Prints the `docs.rs` feature list of `mingling` | +| `report-clean` | Deletes all collected logs and the generated report | +| `git-lock` | Locks the workspace for a CI run (temporary commit, see below) | +| `git-unlock` | Restores the workspace and checks idempotency (see below) | +| `show-manifests` | Prints every crate path that CI will check | +| `show-features` | Prints the `docs.rs` feature list of `mingling` | ### TOOLS (refresh) -| Command | What it does | -| ------------------- | --------------------------------------------------------------------------------- | -| `example-refresh` | Regenerates `mingling/src/example_docs.rs` and `docs/example-pages/examples.json` | -| `docsify-refresh` | Fixes docsify code-box blank lines and regenerates `_sidebar.md` files | -| `features-refresh` | Regenerates `mingling/src/features.rs` from `mingling/Cargo.toml` | +| Command | What it does | +| ------------------ | ---------------------------------------------------------------------- | +| `example-refresh` | Regenerates `mingling/src/example_docs.rs` and `docs/examples.json` | +| `docsify-refresh` | Fixes docsify code-box blank lines and regenerates `_sidebar.md` files | +| `features-refresh` | Regenerates `mingling/src/features.rs` from `mingling/Cargo.toml` | These tools **write files**. Running them inside a `git-lock` / `git-unlock` pair turns them into an up-to-date check: if the generated files are stale, the tree becomes dirty and `git-unlock` fails. ### TASKS (checks) -| Command | What it does | -| ----------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `build-check` | Finds all `Cargo.toml` files (minus `.config/ci-ignored-dirs.txt`) and runs `cargo build` per crate in parallel. | -| `clippy-check` | Runs `cargo clippy ... -- -D warnings` for every crate in parallel; any warning fails the check. | -| `test-all` | Runs `cargo test` for every crate in parallel. Each base crate can override its command in its `mingling-ci.toml` (`[test].command`, with `<<>>` expanded from the docs.rs feature list); `arg-picker` uses this to run `cargo test -p arg-picker`. | -| `example-check` | Builds every example and runs the expected-output tests declared in `examples//test.toml`. | -| `docs-check` | Builds the `mingling` API docs with the `[package.metadata.docs.rs]` features and `-D warnings`. | -| `markdown-check ` | Verifies the rust code blocks of a single markdown file compile. See [ABOUT_CODE_VERIFY](docs/_ABOUT_CODE_VERIFY.md). | -| `markdown-check-all` | Verifies all markdown files declared in `.config/verified-docs.toml`. | -| `markdown-compare ` | Compares the *structure* of two markdown files or directories. | -| `markdown-compare-all` | Checks every translated docs directory mirrors the reference `./docs/pages/` (per `.config/docs-lang.txt`). | +| Command | What it does | +| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `build-check` | Finds all `Cargo.toml` files (minus `dev/configs/ci-ignored-dirs.txt`) and runs `cargo build` per crate in parallel. | +| `clippy-check` | Runs `cargo clippy ... -- -D warnings` for every crate in parallel; any warning fails the check. | +| `test-all` | Runs `cargo test` for every crate in parallel. Each base crate can override its command in its `mingling-ci.toml` (`[test].command`, with `<<>>` expanded from the docs.rs feature list); `arg-picker` uses this to run `cargo test -p arg-picker`. | +| `example-check` | Builds every example and runs the expected-output tests declared in `examples//test.toml`. | +| `docs-check` | Builds the `mingling` API docs with the `[package.metadata.docs.rs]` features and `-D warnings`. | +| `markdown-check ` | Verifies the rust code blocks of a single markdown file compile. See [ABOUT_CODE_VERIFY](docs/_ABOUT_CODE_VERIFY.md). | +| `markdown-check-all` | Verifies all markdown files declared in `dev/configs/verified-docs.toml`. | +| `markdown-compare ` | Compares the _structure_ of two markdown files or directories. | +| `markdown-compare-all` | Checks every translated docs directory mirrors the reference `./docs/pages/` (per `dev/configs/docs-lang.txt`). | ## Reports @@ -122,7 +122,7 @@ cargo ci git-unlock --show-diff This is what the CI workflow uses: an idempotency failure shows exactly what contaminated the workspace in the job logs. -> **Warning**: when unlocking a `true` lock, changes made *during* CI are discarded. Anything you had before locking comes back. +> **Warning**: when unlocking a `true` lock, changes made _during_ CI are discarded. Anything you had before locking comes back. ## GitHub Actions Workflow @@ -131,16 +131,16 @@ This is what the CI workflow uses: an idempotency failure shows exactly what con - Triggered on `push` to the `main` branch. - A `Check` job runs in a **item Γ— platform** matrix (`ubuntu-latest`, `windows-latest`, `macos-latest`), each combination being `cargo ci ` inside a `git-lock` / `git-unlock` pair: -| Matrix item | Command | -| -------------- | -------------------------------------------------------------- | -| `build` | `cargo ci build-check` | -| `clippy` | `cargo ci clippy-check` | -| `test` | `cargo ci test-all` | -| `arg-picker` | `cargo ci test-all` (covered via its `mingling-ci.toml` override) | -| `markdown-code` | `cargo ci markdown-check-all && cargo ci markdown-compare-all` | -| `examples` | `cargo ci example-check` | -| `docs-refresh` | `cargo ci example-refresh` + `docsify-refresh` + `features-refresh` | -| `api-docs` | `cargo ci docs-check` | +| Matrix item | Command | +| --------------- | ------------------------------------------------------------------- | +| `build` | `cargo ci build-check` | +| `clippy` | `cargo ci clippy-check` | +| `test` | `cargo ci test-all` | +| `arg-picker` | `cargo ci test-all` (covered via its `mingling-ci.toml` override) | +| `markdown-code` | `cargo ci markdown-check-all && cargo ci markdown-compare-all` | +| `examples` | `cargo ci example-check` | +| `docs-refresh` | `cargo ci example-refresh` + `docsify-refresh` + `features-refresh` | +| `api-docs` | `cargo ci docs-check` | - Every matrix job uploads its `.temp/reports/collect/` as an artifact β€” **even on failure**, so failures are always collected. - A `Report` job (runs even when some checks failed) downloads all collect artifacts, runs `cargo ci report-collect`, and publishes `result.md` to the job summary via `$GITHUB_STEP_SUMMARY`. diff --git a/docs/dev/pages/abouts/code-verify-system.md b/docs/dev/pages/abouts/code-verify-system.md index c2a9215..f52052f 100644 --- a/docs/dev/pages/abouts/code-verify-system.md +++ b/docs/dev/pages/abouts/code-verify-system.md @@ -7,7 +7,7 @@ This system automatically extracts and compiles Rust code blocks from docs, ensu ## Config -Specify which Markdown files to verify via `.config/verified-docs.toml`: +Specify which Markdown files to verify via `dev/configs/verified-docs.toml`: ```toml [verified] @@ -210,18 +210,18 @@ Use `@@@` for: ## Structure Overview -| Module | Responsibility | -| --------------------------------------------- | ----------------------------------------------------------------------------------- | -| `mingling_ci/src/markdown/project.rs` | Block parsing, Cargo.toml/main.rs generation, FNV-1a dep hash | -| `mingling_ci/src/markdown/test.rs` | Grouping by dep hash, parallel `cargo check` execution | -| `mingling_ci/src/task/cmd_markdown_check.rs` | `markdown-check` / `markdown-check-all` commands: read config, collect files, report | -| `mingling_ci/src/markdown/compare.rs` | Structural signature comparison (for `markdown-compare`) | -| `mingling_ci/src/task/cmd_markdown_compare.rs`| `markdown-compare` / `markdown-compare-all` commands | -| `.config/verified-docs.toml` | Specifies which doc files to verify | +| Module | Responsibility | +| ----------------------------------------- | ------------------------------------------------------------------------------------ | +| `dev/ci/src/markdown/project.rs` | Block parsing, Cargo.toml/main.rs generation, FNV-1a dep hash | +| `dev/ci/src/markdown/test.rs` | Grouping by dep hash, parallel `cargo check` execution | +| `dev/ci/src/task/cmd_markdown_check.rs` | `markdown-check` / `markdown-check-all` commands: read config, collect files, report | +| `dev/ci/src/markdown/compare.rs` | Structural signature comparison (for `markdown-compare`) | +| `dev/ci/src/task/cmd_markdown_compare.rs` | `markdown-compare` / `markdown-compare-all` commands | +| `dev/configs/verified-docs.toml` | Specifies which doc files to verify | ### Structure Comparison -`markdown-compare` (two files or directories) and `markdown-compare-all` (all languages from `.config/docs-lang.txt`, whose first line is the reference directory) check that every translated docs directory **mirrors the structure** of the reference docs exactly: one token per line classifying headings, fenced code blocks (with language tag), `@@@` lines, blank lines, blockquotes, lists and plain text. Translated text may differ; the structure may not. +`markdown-compare` (two files or directories) and `markdown-compare-all` (all languages from `dev/configs/docs-lang.txt`, whose first line is the reference directory) check that every translated docs directory **mirrors the structure** of the reference docs exactly: one token per line classifying headings, fenced code blocks (with language tag), `@@@` lines, blank lines, blockquotes, lists and plain text. Translated text may differ; the structure may not. ## Full Example diff --git a/docs/doc.html b/docs/doc.html deleted file mode 100644 index a63fdd3..0000000 --- a/docs/doc.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - Mingling Helpdoc - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - diff --git a/docs/example-pages/examples.json b/docs/example-pages/examples.json deleted file mode 100644 index dd5b65b..0000000 --- a/docs/example-pages/examples.json +++ /dev/null @@ -1,393 +0,0 @@ -[ - { - "id": "example-basic", - "name": "Basic", - "icon": "πŸš€", - "category": "core", - "desc": "Demonstrates the basic usage of Mingling with a simple `greet` subcommand that takes a name and prints a greeting.\n", - "tags": [ - "dispatcher!", - "#[chain]", - "#[renderer]" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-argument-picker", - "name": "Argument Picker", - "icon": "πŸ“‹", - "category": "parsing", - "desc": "Demonstrates how to use Mingling's `picker` feature and `Picker` to extract typed arguments from the command line.\n", - "tags": [ - "arg-picker", - "SinglePickable" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-async-support", - "name": "Async Support", - "icon": "⚑", - "category": "runtime", - "desc": "Shows how to drive an async runtime with Mingling using the `async` feature, enabling `async fn` in `#[chain]` with tokio.\n", - "tags": [ - "async", - "await", - "#[chain]" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-clap-binding", - "name": "Clap Binding", - "icon": "πŸ”—", - "category": "parsing", - "desc": "Demonstrates how to bind a `clap::Parser` derive struct to Mingling using `#[dispatcher_clap]` for advanced argument parsing.\n", - "tags": [ - "clap" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-combine-pathf-dispatch-tree", - "name": "Pathfinder + Dispatch Tree", - "icon": "🧭", - "category": "advanced", - "desc": "Demonstrates combining the `pathf` and `dispatch_tree` features. Types are defined in submodules and automatically resolved. Requires `dispatch_tree` in both `[dependencies]` and `[build-dependencies]`.\n", - "tags": [ - "pathf", - "dispatch_tree", - "extras" - ], - "files": [ - "src/main.rs", - "src/sub/mod.rs", - "Cargo.toml" - ] - }, - { - "id": "example-combine-pathf-metadata", - "name": "Pathfinder + Metadata", - "icon": "🧭", - "category": "advanced", - "desc": "Combines the `pathf` feature with entry metadata. The metadata `DataType` and the entry `BindType` are defined inside a submodule, and `pathf` resolves them for `gen_program!()` at build time.\n", - "tags": [ - "pathf", - "metadata" - ], - "files": [ - "src/main.rs", - "src/sub/mod.rs", - "Cargo.toml" - ] - }, - { - "id": "example-command-macro", - "name": "Command Macro", - "icon": "πŸš€", - "category": "advanced", - "desc": "Introduced how to use the `#[command]` macro to generate commands with minimal boilerplate\n", - "tags": [ - "#[command]", - "dispatcher!", - "#[chain]" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-completion", - "name": "Completion", - "icon": "πŸ”„", - "category": "ux", - "desc": "Demonstrates how to implement dynamic shell completion with `#[completion]` and generate scripts for bash, zsh, fish, and pwsh.\n", - "tags": [ - "comp" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-dispatch-tree", - "name": "Dispatch Tree", - "icon": "🌳", - "category": "dispatch", - "desc": "Introduces the `dispatch_tree` feature that converts the subcommand list into a compile-time prefix trie for O(n) command lookup.\n", - "tags": [ - "dispatch_tree" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-enum-tag", - "name": "Enum Tag", - "icon": "🏷️", - "category": "parsing", - "desc": "Shows how to derive `EnumTag` on enums for parsing variants from CLI strings with renames and descriptions.\n", - "tags": [ - "enum_tag", - "Pickable" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-error-handling", - "name": "Error Handling", - "icon": "⚠️", - "category": "runtime", - "desc": "Demonstrates how to define custom error types with `pack!` and route them to dedicated `#[renderer]` functions for user-friendly output.\n", - "tags": [ - "Result" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-exitcode", - "name": "Exitcode", - "icon": "πŸšͺ", - "category": "runtime", - "desc": "Shows how to set custom exit codes using `ExitCodeSetup` and the `finish` hook to signal success or failure to the shell.\n", - "tags": [ - "ExitCode" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-help", - "name": "Help", - "icon": "πŸ’‘", - "category": "ux", - "desc": "Shows how to use the `#[help]` attribute to provide custom per-command help text that activates when the user passes `--help`.\n", - "tags": [ - "#[help]" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-hook", - "name": "Hook", - "icon": "πŸͺ", - "category": "runtime", - "desc": "Demonstrates how to use Mingling's `ProgramHook` system to observe and debug every stage of the execution pipeline.\n", - "tags": [ - "ProgramHook" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-implicit-dispatcher", - "name": "Implicit Dispatcher", - "icon": "πŸ«₯", - "category": "dispatch", - "desc": "Shows the abbreviated `dispatcher!(\"cmd.path\")` syntax from `extras` that auto-derives struct names from the command path.\n", - "tags": [ - "implicit" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-lazy-resources", - "name": "Lazy Resources", - "icon": "πŸ’€οΈ", - "category": "advanced", - "desc": "Demonstrates how to use `LazyRes` for lazily initialized resources that only allocate when first accessed.\n", - "tags": [ - "LazyRes" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-metadata", - "name": "Entry Metadata", - "icon": "🏷️", - "category": "advanced", - "desc": "Demonstrates attaching arbitrary, compile-time-typed metadata to an entry via `#[metadata(Entry)]` and retrieving it at runtime with `ProgramCollect::get_metadata`. No `pathf` needed here β€” everything lives in a single module.\n", - "tags": [ - "metadata", - "get_metadata", - "extras" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-outside-type", - "name": "Outside Type", - "icon": "πŸ†•", - "category": "advanced", - "desc": "Demonstrates how to use the `group!()` macro to convert an external type into a type recognizable by Mingling\n", - "tags": [ - "group!", - "extras" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-panic-unwind", - "name": "Panic Unwind", - "icon": "πŸ’₯", - "category": "runtime", - "desc": "Shows how to catch panics during program execution and display friendly error messages instead of a raw panic trace.\n", - "tags": [ - "panic_unwind" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-pathfinder", - "name": "Module Pathfinder", - "icon": "🧭", - "category": "advanced", - "desc": "Demonstrates the `pathf` feature, which automatically resolves type module paths at build time. Types can be defined in submodules without explicit `use` in the main module.\n", - "tags": [ - "pathf", - "architecture" - ], - "files": [ - "Cargo.toml", - "src/main.rs", - "src/sub/mod.rs" - ] - }, - { - "id": "example-repl-basic", - "name": "REPL Basic", - "icon": "πŸ”", - "category": "repl", - "desc": "Demonstrates how to build an interactive REPL shell with Mingling using `exec_repl()`, custom prompts, and built-in setups.\n", - "tags": [ - "repl" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-resources", - "name": "Resources", - "icon": "πŸ“¦", - "category": "advanced", - "desc": "Shows how to share global state across commands using `with_resource()` and inject `&T` or `&mut T` into chain and renderer functions.\n", - "tags": [ - "Resources", - "injection" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-setup", - "name": "Setup", - "icon": "πŸ—οΈ", - "category": "core", - "desc": "Demonstrates how to build a custom `ProgramSetup` with `#[program_setup]` for modular configuration of program behaviour.\n", - "tags": [ - "#[setup]", - "extras" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-structural-renderer", - "name": "structural renderer", - "icon": "πŸ“€", - "category": "output", - "desc": "Demonstrates how to render structured output in JSON or YAML using `StructuralRendererSetup` and the `structural_renderer` feature.\n", - "tags": [ - "structural_renderer", - "--json", - "--yaml" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "example-unit-test", - "name": "Unit Test", - "icon": "πŸ§ͺ", - "category": "testing", - "desc": "Shows how to write unit tests for Chain and Renderer functions using the `entry!` macro and assertion helpers.\n", - "tags": [ - "testing", - "extras" - ], - "files": [ - "src/main.rs", - "Cargo.toml" - ] - }, - { - "id": "full-todolist", - "name": "Todo List", - "icon": "πŸ“", - "category": "full", - "desc": "This is a complete example project that demonstrates how to develop a todo list application using Mingling\n", - "tags": [ - "todolist", - "CRUD", - "clichΓ© example" - ], - "files": [ - "src/main.rs", - "src/todolist.rs", - "src/help.rs", - "Cargo.toml" - ] - } -] \ No newline at end of file diff --git a/docs/example-viewer.html b/docs/example-viewer.html index 0417c30..77232ec 100644 --- a/docs/example-viewer.html +++ b/docs/example-viewer.html @@ -450,7 +450,7 @@ MΓ¬ng LΓ¬ng
- Docs + Docs Examples
- Docs + Docs Examples ` for lazily initialized resources that only allocate when first accessed.\n", + "tags": [ + "LazyRes" + ], + "files": [ + "src/main.rs", + "Cargo.toml" + ] + }, + { + "id": "example-metadata", + "name": "Entry Metadata", + "icon": "🏷️", + "category": "advanced", + "desc": "Demonstrates attaching arbitrary, compile-time-typed metadata to an entry via `#[metadata(Entry)]` and retrieving it at runtime with `ProgramCollect::get_metadata`. No `pathf` needed here β€” everything lives in a single module.\n", + "tags": [ + "metadata", + "get_metadata", + "extras" + ], + "files": [ + "src/main.rs", + "Cargo.toml" + ] + }, + { + "id": "example-outside-type", + "name": "Outside Type", + "icon": "πŸ†•", + "category": "advanced", + "desc": "Demonstrates how to use the `group!()` macro to convert an external type into a type recognizable by Mingling\n", + "tags": [ + "group!", + "extras" + ], + "files": [ + "src/main.rs", + "Cargo.toml" + ] + }, + { + "id": "example-panic-unwind", + "name": "Panic Unwind", + "icon": "πŸ’₯", + "category": "runtime", + "desc": "Shows how to catch panics during program execution and display friendly error messages instead of a raw panic trace.\n", + "tags": [ + "panic_unwind" + ], + "files": [ + "src/main.rs", + "Cargo.toml" + ] + }, + { + "id": "example-pathfinder", + "name": "Module Pathfinder", + "icon": "🧭", + "category": "advanced", + "desc": "Demonstrates the `pathf` feature, which automatically resolves type module paths at build time. Types can be defined in submodules without explicit `use` in the main module.\n", + "tags": [ + "pathf", + "architecture" + ], + "files": [ + "Cargo.toml", + "src/main.rs", + "src/sub/mod.rs" + ] + }, + { + "id": "example-repl-basic", + "name": "REPL Basic", + "icon": "πŸ”", + "category": "repl", + "desc": "Demonstrates how to build an interactive REPL shell with Mingling using `exec_repl()`, custom prompts, and built-in setups.\n", + "tags": [ + "repl" + ], + "files": [ + "src/main.rs", + "Cargo.toml" + ] + }, + { + "id": "example-resources", + "name": "Resources", + "icon": "πŸ“¦", + "category": "advanced", + "desc": "Shows how to share global state across commands using `with_resource()` and inject `&T` or `&mut T` into chain and renderer functions.\n", + "tags": [ + "Resources", + "injection" + ], + "files": [ + "src/main.rs", + "Cargo.toml" + ] + }, + { + "id": "example-setup", + "name": "Setup", + "icon": "πŸ—οΈ", + "category": "core", + "desc": "Demonstrates how to build a custom `ProgramSetup` with `#[program_setup]` for modular configuration of program behaviour.\n", + "tags": [ + "#[setup]", + "extras" + ], + "files": [ + "src/main.rs", + "Cargo.toml" + ] + }, + { + "id": "example-structural-renderer", + "name": "structural renderer", + "icon": "πŸ“€", + "category": "output", + "desc": "Demonstrates how to render structured output in JSON or YAML using `StructuralRendererSetup` and the `structural_renderer` feature.\n", + "tags": [ + "structural_renderer", + "--json", + "--yaml" + ], + "files": [ + "src/main.rs", + "Cargo.toml" + ] + }, + { + "id": "example-unit-test", + "name": "Unit Test", + "icon": "πŸ§ͺ", + "category": "testing", + "desc": "Shows how to write unit tests for Chain and Renderer functions using the `entry!` macro and assertion helpers.\n", + "tags": [ + "testing", + "extras" + ], + "files": [ + "src/main.rs", + "Cargo.toml" + ] + }, + { + "id": "full-todolist", + "name": "Todo List", + "icon": "πŸ“", + "category": "full", + "desc": "This is a complete example project that demonstrates how to develop a todo list application using Mingling\n", + "tags": [ + "todolist", + "CRUD", + "clichΓ© example" + ], + "files": [ + "src/main.rs", + "src/todolist.rs", + "src/help.rs", + "Cargo.toml" + ] + } +] \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..a63fdd3 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,111 @@ + + + + + + + Mingling Helpdoc + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + diff --git a/docs/licenses/docsify.md b/docs/licenses/docsify.md new file mode 100644 index 0000000..bec4d76 --- /dev/null +++ b/docs/licenses/docsify.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 docsifyjs + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. -- cgit