--------------------------------------------------------------------------------
/Cargo.toml:
--------------------------------------------------------------------------------
1 | [package]
2 | name = "cargo-auto"
3 | # binary executable does not need to be SemVer, because nobody depends on it
4 | version = "2025.1108.929"
5 | authors = ["bestia.dev"]
6 | homepage = "https://bestia.dev"
7 | edition = "2021"
8 | description = "Automation tasks coded in Rust language for the workflow of Rust projects"
9 | repository = "https://github.com/automation-tasks-rs/cargo-auto"
10 | readme = "README.md"
11 | license = "MIT"
12 | # Keyword must be only one word: lowercase letters, hyphens(-) or numbers, less then 35 characters, at most 5 keywords per crate
13 | keywords = ["maintained", "ready-for-use", "rustlang","automation","workflow"]
14 | # Allowed categories are listed here
15 | categories = ["command-line-interface","development-tools::build-utils","development-tools::cargo-plugins"]
16 | # Publish to crates.io. Only this files.
17 | publish = true
18 | include = [
19 | "Cargo.toml",
20 | "LICENSE",
21 | "README.md",
22 | "src/*"
23 | ]
24 |
25 | # SemVer rules: Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.
26 | # WARNING: Although dependencies in Cargo.toml look like a specific version of the crate, they are just like a caret version (=x.y.z) and actually specify
27 | # the minimum version and allow automatic SemVer compatible updates up to a MAJOR increment! Always check the true version with `cargo tree`!
28 | [dependencies]
29 | lazy_static="1.5.0"
30 | base64ct = {version = "1.8.0", features = ["alloc"] }
31 | json5 = "0.4.1"
32 | image = "0.25.8"
33 | ico = "0.4.0"
34 | sha2 = "0.10.9"
35 | data-encoding = "2.9.0"
36 | thiserror="2.0.17"
37 | anyhow="1.0.100"
38 | crossplatform_path = "4.0.1"
39 | # crossplatform_path = { path = "../crossplatform_path" }
40 | serde = { version = "1.0.228", features = ["derive"] }
41 | serde_derive = "1.0.228"
42 | serde_json = "1.0.145"
43 | reqwest = { version = "0.12.24", features = ["blocking"] }
44 |
45 | flate2 = "1.1.5"
46 | tar = "0.4.44"
47 | walkdir = "2.5.0"
48 |
49 | tracing = {version="0.1.41", features=["attributes" ]}
50 | tracing-subscriber = { version = "0.3.20", features = ["env-filter", "std", "fmt", "time","ansi"] }
51 | tracing-appender="0.2.3"
52 | time = {version="0.3.44", features=["macros","local-offset"]}
53 | chrono ={version="0.4.42", default-features=false, features=["now"]}
54 |
55 | # The library enables the code to be used by other binary executables.
56 | [lib]
57 | name = "cargo_auto_main_lib"
58 | path = "src/lib.rs"
59 | # A flag for enabling documentation of this target. This is used by `cargo doc`.
60 | doc = false
61 |
62 | # The only and main binary executable.
63 | [[bin]]
64 | name = "cargo-auto"
65 | path = "src/bin/cargo-auto/main.rs"
66 | # A flag for enabling documentation of this target. This is used by `cargo doc`.
67 | doc = true
68 |
--------------------------------------------------------------------------------
/docs/static.files/scrape-examples-5e967b76.js:
--------------------------------------------------------------------------------
1 | "use strict";(function(){const DEFAULT_MAX_LINES=5;const HIDDEN_MAX_LINES=10;function scrollToLoc(elt,loc,isHidden){const lines=elt.querySelectorAll("[data-nosnippet]");let scrollOffset;const maxLines=isHidden?HIDDEN_MAX_LINES:DEFAULT_MAX_LINES;if(loc[1]-loc[0]>maxLines){const line=Math.max(0,loc[0]-1);scrollOffset=lines[line].offsetTop;}else{const halfHeight=elt.offsetHeight/2;const offsetTop=lines[loc[0]].offsetTop;const lastLine=lines[loc[1]];const offsetBot=lastLine.offsetTop+lastLine.offsetHeight;const offsetMid=(offsetTop+offsetBot)/2;scrollOffset=offsetMid-halfHeight;}lines[0].parentElement.scrollTo(0,scrollOffset);elt.querySelector(".rust").scrollTo(0,scrollOffset);}function createScrapeButton(parent,className,content){const button=document.createElement("button");button.className=className;button.title=content;parent.insertBefore(button,parent.firstChild);return button;}window.updateScrapedExample=(example,buttonHolder)=>{let locIndex=0;const highlights=Array.prototype.slice.call(example.querySelectorAll(".highlight"));const link=example.querySelector(".scraped-example-title a");let expandButton=null;if(!example.classList.contains("expanded")){expandButton=createScrapeButton(buttonHolder,"expand","Show all");}const isHidden=example.parentElement.classList.contains("more-scraped-examples");const locs=example.locs;if(locs.length>1){const next=createScrapeButton(buttonHolder,"next","Next usage");const prev=createScrapeButton(buttonHolder,"prev","Previous usage");const onChangeLoc=changeIndex=>{removeClass(highlights[locIndex],"focus");changeIndex();scrollToLoc(example,locs[locIndex][0],isHidden);addClass(highlights[locIndex],"focus");const url=locs[locIndex][1];const title=locs[locIndex][2];link.href=url;link.innerHTML=title;};prev.addEventListener("click",()=>{onChangeLoc(()=>{locIndex=(locIndex-1+locs.length)%locs.length;});});next.addEventListener("click",()=>{onChangeLoc(()=>{locIndex=(locIndex+1)%locs.length;});});}if(expandButton){expandButton.addEventListener("click",()=>{if(hasClass(example,"expanded")){removeClass(example,"expanded");removeClass(expandButton,"collapse");expandButton.title="Show all";scrollToLoc(example,locs[0][0],isHidden);}else{addClass(example,"expanded");addClass(expandButton,"collapse");expandButton.title="Show single example";}});}};function setupLoc(example,isHidden){example.locs=JSON.parse(example.attributes.getNamedItem("data-locs").textContent);scrollToLoc(example,example.locs[0][0],isHidden);}const firstExamples=document.querySelectorAll(".scraped-example-list > .scraped-example");onEachLazy(firstExamples,el=>setupLoc(el,false));onEachLazy(document.querySelectorAll(".more-examples-toggle"),toggle=>{onEachLazy(toggle.querySelectorAll(".toggle-line, .hide-more"),button=>{button.addEventListener("click",()=>{toggle.open=false;});});const moreExamples=toggle.querySelectorAll(".scraped-example");toggle.querySelector("summary").addEventListener("click",()=>{setTimeout(()=>{onEachLazy(moreExamples,el=>setupLoc(el,true));});},{once:true});});})();
--------------------------------------------------------------------------------
/docs/static.files/COPYRIGHT-7fb11f4e.txt:
--------------------------------------------------------------------------------
1 | # REUSE-IgnoreStart
2 |
3 | These documentation pages include resources by third parties. This copyright
4 | file applies only to those resources. The following third party resources are
5 | included, and carry their own copyright notices and license terms:
6 |
7 | * Fira Sans (FiraSans-Regular.woff2, FiraSans-Medium.woff2):
8 |
9 | Copyright (c) 2014, Mozilla Foundation https://mozilla.org/
10 | with Reserved Font Name Fira Sans.
11 |
12 | Copyright (c) 2014, Telefonica S.A.
13 |
14 | Licensed under the SIL Open Font License, Version 1.1.
15 | See FiraSans-LICENSE.txt.
16 |
17 | * rustdoc.css, main.js, and playpen.js:
18 |
19 | Copyright 2015 The Rust Developers.
20 | Licensed under the Apache License, Version 2.0 (see LICENSE-APACHE.txt) or
21 | the MIT license (LICENSE-MIT.txt) at your option.
22 |
23 | * normalize.css:
24 |
25 | Copyright (c) Nicolas Gallagher and Jonathan Neal.
26 | Licensed under the MIT license (see LICENSE-MIT.txt).
27 |
28 | * Source Code Pro (SourceCodePro-Regular.ttf.woff2,
29 | SourceCodePro-Semibold.ttf.woff2, SourceCodePro-It.ttf.woff2):
30 |
31 | Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/),
32 | with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark
33 | of Adobe Systems Incorporated in the United States and/or other countries.
34 |
35 | Licensed under the SIL Open Font License, Version 1.1.
36 | See SourceCodePro-LICENSE.txt.
37 |
38 | * Source Serif 4 (SourceSerif4-Regular.ttf.woff2, SourceSerif4-Bold.ttf.woff2,
39 | SourceSerif4-It.ttf.woff2, SourceSerif4-Semibold.ttf.woff2):
40 |
41 | Copyright 2014-2021 Adobe (http://www.adobe.com/), with Reserved Font Name
42 | 'Source'. All Rights Reserved. Source is a trademark of Adobe in the United
43 | States and/or other countries.
44 |
45 | Licensed under the SIL Open Font License, Version 1.1.
46 | See SourceSerif4-LICENSE.md.
47 |
48 | * Nanum Barun Gothic Font (NanumBarunGothic.woff2)
49 |
50 | Copyright 2010, NAVER Corporation (http://www.nhncorp.com)
51 | with Reserved Font Name Nanum, Naver Nanum, NanumGothic, Naver NanumGothic,
52 | NanumMyeongjo, Naver NanumMyeongjo, NanumBrush, Naver NanumBrush, NanumPen,
53 | Naver NanumPen, Naver NanumGothicEco, NanumGothicEco,
54 | Naver NanumMyeongjoEco, NanumMyeongjoEco, Naver NanumGothicLight,
55 | NanumGothicLight, NanumBarunGothic, Naver NanumBarunGothic.
56 |
57 | https://hangeul.naver.com/2017/nanum
58 | https://github.com/hiun/NanumBarunGothic
59 |
60 | Licensed under the SIL Open Font License, Version 1.1.
61 | See NanumBarunGothic-LICENSE.txt.
62 |
63 | * Rust logos (rust-logo.svg, favicon.svg, favicon-32x32.png)
64 |
65 | Copyright 2025 Rust Foundation.
66 | Licensed under the Creative Commons Attribution license (CC-BY).
67 | https://rustfoundation.org/policy/rust-trademark-policy/
68 |
69 | This copyright file is intended to be distributed with rustdoc output.
70 |
71 | # REUSE-IgnoreEnd
72 |
--------------------------------------------------------------------------------
/automation_tasks_rs/src/utils_mod.rs:
--------------------------------------------------------------------------------
1 | // utils_mod.rs
2 |
3 | //! Helper functions that does not usually change.
4 | //!
5 | //! Don't change this code, so it can be updated regularly with
6 | //! cargo auto update_automation_tasks_rs
7 | //! If you want to customize it, copy the code into main.rs and modify it there.
8 |
9 | use crate::cargo_auto_lib as cl;
10 |
11 | #[allow(unused_imports)]
12 | pub use cl::{BLUE, GREEN, RED, RESET, YELLOW};
13 |
14 | /// Initialize tracing to file logs/automation_tasks_rs.log. \
15 | ///
16 | /// The folder logs/ is in .gitignore and will not be committed.
17 | pub fn tracing_init() -> anyhow::Result<()> {
18 | let offset = time::UtcOffset::current_local_offset()?;
19 | let timer = tracing_subscriber::fmt::time::OffsetTime::new(
20 | offset,
21 | time::macros::format_description!("[hour]:[minute]:[second].[subsecond digits:6]"),
22 | );
23 |
24 | // A filter consists of one or more comma-separated directives
25 | // target[span{field=value}]=level
26 | // Levels order: 1. ERROR, 2. WARN, 3. INFO, 4. DEBUG, 5. TRACE
27 | // ERROR level is always logged.
28 | // Add filters to AUTOMATION_TASKS_RS_LOG environment variable for a single execution:
29 | // ```bash
30 | // AUTOMATION_TASKS_RS_LOG="debug,hyper_util=info,reqwest=info" ./{package_name}
31 | // ```
32 | let filter = tracing_subscriber::EnvFilter::from_env("AUTOMATION_TASKS_RS_LOG");
33 |
34 | let builder = tracing_subscriber::fmt()
35 | .with_timer(timer)
36 | .with_ansi(false)
37 | .with_target(false)
38 | .with_env_filter(filter);
39 | if std::env::var("AUTOMATION_TASKS_RS_LOG").is_ok() {
40 | // if AUTOMATION_TASKS_RS_LOG exists than enable tracing to file
41 | let file_appender = tracing_appender::rolling::RollingFileAppender::builder()
42 | .rotation(tracing_appender::rolling::Rotation::DAILY)
43 | .filename_prefix("automation_tasks_rs")
44 | .filename_suffix("log")
45 | .build("logs")
46 | .expect("initializing rolling file appender failed");
47 | builder.with_writer(file_appender).init();
48 | } else {
49 | builder.init();
50 | };
51 |
52 | Ok(())
53 | }
54 |
55 | /// macro to get source code position to log errors before propagation
56 | ///
57 | /// example: read_to_string("x").log(pos!())?;
58 | macro_rules! pos {
59 | // `()` indicates that the macro takes no argument.
60 | () => {
61 | // The macro will expand into the contents of this block.
62 | &format!("{}:{}:{}:", file!(), line!(), column!())
63 | };
64 | }
65 | pub(crate) use pos;
66 |
67 | /// Trait to log the error from Result before propagation with ?.
68 | pub trait ResultLogError: Sized {
69 | fn log(self, file_line_column: &str) -> Self;
70 | }
71 |
72 | /// Implements LogError for anyhow::Result.
73 | impl ResultLogError for core::result::Result {
74 | fn log(self, file_line_column: &str) -> Self {
75 | self.inspect_err(|err| tracing::debug!("automation_tasks_rs/{} {:?}", file_line_column, err))
76 | }
77 | }
78 |
--------------------------------------------------------------------------------
/automation_tasks_rs/src/cargo_auto_lib/auto_helper_functions_mod.rs:
--------------------------------------------------------------------------------
1 | // auto_helper_functions_mod
2 |
3 | //! Various helper functions.
4 |
5 | use crate::cargo_auto_lib::error_mod::{Error, Result};
6 | use crate::cargo_auto_lib::public_api_mod::{RED, RESET};
7 | use crate::utils_mod::{pos, ResultLogError};
8 |
9 | // region: auto_md_to_doc_comments include doc_comments/exit_if_not_run_in_rust_project_root_directory.md A ///
10 | /// Check if the code was run inside the Rust project root directory.
11 | ///
12 | /// There must be the `Cargo.toml` file and the directory `automation_tasks_rs`
13 | /// If not, exit with error message.
14 | ///
15 | // endregion: auto_md_to_doc_comments include doc_comments/exit_if_not_run_in_rust_project_root_directory.md A ///
16 | pub fn exit_if_not_run_in_rust_project_root_directory() {
17 | if !(camino::Utf8Path::new("automation_tasks_rs").exists() && (camino::Utf8Path::new("Cargo.toml").exists())) {
18 | eprintln!("{RED}Error: `automation_tasks_rs` must be run inside the Rust project in the dir that contains");
19 | println!("`Cargo.toml` file and `automation_tasks_rs` directory. Exiting...{RESET}");
20 | // early exit
21 | std::process::exit(1);
22 | }
23 | }
24 |
25 | /// Print one or more sub_commands.
26 | pub fn completion_return_one_or_more_sub_commands(sub_commands: Vec<&str>, word_being_completed: &str) {
27 | let mut sub_found = false;
28 | for sub_command in sub_commands.iter() {
29 | if sub_command.starts_with(word_being_completed) {
30 | println!("{sub_command}");
31 | sub_found = true;
32 | }
33 | }
34 | if !sub_found {
35 | // print all sub-commands
36 | for sub_command in sub_commands.iter() {
37 | println!("{sub_command}");
38 | }
39 | }
40 | }
41 |
42 | /// Get home dir using the home crate.
43 | ///
44 | /// Error if HOME not found.
45 | pub fn home_dir() -> Result {
46 | match home::home_dir() {
47 | Some(path_buff) => {
48 | if !path_buff.as_os_str().is_empty() {
49 | Ok(path_buff)
50 | } else {
51 | Err(Error::ErrorFromStr("{RED}Unable to get your home dir!{RESET}"))
52 | }
53 | }
54 | None => Err(Error::ErrorFromStr("{RED}Unable to get your home dir!{RESET}")),
55 | }
56 | }
57 |
58 | /// Replace tilde with home::home_dir, only for utf8.
59 | pub fn tilde_expand_to_home_dir_utf8(path_str: &str) -> Result {
60 | let mut expanded = String::new();
61 | if path_str.starts_with("~") {
62 | let base = home::home_dir()
63 | .ok_or_else(|| Error::ErrorFromStr("Cannot find home_dir in this OS."))
64 | .log(pos!())?;
65 | // only utf8 is accepted
66 | let base = base.to_string_lossy();
67 | expanded.push_str(&base);
68 | expanded.push_str(path_str.trim_start_matches("~"));
69 | use std::str::FromStr;
70 | Ok(camino::Utf8PathBuf::from_str(&expanded).log(pos!())?)
71 | } else {
72 | use std::str::FromStr;
73 | Ok(camino::Utf8PathBuf::from_str(path_str).log(pos!())?)
74 | }
75 | }
76 |
--------------------------------------------------------------------------------
/docs/cargo_auto/fn.main.html:
--------------------------------------------------------------------------------
1 | main in cargo_auto - Rust
--------------------------------------------------------------------------------
/docs/cargo_auto/generic_functions_mod/constant.RED.html:
--------------------------------------------------------------------------------
1 | RED in cargo_auto::generic_functions_mod - Rust
--------------------------------------------------------------------------------
/docs/cargo_auto/generic_functions_mod/constant.BLUE.html:
--------------------------------------------------------------------------------
1 | BLUE in cargo_auto::generic_functions_mod - Rust
--------------------------------------------------------------------------------
/docs/cargo_auto/generic_functions_mod/constant.GREEN.html:
--------------------------------------------------------------------------------
1 | GREEN in cargo_auto::generic_functions_mod - Rust
--------------------------------------------------------------------------------
/docs/cargo_auto/all.html:
--------------------------------------------------------------------------------
1 | List of all items in this crate
The folder logs/ is in .gitignore and will not be committed.
3 |
--------------------------------------------------------------------------------
/automation_tasks_rs/src/cargo_auto_lib/auto_check_micro_xml_mod.rs:
--------------------------------------------------------------------------------
1 | // auto_check_micro_xml_mod.rs
2 |
3 | //! Checks the correctness of micro XML files.
4 |
5 | use crate::cargo_auto_lib::error_mod::{Error, Result};
6 | use crate::cargo_auto_lib::public_api_mod::{RED, RESET, YELLOW};
7 | use crate::utils_mod::{pos, ResultLogError};
8 | use glob::glob;
9 | use reader_for_microxml::{ReaderForMicroXml, Token};
10 |
11 | /// I want html pages to be correct microXML when I use them for single page application.
12 | /// Before build or release this function will check for correctness.
13 | pub fn auto_check_micro_xml(path_to_html_pages: &str) -> Result<()> {
14 | println!(" {YELLOW}Running auto_check_micro_xml {path_to_html_pages}{RESET}");
15 | let glob_str = format!("{}/*.html", path_to_html_pages.trim_end_matches('/'));
16 | // find html pages for single page application
17 | for filename_result in glob(&glob_str).log(pos!())? {
18 | let filename_pathbuff = filename_result?;
19 | let filename_pathbuff = camino::Utf8Path::from_path(&filename_pathbuff)
20 | .ok_or_else(|| Error::ErrorFromStr("filename is None"))
21 | .log(pos!())?;
22 |
23 | let file_name = filename_pathbuff
24 | .file_name()
25 | .ok_or_else(|| Error::ErrorFromStr("filename is None"))
26 | .log(pos!())?;
27 | let str_xml = std::fs::read_to_string(filename_pathbuff).log(pos!())?;
28 |
29 | // check if file have CRLF instead of LF and show error
30 | if str_xml.contains("\r\n") {
31 | return Err(Error::ErrorFromString(format!(
32 | "{RED}Error: {filename_pathbuff} has CRLF line endings instead of LF. Correct the file! {RESET}"
33 | )));
34 | }
35 |
36 | // check microxml correctness. Error on errors.
37 | check_micro_xml(&str_xml, file_name).log(pos!())?;
38 | }
39 | println!(" {YELLOW}Finished auto_check_micro_xml{RESET}");
40 | Ok(())
41 | }
42 |
43 | /// Errors if the microXML string is not correct
44 | fn check_micro_xml(str_xml: &str, file_name: &str) -> Result<()> {
45 | println!(" {YELLOW}Check MicroXml: {file_name}{RESET}");
46 | // remove because it is not microXML
47 | let str_xml = str_xml.replace("", "");
48 | let reader_iterator = ReaderForMicroXml::new(&str_xml);
49 | // reader_iterator is iterator Option>
50 | // the first option is used for the iterator to know where is the end
51 | // then the Result can have an Token or an Error
52 | let mut vec_elem: Vec<&str> = vec![];
53 | for result_token in reader_iterator {
54 | match result_token {
55 | Ok(token) => match token {
56 | Token::StartElement(name) => vec_elem.push(name),
57 | Token::Attribute(_name, _value) => continue,
58 | Token::TextNode(_txt) => continue,
59 | Token::Comment(_txt) => continue,
60 | Token::EndElement(end_element_name) => {
61 | let start_element_name = vec_elem
62 | .pop()
63 | .ok_or_else(|| Error::ErrorFromStr("vec_elem.pop() is None"))
64 | .log(pos!())?;
65 | if !end_element_name.is_empty() && end_element_name != start_element_name {
66 | return Err(Error::ErrorFromString(format!(
67 | "{RED}MicroXml {} start {} does not match end {}{RESET}",
68 | file_name, start_element_name, end_element_name,
69 | )));
70 | }
71 | }
72 | },
73 | Err(err_msg) => {
74 | return Err(Error::ErrorFromString(format!(
75 | "{RED}MicroXml {} incorrect : {}{RESET}",
76 | file_name, err_msg,
77 | )));
78 | }
79 | }
80 | }
81 | Ok(())
82 | }
83 |
--------------------------------------------------------------------------------
/docs/static.files/favicon-044be391.svg:
--------------------------------------------------------------------------------
1 |
25 |
--------------------------------------------------------------------------------
/automation_tasks_rs/src/cargo_auto_lib/utils_mod.rs:
--------------------------------------------------------------------------------
1 | // utils_mod.rs
2 |
3 | //! Functions for various utilities.
4 |
5 | use crate::{
6 | cargo_auto_lib::error_mod::{Error, Result},
7 | utils_mod::{pos, ResultLogError},
8 | };
9 |
10 | // region: delimiters cannot be INACTIVE like markers
11 |
12 | /// Position of start of the delimited data after the delimiter
13 | pub fn find_pos_start_data_after_delimiter(md_text_content: &str, pos: usize, delimiter: &str) -> Result {
14 | if let Ok(pos_start_data) = find_from(md_text_content, pos, delimiter) {
15 | let pos_start_data = pos_start_data + delimiter.len();
16 | return Ok(pos_start_data);
17 | }
18 | // return
19 | Err(Error::ErrorFromStr("not found"))
20 | }
21 |
22 | /// Position of end of the delimited data before the delimiter
23 | pub fn find_pos_end_data_before_delimiter(md_text_content: &str, pos: usize, delimiter: &str) -> Result {
24 | if let Ok(pos_end_data) = find_from(md_text_content, pos, delimiter) {
25 | return Ok(pos_end_data);
26 | }
27 | //return
28 | Err(Error::ErrorFromStr("not found"))
29 | }
30 |
31 | // endregion: delimiters cannot be INACTIVE like markers
32 |
33 | /// Find from pos
34 | pub fn find_from(text: &str, from_pos: usize, find: &str) -> Result {
35 | let slice01 = text
36 | .get(from_pos..)
37 | .ok_or_else(|| Error::ErrorFromStr("text get is None"))
38 | .log(pos!())?;
39 | let option_location = slice01.find(find);
40 | if let Some(location) = option_location {
41 | // return Ok with usize
42 | Ok(from_pos + location)
43 | } else {
44 | // return Err
45 | Err(Error::ErrorFromStr("location is not find"))
46 | }
47 | }
48 |
49 | // region: auto_md_to_doc_comments include doc_comments/traverse_dir_with_exclude_dir.md A ///
50 | /// Traverse dir and its sub-dir, but avoid excluded dirs.
51 | ///
52 | /// The find_file and the exclude dir strings must start with /.
53 | ///
54 | /// ## Example
55 | ///
56 | /// ```Rust ignore
57 | ///
58 | /// let files = cargo_auto_lib::traverse_dir_with_exclude_dir(
59 | /// Path::new("/home/project/src"),
60 | /// "/*.rs",
61 | /// // avoid big folders
62 | /// &vec![
63 | /// "/.git".to_string(),
64 | /// "/target".to_string(),
65 | /// "/docs".to_string()
66 | /// ]
67 | /// ).expect("error");
68 | /// for rs_file_name in files.iter() {
69 | /// println!("{}", &rs_file_name);
70 | /// }
71 | /// ```
72 | ///
73 | // endregion: auto_md_to_doc_comments include doc_comments/traverse_dir_with_exclude_dir.md A ///
74 | pub fn traverse_dir_with_exclude_dir(dir: &std::path::Path, find_file: &str, exclude_dirs: &[String]) -> Result> {
75 | // if the parameter is /*.rs, I can eliminate /*
76 | let find_file = &find_file.replace("/*", "");
77 |
78 | let mut v = Vec::new();
79 | if dir.is_dir() {
80 | for entry in std::fs::read_dir(dir).log(pos!())? {
81 | let entry = entry?;
82 | let path = entry.path();
83 | let str_path = path.to_str().ok_or_else(|| Error::ErrorFromStr("path is None")).log(pos!())?;
84 | if path.is_dir() {
85 | let mut is_excluded = false;
86 | for excl in exclude_dirs {
87 | if str_path.ends_with(excl) {
88 | is_excluded = true;
89 | break;
90 | }
91 | }
92 | if !is_excluded {
93 | let mut sub_v = traverse_dir_with_exclude_dir(&path, find_file, exclude_dirs).log(pos!())?;
94 | v.append(&mut sub_v);
95 | }
96 | } else if str_path.ends_with(find_file) {
97 | v.push(str_path.to_string());
98 | }
99 | }
100 | }
101 | Ok(v)
102 | }
103 |
104 | /// The original `concat()` function does not have a delimiter.
105 | pub fn concatenate_vec_to_string(vec: &[String], delimiter: &str) -> String {
106 | let size = vec.iter().fold(0, |a, b| a + b.len());
107 | let mut concatenated_string = String::with_capacity(size);
108 | for (i, item) in vec.iter().enumerate() {
109 | if i > 0 {
110 | concatenated_string.push_str(delimiter);
111 | }
112 | concatenated_string.push_str(item);
113 | }
114 | // return
115 | concatenated_string
116 | }
117 |
118 | /// UTC date in iso standard like 2024-12-31.
119 | pub fn now_utc_date_iso() -> String {
120 | chrono::Utc::now().format("%Y-%m-%d").to_string()
121 | }
122 |
--------------------------------------------------------------------------------
/docs/static.files/FiraSans-LICENSE-05ab6dbd.txt:
--------------------------------------------------------------------------------
1 | // REUSE-IgnoreStart
2 |
3 | Digitized data copyright (c) 2012-2015, The Mozilla Foundation and Telefonica S.A.
4 | with Reserved Font Name < Fira >,
5 |
6 | This Font Software is licensed under the SIL Open Font License, Version 1.1.
7 | This license is copied below, and is also available with a FAQ at:
8 | http://scripts.sil.org/OFL
9 |
10 |
11 | -----------------------------------------------------------
12 | SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
13 | -----------------------------------------------------------
14 |
15 | PREAMBLE
16 | The goals of the Open Font License (OFL) are to stimulate worldwide
17 | development of collaborative font projects, to support the font creation
18 | efforts of academic and linguistic communities, and to provide a free and
19 | open framework in which fonts may be shared and improved in partnership
20 | with others.
21 |
22 | The OFL allows the licensed fonts to be used, studied, modified and
23 | redistributed freely as long as they are not sold by themselves. The
24 | fonts, including any derivative works, can be bundled, embedded,
25 | redistributed and/or sold with any software provided that any reserved
26 | names are not used by derivative works. The fonts and derivatives,
27 | however, cannot be released under any other type of license. The
28 | requirement for fonts to remain under this license does not apply
29 | to any document created using the fonts or their derivatives.
30 |
31 | DEFINITIONS
32 | "Font Software" refers to the set of files released by the Copyright
33 | Holder(s) under this license and clearly marked as such. This may
34 | include source files, build scripts and documentation.
35 |
36 | "Reserved Font Name" refers to any names specified as such after the
37 | copyright statement(s).
38 |
39 | "Original Version" refers to the collection of Font Software components as
40 | distributed by the Copyright Holder(s).
41 |
42 | "Modified Version" refers to any derivative made by adding to, deleting,
43 | or substituting -- in part or in whole -- any of the components of the
44 | Original Version, by changing formats or by porting the Font Software to a
45 | new environment.
46 |
47 | "Author" refers to any designer, engineer, programmer, technical
48 | writer or other person who contributed to the Font Software.
49 |
50 | PERMISSION & CONDITIONS
51 | Permission is hereby granted, free of charge, to any person obtaining
52 | a copy of the Font Software, to use, study, copy, merge, embed, modify,
53 | redistribute, and sell modified and unmodified copies of the Font
54 | Software, subject to the following conditions:
55 |
56 | 1) Neither the Font Software nor any of its individual components,
57 | in Original or Modified Versions, may be sold by itself.
58 |
59 | 2) Original or Modified Versions of the Font Software may be bundled,
60 | redistributed and/or sold with any software, provided that each copy
61 | contains the above copyright notice and this license. These can be
62 | included either as stand-alone text files, human-readable headers or
63 | in the appropriate machine-readable metadata fields within text or
64 | binary files as long as those fields can be easily viewed by the user.
65 |
66 | 3) No Modified Version of the Font Software may use the Reserved Font
67 | Name(s) unless explicit written permission is granted by the corresponding
68 | Copyright Holder. This restriction only applies to the primary font name as
69 | presented to the users.
70 |
71 | 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
72 | Software shall not be used to promote, endorse or advertise any
73 | Modified Version, except to acknowledge the contribution(s) of the
74 | Copyright Holder(s) and the Author(s) or with their explicit written
75 | permission.
76 |
77 | 5) The Font Software, modified or unmodified, in part or in whole,
78 | must be distributed entirely under this license, and must not be
79 | distributed under any other license. The requirement for fonts to
80 | remain under this license does not apply to any document created
81 | using the Font Software.
82 |
83 | TERMINATION
84 | This license becomes null and void if any of the above conditions are
85 | not met.
86 |
87 | DISCLAIMER
88 | THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
89 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
90 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
91 | OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
92 | COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
93 | INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
94 | DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
95 | FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
96 | OTHER DEALINGS IN THE FONT SOFTWARE.
97 |
98 | // REUSE-IgnoreEnd
99 |
--------------------------------------------------------------------------------
/docs/cargo_auto/generic_functions_mod/index.html:
--------------------------------------------------------------------------------
1 | cargo_auto::generic_functions_mod - Rust