7 | First place to go is the repository issues section, and I'll try to help as much as possible. 8 | 9 | ## Pull Requests 10 | 11 | Fixed a bug or just want to provided additional functionality?
12 | Simply fork this repository, implement your changes and create a pull request.
13 | Few guidelines regarding pull requests: 14 | 15 | * This repository is integrated with github actions for continuous integration.
16 | 17 | Your pull request build must pass (the build will run automatically).
18 | You can run the following command locally to ensure the build will pass: 19 | 20 | ````sh 21 | cargo make ci-flow 22 | ```` 23 | 24 | * There are many automatic unit tests as part of the library which provide full coverage of the functionality.
Any fix/enhancement must come with a set of tests to ensure it's working well. 25 | -------------------------------------------------------------------------------- /docs/api/cliparser/sidebar-items.js: -------------------------------------------------------------------------------- 1 | initSidebarItems({"fn":[["help","Generates and returns the spec help text"],["parse","Parsers the given command line based on the given spec and returns the result. In case of error (such as invalid input), an error will be returned. In case the command line does not match the spec, Ok(None) will be returned."],["parse_any","Parsers the given command line based on the given specs and returns the result. In case of invalid input or none of the provided specs do not match the command line, an error will be returned."],["parse_process","Parsers the given command line based on the given spec and returns the result. In case of error (such as invalid input), an error will be returned. In case the command line does not match the spec, Ok(None) will be returned."],["parse_process_any","Parsers the current process command line based on the given specs and returns the result. In case of invalid input or none of the provided specs do not match the command line, an error will be returned."],["version","Generates and returns the spec version text"]],"mod":[["types","types"]]}); -------------------------------------------------------------------------------- /docs/api/LICENSE-MIT.txt: -------------------------------------------------------------------------------- 1 | Permission is hereby granted, free of charge, to any 2 | person obtaining a copy of this software and associated 3 | documentation files (the "Software"), to deal in the 4 | Software without restriction, including without 5 | limitation the rights to use, copy, modify, merge, 6 | publish, distribute, sublicense, and/or sell copies of 7 | the Software, and to permit persons to whom the Software 8 | is furnished to do so, subject to the following 9 | conditions: 10 | 11 | The above copyright notice and this permission notice 12 | shall be included in all copies or substantial portions 13 | of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 16 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 17 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 18 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 19 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 20 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 22 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 23 | DEALINGS IN THE SOFTWARE. 24 | -------------------------------------------------------------------------------- /docs/api/implementors/core/default/trait.Default.js: -------------------------------------------------------------------------------- 1 | (function() {var implementors = {}; 2 | implementors["cliparser"] = [{"text":"impl Default for CliSpecMetaInfo","synthetic":false,"types":["cliparser::types::CliSpecMetaInfo"]},{"text":"impl Default for CliSpec","synthetic":false,"types":["cliparser::types::CliSpec"]},{"text":"impl Default for CliParsed","synthetic":false,"types":["cliparser::types::CliParsed"]}]; 3 | if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() -------------------------------------------------------------------------------- /docs/api/settings.css: -------------------------------------------------------------------------------- 1 | .setting-line{margin:0.6em 0 0.6em 0.3em;position:relative;}.setting-line .choices{display:flex;flex-wrap:wrap;}.setting-line .radio-line input{margin-right:0.3em;height:1.2rem;width:1.2rem;border:1px solid;outline:none;-webkit-appearance:none;cursor:pointer;border-radius:50%;}.setting-line .radio-line input+span{padding-bottom:1px;}.radio-line .setting-name{width:100%;}.radio-line .choice{margin-top:0.1em;margin-bottom:0.1em;min-width:3.8em;padding:0.3em;display:flex;align-items:center;cursor:pointer;}.radio-line .choice+.choice{margin-left:0.5em;}.toggle{position:relative;display:inline-block;width:100%;height:27px;margin-right:20px;display:flex;align-items:center;cursor:pointer;}.toggle input{opacity:0;position:absolute;}.slider{position:relative;width:45px;display:block;height:28px;margin-right:20px;cursor:pointer;background-color:#ccc;transition:.3s;}.slider:before{position:absolute;content:"";height:19px;width:19px;left:4px;bottom:4px;transition:.3s;}input:checked+.slider:before{transform:translateX(19px);}.setting-line>.sub-settings{padding-left:42px;width:100%;display:block;}div#settings{position:absolute;right:0;z-index:1;display:block;margin-top:7px;border-radius:3px;border:1px solid;}#settings .setting-line{margin:1.2em 0.6em;}div#settings::before{content:'';position:absolute;right:11px;border:solid;border-width:1px 1px 0 0;display:inline-block;padding:4px;transform:rotate(-45deg);top:-5px;} -------------------------------------------------------------------------------- /tests/parse_any_test.rs: -------------------------------------------------------------------------------- 1 | use cliparser::parse_any; 2 | use cliparser::types::{Argument, ArgumentOccurrence, ArgumentValueType, CliSpec, Command}; 3 | use std::collections::HashSet; 4 | 5 | #[test] 6 | fn parse_any_test() { 7 | let mut cli_spec1 = CliSpec::new(); 8 | cli_spec1 9 | .command 10 | .push(Command::Command("test1".to_string())); 11 | cli_spec1.arguments.push(Argument { 12 | name: "testarg1".to_string(), 13 | key: vec!["--test".to_string()], 14 | argument_occurrence: ArgumentOccurrence::Single, 15 | value_type: ArgumentValueType::None, 16 | default_value: Some("test_default".to_string()), 17 | help: None, 18 | }); 19 | 20 | let mut cli_spec2 = CliSpec::new(); 21 | cli_spec2.command.push(Command::Command("test".to_string())); 22 | cli_spec2.arguments.push(Argument { 23 | name: "testarg2".to_string(), 24 | key: vec!["--test".to_string()], 25 | argument_occurrence: ArgumentOccurrence::Single, 26 | value_type: ArgumentValueType::None, 27 | default_value: None, 28 | help: None, 29 | }); 30 | 31 | let empty_cli_spec = CliSpec::new(); 32 | 33 | let result = parse_any( 34 | &vec!["test", "--test"], 35 | vec![&cli_spec1, &empty_cli_spec, &cli_spec2], 36 | ); 37 | 38 | assert!(result.is_ok()); 39 | let (index, cli_parsed) = result.unwrap(); 40 | assert_eq!(index, 2); 41 | 42 | let mut argument_names = HashSet::new(); 43 | argument_names.insert("testarg2".to_string()); 44 | assert_eq!(cli_parsed.arguments, argument_names); 45 | assert!(cli_parsed.argument_values.is_empty()); 46 | } 47 | -------------------------------------------------------------------------------- /docs/api/normalize.css: -------------------------------------------------------------------------------- 1 | /*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */ 2 | html{line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0}main{display:block}h1{font-size:2em;margin:0.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-0.25em}sup{top:-0.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}[type="button"],[type="reset"],[type="submit"],button{-webkit-appearance:button}[type="button"]::-moz-focus-inner,[type="reset"]::-moz-focus-inner,[type="submit"]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type="button"]:-moz-focusring,[type="reset"]:-moz-focusring,[type="submit"]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:0.35em 0.75em 0.625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type="checkbox"],[type="radio"]{box-sizing:border-box;padding:0}[type="number"]::-webkit-inner-spin-button,[type="number"]::-webkit-outer-spin-button{height:auto}[type="search"]{-webkit-appearance:textfield;outline-offset:-2px}[type="search"]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}template{display:none}[hidden]{display:none} -------------------------------------------------------------------------------- /docs/api/COPYRIGHT.txt: -------------------------------------------------------------------------------- 1 | These documentation pages include resources by third parties. This copyright 2 | file applies only to those resources. The following third party resources are 3 | included, and carry their own copyright notices and license terms: 4 | 5 | * Fira Sans (FiraSans-Regular.woff2, FiraSans-Medium.woff2): 6 | 7 | Copyright (c) 2014, Mozilla Foundation https://mozilla.org/ 8 | with Reserved Font Name Fira Sans. 9 | 10 | Copyright (c) 2014, Telefonica S.A. 11 | 12 | Licensed under the SIL Open Font License, Version 1.1. 13 | See FiraSans-LICENSE.txt. 14 | 15 | * rustdoc.css, main.js, and playpen.js: 16 | 17 | Copyright 2015 The Rust Developers. 18 | Licensed under the Apache License, Version 2.0 (see LICENSE-APACHE.txt) or 19 | the MIT license (LICENSE-MIT.txt) at your option. 20 | 21 | * normalize.css: 22 | 23 | Copyright (c) Nicolas Gallagher and Jonathan Neal. 24 | Licensed under the MIT license (see LICENSE-MIT.txt). 25 | 26 | * Source Code Pro (SourceCodePro-Regular.ttf.woff2, 27 | SourceCodePro-Semibold.ttf.woff2, SourceCodePro-It.ttf.woff2): 28 | 29 | Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), 30 | with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark 31 | of Adobe Systems Incorporated in the United States and/or other countries. 32 | 33 | Licensed under the SIL Open Font License, Version 1.1. 34 | See SourceCodePro-LICENSE.txt. 35 | 36 | * Source Serif 4 (SourceSerif4-Regular.ttf.woff2, SourceSerif4-Bold.ttf.woff2, 37 | SourceSerif4-It.ttf.woff2): 38 | 39 | Copyright 2014-2021 Adobe (http://www.adobe.com/), with Reserved Font Name 40 | 'Source'. All Rights Reserved. Source is a trademark of Adobe in the United 41 | States and/or other countries. 42 | 43 | Licensed under the SIL Open Font License, Version 1.1. 44 | See SourceSerif4-LICENSE.md. 45 | 46 | This copyright file is intended to be distributed with rustdoc output. 47 | -------------------------------------------------------------------------------- /docs/api/implementors/core/marker/trait.Freeze.js: -------------------------------------------------------------------------------- 1 | (function() {var implementors = {}; 2 | implementors["cliparser"] = [{"text":"impl Freeze for ParserError","synthetic":true,"types":["cliparser::types::ParserError"]},{"text":"impl Freeze for Command","synthetic":true,"types":["cliparser::types::Command"]},{"text":"impl Freeze for ArgumentOccurrence","synthetic":true,"types":["cliparser::types::ArgumentOccurrence"]},{"text":"impl Freeze for ArgumentValueType","synthetic":true,"types":["cliparser::types::ArgumentValueType"]},{"text":"impl Freeze for ArgumentHelp","synthetic":true,"types":["cliparser::types::ArgumentHelp"]},{"text":"impl Freeze for Argument","synthetic":true,"types":["cliparser::types::Argument"]},{"text":"impl Freeze for PositionalArgument","synthetic":true,"types":["cliparser::types::PositionalArgument"]},{"text":"impl Freeze for CliSpecMetaInfo","synthetic":true,"types":["cliparser::types::CliSpecMetaInfo"]},{"text":"impl Freeze for CliSpec","synthetic":true,"types":["cliparser::types::CliSpec"]},{"text":"impl Freeze for CliParsed","synthetic":true,"types":["cliparser::types::CliParsed"]}]; 3 | if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() -------------------------------------------------------------------------------- /docs/api/implementors/core/clone/trait.Clone.js: -------------------------------------------------------------------------------- 1 | (function() {var implementors = {}; 2 | implementors["cliparser"] = [{"text":"impl Clone for Command","synthetic":false,"types":["cliparser::types::Command"]},{"text":"impl Clone for ArgumentOccurrence","synthetic":false,"types":["cliparser::types::ArgumentOccurrence"]},{"text":"impl Clone for ArgumentValueType","synthetic":false,"types":["cliparser::types::ArgumentValueType"]},{"text":"impl Clone for ArgumentHelp","synthetic":false,"types":["cliparser::types::ArgumentHelp"]},{"text":"impl Clone for Argument","synthetic":false,"types":["cliparser::types::Argument"]},{"text":"impl Clone for PositionalArgument","synthetic":false,"types":["cliparser::types::PositionalArgument"]},{"text":"impl Clone for CliSpecMetaInfo","synthetic":false,"types":["cliparser::types::CliSpecMetaInfo"]},{"text":"impl Clone for CliSpec","synthetic":false,"types":["cliparser::types::CliSpec"]},{"text":"impl Clone for CliParsed","synthetic":false,"types":["cliparser::types::CliParsed"]}]; 3 | if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() -------------------------------------------------------------------------------- /docs/api/storage.js: -------------------------------------------------------------------------------- 1 | "use strict";const darkThemes=["dark","ayu"];window.currentTheme=document.getElementById("themeStyle");window.mainTheme=document.getElementById("mainThemeStyle");const settingsDataset=(function(){const settingsElement=document.getElementById("default-settings");if(settingsElement===null){return null}const dataset=settingsElement.dataset;if(dataset===undefined){return null}return dataset})();function getSettingValue(settingName){const current=getCurrentValue(settingName);if(current!==null){return current}if(settingsDataset!==null){const def=settingsDataset[settingName.replace(/-/g,"_")];if(def!==undefined){return def}}return null}const localStoredTheme=getSettingValue("theme");const savedHref=[];function hasClass(elem,className){return elem&&elem.classList&&elem.classList.contains(className)}function addClass(elem,className){if(!elem||!elem.classList){return}elem.classList.add(className)}function removeClass(elem,className){if(!elem||!elem.classList){return}elem.classList.remove(className)}function onEach(arr,func,reversed){if(arr&&arr.length>0&&func){if(reversed){const length=arr.length;for(let i=length-1;i>=0;--i){if(func(arr[i])){return true}}}else{for(const elem of arr){if(func(elem)){return true}}}}return false}function onEachLazy(lazyArray,func,reversed){return onEach(Array.prototype.slice.call(lazyArray),func,reversed)}function updateLocalStorage(name,value){try{window.localStorage.setItem("rustdoc-"+name,value)}catch(e){}}function getCurrentValue(name){try{return window.localStorage.getItem("rustdoc-"+name)}catch(e){return null}}function switchTheme(styleElem,mainStyleElem,newTheme,saveTheme){const newHref=mainStyleElem.href.replace(/\/rustdoc([^/]*)\.css/,"/"+newTheme+"$1"+".css");if(saveTheme){updateLocalStorage("theme",newTheme)}if(styleElem.href===newHref){return}let found=false;if(savedHref.length===0){onEachLazy(document.getElementsByTagName("link"),el=>{savedHref.push(el.href)})}onEach(savedHref,el=>{if(el===newHref){found=true;return true}});if(found){styleElem.href=newHref}}function useSystemTheme(value){if(value===undefined){value=true}updateLocalStorage("use-system-theme",value);const toggle=document.getElementById("use-system-theme");if(toggle&&toggle instanceof HTMLInputElement){toggle.checked=value}}const updateSystemTheme=(function(){if(!window.matchMedia){return()=>{const cssTheme=getComputedStyle(document.documentElement).getPropertyValue("content");switchTheme(window.currentTheme,window.mainTheme,JSON.parse(cssTheme)||"light",true)}}const mql=window.matchMedia("(prefers-color-scheme: dark)");function handlePreferenceChange(mql){const use=theme=>{switchTheme(window.currentTheme,window.mainTheme,theme,true)};if(getSettingValue("use-system-theme")!=="false"){const lightTheme=getSettingValue("preferred-light-theme")||"light";const darkTheme=getSettingValue("preferred-dark-theme")||"dark";if(mql.matches){use(darkTheme)}else{use(lightTheme)}}else{use(getSettingValue("theme"))}}mql.addListener(handlePreferenceChange);return()=>{handlePreferenceChange(mql)}})();function switchToSavedTheme(){switchTheme(window.currentTheme,window.mainTheme,getSettingValue("theme")||"light",false)}if(getSettingValue("use-system-theme")!=="false"&&window.matchMedia){if(getSettingValue("use-system-theme")===null&&getSettingValue("preferred-dark-theme")===null&&darkThemes.indexOf(localStoredTheme)>=0){updateLocalStorage("preferred-dark-theme",localStoredTheme)}updateSystemTheme()}else{switchToSavedTheme()}window.addEventListener("pageshow",ev=>{if(ev.persisted){setTimeout(switchToSavedTheme,0)}}) -------------------------------------------------------------------------------- /docs/api/rust-logo.svg: -------------------------------------------------------------------------------- 1 | 62 | -------------------------------------------------------------------------------- /docs/api/implementors/core/fmt/trait.Debug.js: -------------------------------------------------------------------------------- 1 | (function() {var implementors = {}; 2 | implementors["cliparser"] = [{"text":"impl Debug for ParserError","synthetic":false,"types":["cliparser::types::ParserError"]},{"text":"impl Debug for Command","synthetic":false,"types":["cliparser::types::Command"]},{"text":"impl Debug for ArgumentOccurrence","synthetic":false,"types":["cliparser::types::ArgumentOccurrence"]},{"text":"impl Debug for ArgumentValueType","synthetic":false,"types":["cliparser::types::ArgumentValueType"]},{"text":"impl Debug for ArgumentHelp","synthetic":false,"types":["cliparser::types::ArgumentHelp"]},{"text":"impl Debug for Argument","synthetic":false,"types":["cliparser::types::Argument"]},{"text":"impl Debug for PositionalArgument","synthetic":false,"types":["cliparser::types::PositionalArgument"]},{"text":"impl Debug for CliSpecMetaInfo","synthetic":false,"types":["cliparser::types::CliSpecMetaInfo"]},{"text":"impl Debug for CliSpec","synthetic":false,"types":["cliparser::types::CliSpec"]},{"text":"impl Debug for CliParsed","synthetic":false,"types":["cliparser::types::CliParsed"]}]; 3 | if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() -------------------------------------------------------------------------------- /docs/api/implementors/core/marker/trait.Send.js: -------------------------------------------------------------------------------- 1 | (function() {var implementors = {}; 2 | implementors["cliparser"] = [{"text":"impl Send for ParserError","synthetic":true,"types":["cliparser::types::ParserError"]},{"text":"impl Send for Command","synthetic":true,"types":["cliparser::types::Command"]},{"text":"impl Send for ArgumentOccurrence","synthetic":true,"types":["cliparser::types::ArgumentOccurrence"]},{"text":"impl Send for ArgumentValueType","synthetic":true,"types":["cliparser::types::ArgumentValueType"]},{"text":"impl Send for ArgumentHelp","synthetic":true,"types":["cliparser::types::ArgumentHelp"]},{"text":"impl Send for Argument","synthetic":true,"types":["cliparser::types::Argument"]},{"text":"impl Send for PositionalArgument","synthetic":true,"types":["cliparser::types::PositionalArgument"]},{"text":"impl Send for CliSpecMetaInfo","synthetic":true,"types":["cliparser::types::CliSpecMetaInfo"]},{"text":"impl Send for CliSpec","synthetic":true,"types":["cliparser::types::CliSpec"]},{"text":"impl Send for CliParsed","synthetic":true,"types":["cliparser::types::CliParsed"]}]; 3 | if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() -------------------------------------------------------------------------------- /docs/api/implementors/core/marker/trait.Sync.js: -------------------------------------------------------------------------------- 1 | (function() {var implementors = {}; 2 | implementors["cliparser"] = [{"text":"impl Sync for ParserError","synthetic":true,"types":["cliparser::types::ParserError"]},{"text":"impl Sync for Command","synthetic":true,"types":["cliparser::types::Command"]},{"text":"impl Sync for ArgumentOccurrence","synthetic":true,"types":["cliparser::types::ArgumentOccurrence"]},{"text":"impl Sync for ArgumentValueType","synthetic":true,"types":["cliparser::types::ArgumentValueType"]},{"text":"impl Sync for ArgumentHelp","synthetic":true,"types":["cliparser::types::ArgumentHelp"]},{"text":"impl Sync for Argument","synthetic":true,"types":["cliparser::types::Argument"]},{"text":"impl Sync for PositionalArgument","synthetic":true,"types":["cliparser::types::PositionalArgument"]},{"text":"impl Sync for CliSpecMetaInfo","synthetic":true,"types":["cliparser::types::CliSpecMetaInfo"]},{"text":"impl Sync for CliSpec","synthetic":true,"types":["cliparser::types::CliSpec"]},{"text":"impl Sync for CliParsed","synthetic":true,"types":["cliparser::types::CliParsed"]}]; 3 | if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() -------------------------------------------------------------------------------- /docs/api/implementors/core/marker/trait.Unpin.js: -------------------------------------------------------------------------------- 1 | (function() {var implementors = {}; 2 | implementors["cliparser"] = [{"text":"impl Unpin for ParserError","synthetic":true,"types":["cliparser::types::ParserError"]},{"text":"impl Unpin for Command","synthetic":true,"types":["cliparser::types::Command"]},{"text":"impl Unpin for ArgumentOccurrence","synthetic":true,"types":["cliparser::types::ArgumentOccurrence"]},{"text":"impl Unpin for ArgumentValueType","synthetic":true,"types":["cliparser::types::ArgumentValueType"]},{"text":"impl Unpin for ArgumentHelp","synthetic":true,"types":["cliparser::types::ArgumentHelp"]},{"text":"impl Unpin for Argument","synthetic":true,"types":["cliparser::types::Argument"]},{"text":"impl Unpin for PositionalArgument","synthetic":true,"types":["cliparser::types::PositionalArgument"]},{"text":"impl Unpin for CliSpecMetaInfo","synthetic":true,"types":["cliparser::types::CliSpecMetaInfo"]},{"text":"impl Unpin for CliSpec","synthetic":true,"types":["cliparser::types::CliSpec"]},{"text":"impl Unpin for CliParsed","synthetic":true,"types":["cliparser::types::CliParsed"]}]; 3 | if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() -------------------------------------------------------------------------------- /docs/api/wheel.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/api/implementors/core/marker/trait.StructuralPartialEq.js: -------------------------------------------------------------------------------- 1 | (function() {var implementors = {}; 2 | implementors["cliparser"] = [{"text":"impl StructuralPartialEq for Command","synthetic":false,"types":["cliparser::types::Command"]},{"text":"impl StructuralPartialEq for ArgumentOccurrence","synthetic":false,"types":["cliparser::types::ArgumentOccurrence"]},{"text":"impl StructuralPartialEq for ArgumentValueType","synthetic":false,"types":["cliparser::types::ArgumentValueType"]},{"text":"impl StructuralPartialEq for ArgumentHelp","synthetic":false,"types":["cliparser::types::ArgumentHelp"]},{"text":"impl StructuralPartialEq for Argument","synthetic":false,"types":["cliparser::types::Argument"]},{"text":"impl StructuralPartialEq for PositionalArgument","synthetic":false,"types":["cliparser::types::PositionalArgument"]},{"text":"impl StructuralPartialEq for CliSpecMetaInfo","synthetic":false,"types":["cliparser::types::CliSpecMetaInfo"]},{"text":"impl StructuralPartialEq for CliSpec","synthetic":false,"types":["cliparser::types::CliSpec"]},{"text":"impl StructuralPartialEq for CliParsed","synthetic":false,"types":["cliparser::types::CliParsed"]}]; 3 | if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() -------------------------------------------------------------------------------- /docs/api/settings.html: -------------------------------------------------------------------------------- 1 |
9 | Function cliparser::
source · [−]
Function cliparser::parse_process
source · [−]pub fn parse_process(spec: &CliSpec) -> Result<CliParsed, ParserError>Expand description
Parsers the given command line based on the given spec and returns the result.
10 | In case of error (such as invalid input), an error will be returned.
11 | In case the command line does not match the spec, Ok(None) will be returned.
9 | Function cliparser::
source · [−]
Function cliparser::parse_process_any
source · [−]Expand description
Parsers the current process command line based on the given specs and returns the result.
10 | In case of invalid input or none of the provided specs do not match the command line, an error will be returned.
pub fn parse_any(
command_line: &Vec<&str>,
specs: Vec<&CliSpec>
) -> Result<(usize, CliParsed), ParserError>Expand description
Parsers the given command line based on the given specs and returns the result.
10 | In case of invalid input or none of the provided specs do not match the command line, an error will be returned.
";const js_data_name=setting["js_name"];const setting_name=setting["name"];if(setting["options"]!==undefined){output+=`
"}return output}function buildSettingsPage(){const themes=getVar("themes").split(",");const settings=[{"name":"Use system theme","js_name":"use-system-theme","default":true,},{"name":"Theme","js_name":"theme","default":"light","options":themes,},{"name":"Preferred light theme","js_name":"preferred-light-theme","default":"light","options":themes,},{"name":"Preferred dark theme","js_name":"preferred-dark-theme","default":"dark","options":themes,},{"name":"Auto-hide item contents for large items","js_name":"auto-hide-large-items","default":true,},{"name":"Auto-hide item methods' documentation","js_name":"auto-hide-method-docs","default":false,},{"name":"Auto-hide trait implementation documentation","js_name":"auto-hide-trait-implementations","default":false,},{"name":"Directly go to item in search if there is only one result","js_name":"go-to-only-result","default":false,},{"name":"Show line numbers on code examples","js_name":"line-numbers","default":false,},{"name":"Disable keyboard shortcuts","js_name":"disable-shortcuts","default":false,},];const elementKind=isSettingsPage?"section":"div";const innerHTML=`\
2 | ${setting_name}\
3 |
"}else{const checked=setting["default"]===true?" checked":"";output+=``}output+="`;onEach(setting["options"],option=>{const checked=option===setting["default"]?" checked":"";output+=``});output+="
${buildSettingsPageSections(settings)}
`;const el=document.createElement(elementKind);el.id="settings";el.innerHTML=innerHTML;if(isSettingsPage){document.getElementById(MAIN_ID).appendChild(el)}else{el.setAttribute("tabindex","-1");getSettingsButton().appendChild(el)}return el}const settingsMenu=buildSettingsPage();function displaySettings(){settingsMenu.style.display=""}function elemIsInParent(elem,parent){while(elem&&elem!==document.body){if(elem===parent){return true}elem=elem.parentElement}return false}function blurHandler(event){const settingsButton=getSettingsButton();if(!elemIsInParent(document.activeElement,settingsButton)&&!elemIsInParent(event.relatedTarget,settingsButton)){window.hideSettings()}}if(isSettingsPage){getSettingsButton().onclick=function(event){event.preventDefault()}}else{const settingsButton=getSettingsButton();const settingsMenu=document.getElementById("settings");window.hideSettings=function(){settingsMenu.style.display="none"};settingsButton.onclick=function(event){if(elemIsInParent(event.target,settingsMenu)){return}event.preventDefault();if(settingsMenu.style.display!=="none"){window.hideSettings()}else{displaySettings()}};settingsButton.onblur=blurHandler;settingsButton.querySelector("a").onblur=blurHandler;onEachLazy(settingsMenu.querySelectorAll("input"),el=>{el.onblur=blurHandler});settingsMenu.onblur=blurHandler}setTimeout(()=>{setEvents(settingsMenu);if(!isSettingsPage){displaySettings()}removeClass(getSettingsButton(),"rotate")},0)})()
--------------------------------------------------------------------------------
/docs/api/cliparser/types/index.html:
--------------------------------------------------------------------------------
1 | 
Expand description
types
10 |Defines the various types.
11 |Structs
12 |Holds the command line argument spec
13 |Holds the command line parse result
14 |Holds the command line spec (command/parameters/…)
15 |Holds the command line spec meta information used to generate version and help messages
16 |Holds the positional argument spec
17 |Enums
18 |The argument help text
19 |The argument occurrence type (see values for more info)
20 |The argument value type (see values for more info)
21 |The command (not params) string/s
22 |Holds the error information
23 |4 | [](https://github.com/sagiegurari/cliparser/blob/master/LICENSE) [](https://libraries.io/cargo/cliparser) [](https://docs.rs/crate/cliparser/) [](https://crates.io/crates/cliparser)
5 | [](https://sagiegurari.github.io/cargo-make) 6 | 7 | > Simple command line parser. 8 | 9 | * [Overview](#overview) 10 | * [Usage](#usage) 11 | * [Installation](#installation) 12 | * [API Documentation](https://sagiegurari.github.io/cliparser/) 13 | * [Contributing](.github/CONTRIBUTING.md) 14 | * [Release History](CHANGELOG.md) 15 | * [License](#license) 16 | 17 | 18 | ## Overview 19 | This library provide a very simple API to parse command line arguments.
20 | It will not cover all possible use cases in order to ensure a simple thin API. 21 | 22 | 23 | ## Usage 24 | The following is a simple usage example (there are more capabilities, see API docs): 25 | 26 | 27 | ```rust 28 | use cliparser::types::{ 29 | Argument, ArgumentHelp, ArgumentOccurrence, ArgumentValueType, CliSpec, CliSpecMetaInfo, 30 | PositionalArgument, 31 | }; 32 | use cliparser::{help, parse, version}; 33 | use std::collections::{HashMap, HashSet}; 34 | 35 | fn main() { 36 | let mut cli_spec = CliSpec::new(); 37 | 38 | // Add meta info to support help and version text generation 39 | cli_spec = cli_spec 40 | .set_meta_info(Some(CliSpecMetaInfo { 41 | author: Some("Sagie Gur-Ari".to_string()), 42 | version: Some("1.2.3-beta".to_string()), 43 | description: Some("Amazing example".to_string()), 44 | project: Some("example".to_string()), 45 | help_post_text: Some( 46 | "See more info at: https://github.com/sagiegurari/cargo-make".to_string(), 47 | ), 48 | })) 49 | // Define the prefix of the arguments. 50 | // It can be a command/s (path prefix ignored) and/or a sub command/s 51 | // If not defined, the parsing will start checking the arguments only. 52 | // In this example, the spec defines two ways to invoke a process, either 53 | // as 'makers' or as 'cargo make' and afterwards the arguments. 54 | .add_command("makers") 55 | .add_subcommand(vec!["cargo", "make"]) 56 | // Positional arguments come after all the known argument keys. 57 | // If the positional is None, positional arguments are not allowed. 58 | // Add -- to the command line forces positional arguments and stops key 59 | // based argument parsing. 60 | .set_positional_argument(Some(PositionalArgument { 61 | name: "args".to_string(), 62 | help: Some(ArgumentHelp::TextAndParam( 63 | "The command line arguments".to_string(), 64 | "ARGS".to_string(), 65 | )), 66 | })) 67 | // Add a 'flag' only argument which is an argument that does not accept any value. 68 | // You can define multiple variations of the parameter name. 69 | // For example, in this case putting --flag or -f in the command line would be parsed 70 | // as the 'flag' parameter. 71 | .add_argument(Argument { 72 | name: "flag".to_string(), 73 | key: vec!["--flag".to_string(), "-f".to_string()], 74 | argument_occurrence: ArgumentOccurrence::Single, 75 | value_type: ArgumentValueType::None, 76 | default_value: None, 77 | help: Some(ArgumentHelp::Text( 78 | "A flag without value example".to_string(), 79 | )), 80 | }) 81 | // Add an argument that accepts a single value, for example -s value 82 | .add_argument(Argument { 83 | name: "single".to_string(), 84 | key: vec!["--s1".to_string(), "-s".to_string()], 85 | argument_occurrence: ArgumentOccurrence::Single, 86 | value_type: ArgumentValueType::Single, 87 | default_value: None, 88 | help: Some(ArgumentHelp::Text( 89 | "A parameter with single value example".to_string(), 90 | )), 91 | }) 92 | // Add an argument that accepts multiple values 93 | .add_argument(Argument { 94 | name: "mo".to_string(), 95 | key: vec!["--mo1".to_string(), "-mo2".to_string()], 96 | argument_occurrence: ArgumentOccurrence::Multiple, 97 | value_type: ArgumentValueType::Single, 98 | default_value: None, 99 | help: Some(ArgumentHelp::Text( 100 | "A parameter with multiple values example".to_string(), 101 | )), 102 | }) 103 | // Add an argument that can appear multiple times. 104 | // Even if the value type if Single, multiple occurrences will 105 | // enable the argument to collect multiple values (one for each occurrence). 106 | .add_argument(Argument { 107 | name: "mv".to_string(), 108 | key: vec!["--mv1".to_string(), "-mv2".to_string()], 109 | argument_occurrence: ArgumentOccurrence::Single, 110 | value_type: ArgumentValueType::Multiple, 111 | default_value: None, 112 | help: Some(ArgumentHelp::Text( 113 | "A parameter with single value but can appear multiple times example".to_string(), 114 | )), 115 | }) 116 | // We can define a 'default' value. 117 | // In case the argument is not in the command line, we will get the default value. 118 | // However, the argument names list in the parsed struct will not include this 119 | // argument as it was not found. Only the argument values will contain it. 120 | // This is a good way to understand that we have a value but it was not entered by the caller. 121 | .add_argument(Argument { 122 | name: "default".to_string(), 123 | key: vec!["--d1".to_string(), "-d".to_string()], 124 | argument_occurrence: ArgumentOccurrence::Single, 125 | value_type: ArgumentValueType::Single, 126 | default_value: Some("some default".to_string()), 127 | help: Some(ArgumentHelp::Text( 128 | "A parameter with default value example".to_string(), 129 | )), 130 | }); 131 | 132 | // Parsers the given command line based on the given spec and returns the result. 133 | // In case of invalid input or the provided spec does not match the command line, an error will be returned. 134 | // In order to parse the process command line instead of providing it, use the parse_process. 135 | // Also, if you want to provide multiple specs and have each one checked, until the first one 136 | // which fits is found, use the parse_any and parse_process_any functions. 137 | let result = parse( 138 | &vec![ 139 | "cargo", "make", "-mv2", "4", "5", "6", "--mo1=1", "-mo2", "2", "-f", "-s", "3", 140 | "arg1", "arg2", "-mo2", "arg5", 141 | ], 142 | &cli_spec, 143 | ); 144 | 145 | // The CliParsed struct includes multiple members that define what was found 146 | // arguments - A collection of all arguments found (list of names not keys). 147 | // Arguments that were not found by defaulted to a given value will not be listed here. 148 | // argument_values - A map of all values for arguments found. 149 | // The map will exclude arguments that do not accept value but include arguments not provided 150 | // on the command line but were defaulted to a given value. 151 | // The map keys are the argument names (not keys) and the value is the list of all values 152 | // found for all occurrences. 153 | assert!(result.is_ok()); 154 | let cli_parsed = result.unwrap(); 155 | println!("Cli Parsed:\n{:?}", &cli_parsed); 156 | 157 | let mut argument_names = HashSet::new(); 158 | argument_names.insert("flag".to_string()); 159 | argument_names.insert("single".to_string()); 160 | argument_names.insert("mo".to_string()); 161 | argument_names.insert("mv".to_string()); 162 | argument_names.insert("args".to_string()); 163 | let mut argument_values = HashMap::new(); 164 | argument_values.insert("single".to_string(), vec!["3".to_string()]); 165 | argument_values.insert("mo".to_string(), vec!["1".to_string(), "2".to_string()]); 166 | argument_values.insert( 167 | "mv".to_string(), 168 | vec!["4".to_string(), "5".to_string(), "6".to_string()], 169 | ); 170 | argument_values.insert( 171 | "args".to_string(), 172 | vec![ 173 | "arg1".to_string(), 174 | "arg2".to_string(), 175 | "-mo2".to_string(), 176 | "arg5".to_string(), 177 | ], 178 | ); 179 | argument_values.insert("default".to_string(), vec!["some default".to_string()]); 180 | assert_eq!(cli_parsed.arguments, argument_names); 181 | assert_eq!(cli_parsed.argument_values, argument_values); 182 | 183 | // generate help text 184 | let help_text = help(&cli_spec); 185 | println!("{}", help_text); 186 | 187 | // generate version text 188 | let version_text = version(&cli_spec); 189 | println!("{}", version_text); 190 | } 191 | ``` 192 | 193 | 194 | 195 | ## Installation 196 | In order to use this library, just add it as a dependency: 197 | 198 | ```ini 199 | [dependencies] 200 | cliparser = "^0.1.2" 201 | ``` 202 | 203 | ## API Documentation 204 | See full docs at: [API Docs](https://sagiegurari.github.io/cliparser/) 205 | 206 | ## Contributing 207 | See [contributing guide](.github/CONTRIBUTING.md) 208 | 209 | 210 | ## Release History 211 | 212 | See [Changelog](CHANGELOG.md) 213 | 214 | 215 | ## License 216 | Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license. 217 | --------------------------------------------------------------------------------