nuts_tool_api/plugin.rs
1// MIT License
2//
3// Copyright (c) 2024 Robin Doer
4//
5// Permission is hereby granted, free of charge, to any person obtaining a copy
6// of this software and associated documentation files (the "Software"), to
7// deal in the Software without restriction, including without limitation the
8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22
23//! Code especially for the plugin
24
25pub mod cli;
26mod handler;
27mod runner;
28
29pub use handler::{InfoHandler, OpenCreateHandler, PluginHandler};
30pub use runner::PluginRunner;
31
32pub mod clap_prelude {
33 //! Preludes used to define extra arguments.
34 //!
35 //! If you define
36 //! [extra arguments](crate::plugin::PluginHandler::CreateArgs) for the
37 //! `create` command, you must include these preludes:
38 //!
39 //! ```
40 //! use nuts_tool_api::plugin::clap_prelude::*;
41 //! ```
42
43 pub use ::clap;
44 pub use ::clap::Args;
45}