diff --git a/Cargo.lock b/Cargo.lock index b50adcc..2ade439 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -216,20 +216,20 @@ dependencies = [ ] [[package]] -name = "interactive_clap" +name = "interactive-clap" version = "0.1.0" dependencies = [ "clap", "color-eyre", "inquire", - "interactive_clap_derive", + "interactive-clap-derive", "shell-words", "strum", "strum_macros", ] [[package]] -name = "interactive_clap_derive" +name = "interactive-clap-derive" version = "0.1.0" dependencies = [ "proc-macro-error", diff --git a/Cargo.toml b/Cargo.toml index 5a85641..f8582e0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,17 +1,21 @@ [workspace] members = [ - "interactive_clap_derive", + "interactive-clap-derive", ] [package] -name = "interactive_clap" +name = "interactive-clap" version = "0.1.0" +authors = ["FroVolod "] edition = "2018" +license = "MIT OR Apache-2.0" +repository = "https://github.com/FroVolod/interactive-clap" +description = "Interactive mode extension crate to Command Line Arguments Parser (https://crates.io/crates/clap)" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] -interactive_clap_derive = { path = "interactive_clap_derive" } +interactive-clap-derive = { path = "interactive-clap-derive", version = "0.1.0" } strum = { version = "0.24", features = ["derive"] } strum_macros = "0.24" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..128a50b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2022 Volodymyr Frolov + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..9ec7c02 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2021-2022 Volodymyr Frolov and Interactive-Clap Contributors + +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/examples/to_cli_args.rs b/examples/to_cli_args.rs index baab2d3..c1e06b3 100644 --- a/examples/to_cli_args.rs +++ b/examples/to_cli_args.rs @@ -10,7 +10,7 @@ use inquire::Select; use strum::{EnumDiscriminants, EnumIter, EnumMessage, IntoEnumIterator}; -use interactive_clap::{ToCliArgs, SelectVariantOrBack}; +use interactive_clap::{SelectVariantOrBack, ToCliArgs}; mod common; diff --git a/interactive_clap_derive/.gitignore b/interactive-clap-derive/.gitignore similarity index 100% rename from interactive_clap_derive/.gitignore rename to interactive-clap-derive/.gitignore diff --git a/interactive-clap-derive/Cargo.toml b/interactive-clap-derive/Cargo.toml new file mode 100644 index 0000000..bd093e6 --- /dev/null +++ b/interactive-clap-derive/Cargo.toml @@ -0,0 +1,19 @@ +[package] +name = "interactive-clap-derive" +version = "0.1.0" +authors = ["FroVolod "] +edition = "2018" +license = "MIT OR Apache-2.0" +repository = "https://github.com/FroVolod/interactive-clap/tree/master/interactive-clap-derive" +description = "Interactive mode extension crate to Command Line Arguments Parser (https://crates.io/crates/clap) (derive macros helper crate)" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[lib] +proc-macro = true + +[dependencies] +proc-macro2 = "1.0.24" +proc-macro-error = "1" +quote = "1.0" +syn = "1.0" diff --git a/interactive-clap-derive/LICENSE-APACHE b/interactive-clap-derive/LICENSE-APACHE new file mode 120000 index 0000000..965b606 --- /dev/null +++ b/interactive-clap-derive/LICENSE-APACHE @@ -0,0 +1 @@ +../LICENSE-APACHE \ No newline at end of file diff --git a/interactive-clap-derive/LICENSE-MIT b/interactive-clap-derive/LICENSE-MIT new file mode 120000 index 0000000..76219eb --- /dev/null +++ b/interactive-clap-derive/LICENSE-MIT @@ -0,0 +1 @@ +../LICENSE-MIT \ No newline at end of file diff --git a/interactive_clap_derive/src/derives/interactive_clap/methods/choose_variant.rs b/interactive-clap-derive/src/derives/interactive_clap/methods/choose_variant.rs similarity index 100% rename from interactive_clap_derive/src/derives/interactive_clap/methods/choose_variant.rs rename to interactive-clap-derive/src/derives/interactive_clap/methods/choose_variant.rs diff --git a/interactive_clap_derive/src/derives/interactive_clap/methods/cli_field_type.rs b/interactive-clap-derive/src/derives/interactive_clap/methods/cli_field_type.rs similarity index 100% rename from interactive_clap_derive/src/derives/interactive_clap/methods/cli_field_type.rs rename to interactive-clap-derive/src/derives/interactive_clap/methods/cli_field_type.rs diff --git a/interactive_clap_derive/src/derives/interactive_clap/methods/fields_without_skip_default_from_cli_arg.rs b/interactive-clap-derive/src/derives/interactive_clap/methods/fields_without_skip_default_from_cli_arg.rs similarity index 100% rename from interactive_clap_derive/src/derives/interactive_clap/methods/fields_without_skip_default_from_cli_arg.rs rename to interactive-clap-derive/src/derives/interactive_clap/methods/fields_without_skip_default_from_cli_arg.rs diff --git a/interactive_clap_derive/src/derives/interactive_clap/methods/fields_without_skip_default_input_arg.rs b/interactive-clap-derive/src/derives/interactive_clap/methods/fields_without_skip_default_input_arg.rs similarity index 100% rename from interactive_clap_derive/src/derives/interactive_clap/methods/fields_without_skip_default_input_arg.rs rename to interactive-clap-derive/src/derives/interactive_clap/methods/fields_without_skip_default_input_arg.rs diff --git a/interactive_clap_derive/src/derives/interactive_clap/methods/fields_without_subcommand.rs b/interactive-clap-derive/src/derives/interactive_clap/methods/fields_without_subcommand.rs similarity index 100% rename from interactive_clap_derive/src/derives/interactive_clap/methods/fields_without_subcommand.rs rename to interactive-clap-derive/src/derives/interactive_clap/methods/fields_without_subcommand.rs diff --git a/interactive_clap_derive/src/derives/interactive_clap/methods/from_cli_for_enum.rs b/interactive-clap-derive/src/derives/interactive_clap/methods/from_cli_for_enum.rs similarity index 100% rename from interactive_clap_derive/src/derives/interactive_clap/methods/from_cli_for_enum.rs rename to interactive-clap-derive/src/derives/interactive_clap/methods/from_cli_for_enum.rs diff --git a/interactive_clap_derive/src/derives/interactive_clap/methods/from_cli_for_struct.rs b/interactive-clap-derive/src/derives/interactive_clap/methods/from_cli_for_struct.rs similarity index 100% rename from interactive_clap_derive/src/derives/interactive_clap/methods/from_cli_for_struct.rs rename to interactive-clap-derive/src/derives/interactive_clap/methods/from_cli_for_struct.rs diff --git a/interactive_clap_derive/src/derives/interactive_clap/methods/get_arg_from_cli_for_struct.rs b/interactive-clap-derive/src/derives/interactive_clap/methods/get_arg_from_cli_for_struct.rs similarity index 100% rename from interactive_clap_derive/src/derives/interactive_clap/methods/get_arg_from_cli_for_struct.rs rename to interactive-clap-derive/src/derives/interactive_clap/methods/get_arg_from_cli_for_struct.rs diff --git a/interactive_clap_derive/src/derives/interactive_clap/methods/input_arg.rs b/interactive-clap-derive/src/derives/interactive_clap/methods/input_arg.rs similarity index 100% rename from interactive_clap_derive/src/derives/interactive_clap/methods/input_arg.rs rename to interactive-clap-derive/src/derives/interactive_clap/methods/input_arg.rs diff --git a/interactive_clap_derive/src/derives/interactive_clap/methods/interactive_clap_attrs_context.rs b/interactive-clap-derive/src/derives/interactive_clap/methods/interactive_clap_attrs_context.rs similarity index 100% rename from interactive_clap_derive/src/derives/interactive_clap/methods/interactive_clap_attrs_context.rs rename to interactive-clap-derive/src/derives/interactive_clap/methods/interactive_clap_attrs_context.rs diff --git a/interactive_clap_derive/src/derives/interactive_clap/methods/mod.rs b/interactive-clap-derive/src/derives/interactive_clap/methods/mod.rs similarity index 100% rename from interactive_clap_derive/src/derives/interactive_clap/methods/mod.rs rename to interactive-clap-derive/src/derives/interactive_clap/methods/mod.rs diff --git a/interactive_clap_derive/src/derives/interactive_clap/mod.rs b/interactive-clap-derive/src/derives/interactive_clap/mod.rs similarity index 100% rename from interactive_clap_derive/src/derives/interactive_clap/mod.rs rename to interactive-clap-derive/src/derives/interactive_clap/mod.rs diff --git a/interactive_clap_derive/src/derives/mod.rs b/interactive-clap-derive/src/derives/mod.rs similarity index 100% rename from interactive_clap_derive/src/derives/mod.rs rename to interactive-clap-derive/src/derives/mod.rs diff --git a/interactive_clap_derive/src/derives/to_cli_args/methods/interactive_clap_attrs_cli_field.rs b/interactive-clap-derive/src/derives/to_cli_args/methods/interactive_clap_attrs_cli_field.rs similarity index 100% rename from interactive_clap_derive/src/derives/to_cli_args/methods/interactive_clap_attrs_cli_field.rs rename to interactive-clap-derive/src/derives/to_cli_args/methods/interactive_clap_attrs_cli_field.rs diff --git a/interactive_clap_derive/src/derives/to_cli_args/methods/mod.rs b/interactive-clap-derive/src/derives/to_cli_args/methods/mod.rs similarity index 100% rename from interactive_clap_derive/src/derives/to_cli_args/methods/mod.rs rename to interactive-clap-derive/src/derives/to_cli_args/methods/mod.rs diff --git a/interactive_clap_derive/src/derives/to_cli_args/mod.rs b/interactive-clap-derive/src/derives/to_cli_args/mod.rs similarity index 100% rename from interactive_clap_derive/src/derives/to_cli_args/mod.rs rename to interactive-clap-derive/src/derives/to_cli_args/mod.rs diff --git a/interactive_clap_derive/src/helpers/mod.rs b/interactive-clap-derive/src/helpers/mod.rs similarity index 100% rename from interactive_clap_derive/src/helpers/mod.rs rename to interactive-clap-derive/src/helpers/mod.rs diff --git a/interactive_clap_derive/src/helpers/snake_case_to_camel_case.rs b/interactive-clap-derive/src/helpers/snake_case_to_camel_case.rs similarity index 100% rename from interactive_clap_derive/src/helpers/snake_case_to_camel_case.rs rename to interactive-clap-derive/src/helpers/snake_case_to_camel_case.rs diff --git a/interactive_clap_derive/src/helpers/to_kebab_case.rs b/interactive-clap-derive/src/helpers/to_kebab_case.rs similarity index 100% rename from interactive_clap_derive/src/helpers/to_kebab_case.rs rename to interactive-clap-derive/src/helpers/to_kebab_case.rs diff --git a/interactive_clap_derive/src/lib.rs b/interactive-clap-derive/src/lib.rs similarity index 100% rename from interactive_clap_derive/src/lib.rs rename to interactive-clap-derive/src/lib.rs diff --git a/interactive_clap_derive/Cargo.toml b/interactive_clap_derive/Cargo.toml deleted file mode 100644 index 1ee0128..0000000 --- a/interactive_clap_derive/Cargo.toml +++ /dev/null @@ -1,15 +0,0 @@ -[package] -name = "interactive_clap_derive" -version = "0.1.0" -edition = "2018" - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html - -[lib] -proc-macro = true - -[dependencies] -proc-macro2 = "1.0.24" -proc-macro-error = "1" -quote = "1.0" -syn = "1.0" diff --git a/interactive_clap_derive/Cargo_1.lock b/interactive_clap_derive/Cargo_1.lock deleted file mode 100644 index 058fab8..0000000 --- a/interactive_clap_derive/Cargo_1.lock +++ /dev/null @@ -1,78 +0,0 @@ -# This file is automatically @generated by Cargo. -# It is not intended for manual editing. -version = 3 - -[[package]] -name = "interactive_clap_derive" -version = "0.1.0" -dependencies = [ - "proc-macro-error", - "proc-macro2", - "quote", - "syn", -] - -[[package]] -name = "proc-macro-error" -version = "1.0.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "da25490ff9892aab3fcf7c36f08cfb902dd3e71ca0f9f9517bea02a73a5ce38c" -dependencies = [ - "proc-macro-error-attr", - "proc-macro2", - "quote", - "syn", - "version_check", -] - -[[package]] -name = "proc-macro-error-attr" -version = "1.0.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a1be40180e52ecc98ad80b184934baf3d0d29f979574e439af5a55274b35f869" -dependencies = [ - "proc-macro2", - "quote", - "version_check", -] - -[[package]] -name = "proc-macro2" -version = "1.0.29" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b9f5105d4fdaab20335ca9565e106a5d9b82b6219b5ba735731124ac6711d23d" -dependencies = [ - "unicode-xid", -] - -[[package]] -name = "quote" -version = "1.0.9" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c3d0b9745dc2debf507c8422de05d7226cc1f0644216dfdfead988f9b1ab32a7" -dependencies = [ - "proc-macro2", -] - -[[package]] -name = "syn" -version = "1.0.76" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c6f107db402c2c2055242dbf4d2af0e69197202e9faacbef9571bbe47f5a1b84" -dependencies = [ - "proc-macro2", - "quote", - "unicode-xid", -] - -[[package]] -name = "unicode-xid" -version = "0.2.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8ccb82d61f80a663efe1f787a51b16b5a51e3314d6ac365b08639f52387b33f3" - -[[package]] -name = "version_check" -version = "0.9.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5fecdca9a5291cc2b8dcf7dc02453fee791a280f3743cb0905f8822ae463b3fe"