use std::fmt::{Display, Formatter}; use crosstermion::crossterm::style::Stylize;use owo_colors::OwoColorize;use tabled::{Style, TableIteratorExt, Tabled}; #[derive(Clone)]enum Usage { /// It's not reasonable to implement it as the prerequisites don't apply. NotApplicable { reason: &'static str }, /// We have no intention to implement it, but that can change if there is demand. NotPlanned { reason: &'static str }, /// We definitely want to implement this configuration value. Planned { note: Option<&'static str> }, /// The configuration is already effective and used (at least) in the given module `name`. InModule { name: &'static str, deviation: Option<&'static str>, }, /// Needs analysis, unclear how it works or what it does. Puzzled,}use Usage::*; impl Display for Usage { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { match self { Puzzled => f.write_str("❓")?, NotApplicable { reason } => write!(f, "not applicable: {reason}")?, NotPlanned { reason } => { write!(f, "{}", "not planned".blink())?; write!(f, " ℹ {} ℹ", reason.bright_white())?; } Planned { note } => { write!(f, "{}", "planned".blink())?; if let Some(note) = note { write!(f, " ℹ {} ℹ", note.bright_white())?; } } InModule { name, deviation } => { write!(f, "mod {name}")?; if let Some(deviation) = deviation { write!(f, "{}", format!(" ❗️{deviation}❗️").bright_white())? } } } Ok(()) }} impl Usage { pub fn icon(&self) -> &'static str { match self { Puzzled => "?", NotApplicable { .. } => "❌", Planned { .. } => "🕒", NotPlanned { .. } => "🤔", InModule { deviation, .. } => deviation.is_some().then(|| "👌️").unwrap_or("✅"), } }} #[derive(Clone)]struct Record { config: &'static str, usage: Usage,} impl Tabled for Record { const LENGTH: usize = 3; fn fields(&self) -> Vec<String> { let mut tokens = self.config.split('.'); let mut buf = vec![{ let name = tokens.next().expect("present"); if name == "gitoxide" { name.bold().green() } else { name.bold() } .to_string() }]; buf.extend(tokens.map(ToOwned::to_owned)); vec![self.usage.icon().into(), buf.join("."), self.usage.to_string()] } fn headers() -> Vec<String> { vec![] }} static GIT_CONFIG: &[Record] = &[ Record { config: "core.safeCRLF", usage: Planned { note: Some("safety is not optional") }, }, Record { config: "core.fileMode", usage: InModule {name: "config", deviation: None}, }, Record { config: "core.hideDotFiles", usage: Planned {note: Some("Seems useful, but needs demand from windows users")} }, Record { config: "core.trustCTime", usage: Planned { note: Some("Needed for checkout - read from config but not used yet") }, }, Record { config: "core.checkStat", usage: Planned { note: Some("Needed for checkout - read from config but not used yet further down") }, }, Record { config: "core.symlinks", usage: InModule {name: "config", deviation: None}, }, Record { config: "core.packedGitWindowSize", usage: NotPlanned { reason: "an optimization for handling many large packs more efficiently seems unnecessary" } }, Record { config: "core.packedGitLimit", usage: NotApplicable { reason: "we target 32bit systems only and don't use a windowing mechanism" } }, Record { config: "core.deltaBaseCacheLimit", usage: NotApplicable { reason: "we use a small 64 slot pack delta cache by default, which can be replaced with larger caches as determined by the algorithm. This keeps memory usage low and is fast enough" } }, Record { config: "core.bigFileThreshold", usage: Planned { note: Some("unfortunately we can't stream packed files yet, even if not delta-compressed, but respecting the threshold for other operations is definitely a must") } }, Record { config: "core.compression", usage: Planned { note: Some("Allow to remove similar hardcoded value - passing it through will be some effort") }, }, Record { config: "core.loosecompression", usage: Planned { note: None }, }, Record { config: "core.ignorecase", usage: InModule {name: "config", deviation: None} }, Record { config: "core.precomposeUnicode", usage: InModule {name: "config", deviation: Some("This must be explicitly handled when data is coming into the program to fully work")} }, Record { config: "core.protectHFS", usage: Planned { note: Some("relevant for checkout on MacOS") }, }, Record { config: "core.protectNTFS", usage: NotPlanned { reason: "lack of demand"}, }, Record { config: "core.sparseCheckout", usage: Planned { note: Some("we want to support huge repos and be the fastest in doing so") }, }, Record { config: "core.sparseCheckoutCone", usage: Planned { note: Some("this is a nice improvement over spareCheckout alone and should one day be available too") }, }, Record { config: "checkout.defaultRemote", usage: Planned { note: Some("needed for correct checkout behaviour, similar to what git does") }, }, Record { config: "core.untrackedCache", usage: Planned { note: Some("needed for fast worktree operation") }, }, Record { config: "checkout.guess", usage: Planned { note: None }, }, Record { config: "checkout.workers", usage: InModule {name: "clone::checkout", deviation: Some("if unset, uses all cores instead of just one")}, }, Record { config: "checkout.thresholdForParallelism", usage: NotApplicable {reason: "parallelism is efficient enough to always run with benefit"}, }, Record { config: "feature.manyFile", usage: Planned {note: Some("big repositories are on the roadmap")}, }, Record { config: "core.preloadIndex", usage: Planned {note: Some("it's enabled by default and allows parallel stat checks - it's using a lot of CPU for just minor performance boosts though")}, }, Record { config: "index.sparse", usage: Planned {note: Some("we can read sparse indices and support for it will be added early on")}, }, Record { config: "merge.renormalize", usage: Planned {note: Some("once merging is being implemented, renormalization should be respected")}, }, Record { config: "sparse.expectFilesOutsideOfPatterns", usage: Planned {note: Some("a feature definitely worth having")}, }, Record { config: "submodule.recurse", usage: Planned {note: Some("very relevant for doing the right thing during checkouts")}, }, Record { config: "branch.autoSetupRebase", usage: Planned { note: Some("for when we allow setting up upstream branches") }, }, Record { config: "branch.<name>.remote", usage: InModule { name: "reference::remote", deviation: None }, }, Record { config: "branch.<name>.pushRemote", usage: InModule { name: "reference::remote", deviation: None }, }, Record { config: "branch.<name>.merge", usage: InModule { name: "repository::config", deviation: None }, }, Record { config: "branch.<name>.rebase", usage: Planned { note: Some("for when we can merge, rebase should be supported") }, }, Record { config: "branch.<name>.description", usage: NotPlanned { reason: "no plan to implement format-patch or request-pull summary" }, }, Record { config: "core.bare", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.excludesFile", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.attributesFile", usage: Planned {note: Some("for checkout - it's already queried but needs building of attributes group, and of course support during checkout")}, }, Record { config: "core.abbrev", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.askPass", usage: InModule { name: "config::snapshot::credential_helpers", deviation: None, }, }, Record { config: "core.ignoreCase", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.multiPackIndex", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.disambiguate", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.eol", usage: Planned {note: Some("needed for filters, but also for doing diffs correctly")} }, Record { config: "core.filesRefLockTimeout", usage: InModule {name: "config::cache::access", deviation: None}, }, Record { config: "core.packedRefsTimeout", usage: InModule {name: "config::cache::access", deviation: None}, }, Record { config: "core.logAllRefUpdates", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.repositoryFormatVersion", usage: InModule { name: "config::cache::incubate", deviation: None, }, }, Record { config: "diff.algorithm", usage: InModule {name: "config::cache::access", deviation: Some("'patience' diff is not implemented and can default to 'histogram' if lenient config is used, and defaults to histogram if unset for fastest and best results")}, }, Record { config: "extensions.objectFormat", usage: InModule { name: "config::cache::incubate", deviation: Some( "Support for SHA256 is prepared but not fully implemented yet. For now we abort when encountered.", ), }, }, Record { config: "extensions.worktreeconfig", usage: Planned { note: Some("Seems to be turned on when sparse indices are used") }, }, Record { config: "committer.name", usage: InModule { name: "repository::identity", deviation: None, }, }, Record { config: "committer.email", usage: InModule { name: "repository::identity", deviation: None, }, }, Record { config: "author.name", usage: InModule { name: "repository::identity", deviation: None, }, }, Record { config: "author.email", usage: InModule { name: "repository::identity", deviation: None, }, }, Record { config: "user.name", usage: InModule { name: "repository::identity", deviation: Some("defaults to 'gitoxide'"), }, }, Record { config: "user.email", usage: InModule { name: "repository::identity", deviation: Some("defaults to 'gitoxide@localhost'"), }, }, Record { config: "clone.filterSubmodules,", usage: Planned { note: Some("currently object filtering isn't support, a prerequisite for this, see --filter=blob:none for more"), }, }, Record { config: "clone.defaultRemoteName", usage: InModule { name: "clone::prepare", deviation: None }, }, Record { config: "clone.rejectShallow", usage: NotPlanned { reason: "it's not a use-case we consider important now, but once that changes it can be implemented", }, }, Record { config: "fetch.recurseSubmodules", usage: Planned { note: Some("Seems useful for cargo as well"), }, }, Record { config: "fetch.fsckObjects", usage: Puzzled, }, Record { config: "fetch.fsck.<msg-id>", usage: Puzzled, }, Record { config: "fetch.fsck.skipList", usage: Puzzled, }, Record { config: "fetch.unpackLimit", usage: Planned { note: None }, }, Record { config: "fetch.prune", usage: Planned { note: None }, }, Record { config: "fetch.pruneTags", usage: Planned { note: None }, }, Record { config: "fetch.writeCommitGraph", usage: Planned { note: None }, }, Record { config: "fetch.parallel", usage: Planned { note: None }, }, Record { config: "fetch.showForcedUpdates", usage: NotApplicable {reason: "we don't support advices"}, }, Record { config: "fetch.output", usage: NotPlanned {reason: "'gix' might support it, but there is no intention on copying the 'git' CLI"}, }, Record { config: "fetch.negotiationAlgorithm", usage: Planned { note: Some("Implements our own 'naive' algorithm, only"), }, }, Record { config: "init.templateDir", usage: Planned { note: Some("copy non-hidden files from here into the GIT_DIR for support") }, }, Record { config: "init.defaultBranch", usage: InModule { name: "init", deviation: Some("If unset, we default to 'main' instead of 'master'") }, }, Record { config: "pack.threads", usage: InModule { name: "remote::connection::fetch", deviation: Some("if unset, it uses all threads as opposed to just 1"), }, }, Record { config: "pack.indexVersion", usage: InModule { name: "remote::connection::fetch", deviation: None, }, }, Record { config: "protocol.allow", usage: InModule { name: "remote::url::scheme_permission", deviation: None, }, }, Record { config: "protocol.<name>.allow", usage: InModule { name: "remote::url::scheme_permission", deviation: None, }, },Lines 1–500 of 795. Load more
use std::fmt::{Display, Formatter}; use crosstermion::crossterm::style::Stylize; use owo_colors::OwoColorize; use tabled::{Style, TableIteratorExt, Tabled}; #[derive(Clone)] enum Usage { /// It's not reasonable to implement it as the prerequisites don't apply. NotApplicable { reason: &'static str }, /// We have no intention to implement it, but that can change if there is demand. NotPlanned { reason: &'static str }, /// We definitely want to implement this configuration value. Planned { note: Option<&'static str> }, /// The configuration is already effective and used (at least) in the given module `name`. InModule { name: &'static str, deviation: Option<&'static str>, }, /// Needs analysis, unclear how it works or what it does. Puzzled, } use Usage::*; impl Display for Usage { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { match self { Puzzled => f.write_str("❓")?, NotApplicable { reason } => write!(f, "not applicable: {reason}")?, NotPlanned { reason } => { write!(f, "{}", "not planned".blink())?; write!(f, " ℹ {} ℹ", reason.bright_white())?; } Planned { note } => { write!(f, "{}", "planned".blink())?; if let Some(note) = note { write!(f, " ℹ {} ℹ", note.bright_white())?; } } InModule { name, deviation } => { write!(f, "mod {name}")?; if let Some(deviation) = deviation { write!(f, "{}", format!(" ❗️{deviation}❗️").bright_white())? } } } Ok(()) } } impl Usage { pub fn icon(&self) -> &'static str { match self { Puzzled => "?", NotApplicable { .. } => "❌", Planned { .. } => "🕒", NotPlanned { .. } => "🤔", InModule { deviation, .. } => deviation.is_some().then(|| "👌️").unwrap_or("✅"), } } } #[derive(Clone)] struct Record { config: &'static str, usage: Usage, } impl Tabled for Record { const LENGTH: usize = 3; fn fields(&self) -> Vec<String> { let mut tokens = self.config.split('.'); let mut buf = vec![{ let name = tokens.next().expect("present"); if name == "gitoxide" { name.bold().green() } else { name.bold() } .to_string() }]; buf.extend(tokens.map(ToOwned::to_owned)); vec![self.usage.icon().into(), buf.join("."), self.usage.to_string()] } fn headers() -> Vec<String> { vec![] } } static GIT_CONFIG: &[Record] = &[ Record { config: "core.safeCRLF", usage: Planned { note: Some("safety is not optional") }, }, Record { config: "core.fileMode", usage: InModule {name: "config", deviation: None}, }, Record { config: "core.hideDotFiles", usage: Planned {note: Some("Seems useful, but needs demand from windows users")} }, Record { config: "core.trustCTime", usage: Planned { note: Some("Needed for checkout - read from config but not used yet") }, }, Record { config: "core.checkStat", usage: Planned { note: Some("Needed for checkout - read from config but not used yet further down") }, }, Record { config: "core.symlinks", usage: InModule {name: "config", deviation: None}, }, Record { config: "core.packedGitWindowSize", usage: NotPlanned { reason: "an optimization for handling many large packs more efficiently seems unnecessary" } }, Record { config: "core.packedGitLimit", usage: NotApplicable { reason: "we target 32bit systems only and don't use a windowing mechanism" } }, Record { config: "core.deltaBaseCacheLimit", usage: NotApplicable { reason: "we use a small 64 slot pack delta cache by default, which can be replaced with larger caches as determined by the algorithm. This keeps memory usage low and is fast enough" } }, Record { config: "core.bigFileThreshold", usage: Planned { note: Some("unfortunately we can't stream packed files yet, even if not delta-compressed, but respecting the threshold for other operations is definitely a must") } }, Record { config: "core.compression", usage: Planned { note: Some("Allow to remove similar hardcoded value - passing it through will be some effort") }, }, Record { config: "core.loosecompression", usage: Planned { note: None }, }, Record { config: "core.ignorecase", usage: InModule {name: "config", deviation: None} }, Record { config: "core.precomposeUnicode", usage: InModule {name: "config", deviation: Some("This must be explicitly handled when data is coming into the program to fully work")} }, Record { config: "core.protectHFS", usage: Planned { note: Some("relevant for checkout on MacOS") }, }, Record { config: "core.protectNTFS", usage: NotPlanned { reason: "lack of demand"}, }, Record { config: "core.sparseCheckout", usage: Planned { note: Some("we want to support huge repos and be the fastest in doing so") }, }, Record { config: "core.sparseCheckoutCone", usage: Planned { note: Some("this is a nice improvement over spareCheckout alone and should one day be available too") }, }, Record { config: "checkout.defaultRemote", usage: Planned { note: Some("needed for correct checkout behaviour, similar to what git does") }, }, Record { config: "core.untrackedCache", usage: Planned { note: Some("needed for fast worktree operation") }, }, Record { config: "checkout.guess", usage: Planned { note: None }, }, Record { config: "checkout.workers", usage: InModule {name: "clone::checkout", deviation: Some("if unset, uses all cores instead of just one")}, }, Record { config: "checkout.thresholdForParallelism", usage: NotApplicable {reason: "parallelism is efficient enough to always run with benefit"}, }, Record { config: "feature.manyFile", usage: Planned {note: Some("big repositories are on the roadmap")}, }, Record { config: "core.preloadIndex", usage: Planned {note: Some("it's enabled by default and allows parallel stat checks - it's using a lot of CPU for just minor performance boosts though")}, }, Record { config: "index.sparse", usage: Planned {note: Some("we can read sparse indices and support for it will be added early on")}, }, Record { config: "merge.renormalize", usage: Planned {note: Some("once merging is being implemented, renormalization should be respected")}, }, Record { config: "sparse.expectFilesOutsideOfPatterns", usage: Planned {note: Some("a feature definitely worth having")}, }, Record { config: "submodule.recurse", usage: Planned {note: Some("very relevant for doing the right thing during checkouts")}, }, Record { config: "branch.autoSetupRebase", usage: Planned { note: Some("for when we allow setting up upstream branches") }, }, Record { config: "branch.<name>.remote", usage: InModule { name: "reference::remote", deviation: None }, }, Record { config: "branch.<name>.pushRemote", usage: InModule { name: "reference::remote", deviation: None }, }, Record { config: "branch.<name>.merge", usage: InModule { name: "repository::config", deviation: None }, }, Record { config: "branch.<name>.rebase", usage: Planned { note: Some("for when we can merge, rebase should be supported") }, }, Record { config: "branch.<name>.description", usage: NotPlanned { reason: "no plan to implement format-patch or request-pull summary" }, }, Record { config: "core.bare", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.excludesFile", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.attributesFile", usage: Planned {note: Some("for checkout - it's already queried but needs building of attributes group, and of course support during checkout")}, }, Record { config: "core.abbrev", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.askPass", usage: InModule { name: "config::snapshot::credential_helpers", deviation: None, }, }, Record { config: "core.ignoreCase", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.multiPackIndex", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.disambiguate", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.eol", usage: Planned {note: Some("needed for filters, but also for doing diffs correctly")} }, Record { config: "core.filesRefLockTimeout", usage: InModule {name: "config::cache::access", deviation: None}, }, Record { config: "core.packedRefsTimeout", usage: InModule {name: "config::cache::access", deviation: None}, }, Record { config: "core.logAllRefUpdates", usage: InModule { name: "config::cache", deviation: None, }, }, Record { config: "core.repositoryFormatVersion", usage: InModule { name: "config::cache::incubate", deviation: None, }, }, Record { config: "diff.algorithm", usage: InModule {name: "config::cache::access", deviation: Some("'patience' diff is not implemented and can default to 'histogram' if lenient config is used, and defaults to histogram if unset for fastest and best results")}, }, Record { config: "extensions.objectFormat", usage: InModule { name: "config::cache::incubate", deviation: Some( "Support for SHA256 is prepared but not fully implemented yet. For now we abort when encountered.", ), }, }, Record { config: "extensions.worktreeconfig", usage: Planned { note: Some("Seems to be turned on when sparse indices are used") }, }, Record { config: "committer.name", usage: InModule { name: "repository::identity", deviation: None, }, }, Record { config: "committer.email", usage: InModule { name: "repository::identity", deviation: None, }, }, Record { config: "author.name", usage: InModule { name: "repository::identity", deviation: None, }, }, Record { config: "author.email", usage: InModule { name: "repository::identity", deviation: None, }, }, Record { config: "user.name", usage: InModule { name: "repository::identity", deviation: Some("defaults to 'gitoxide'"), }, }, Record { config: "user.email", usage: InModule { name: "repository::identity", deviation: Some("defaults to 'gitoxide@localhost'"), }, }, Record { config: "clone.filterSubmodules,", usage: Planned { note: Some("currently object filtering isn't support, a prerequisite for this, see --filter=blob:none for more"), }, }, Record { config: "clone.defaultRemoteName", usage: InModule { name: "clone::prepare", deviation: None }, }, Record { config: "clone.rejectShallow", usage: NotPlanned { reason: "it's not a use-case we consider important now, but once that changes it can be implemented", }, }, Record { config: "fetch.recurseSubmodules", usage: Planned { note: Some("Seems useful for cargo as well"), }, }, Record { config: "fetch.fsckObjects", usage: Puzzled, }, Record { config: "fetch.fsck.<msg-id>", usage: Puzzled, }, Record { config: "fetch.fsck.skipList", usage: Puzzled, }, Record { config: "fetch.unpackLimit", usage: Planned { note: None }, }, Record { config: "fetch.prune", usage: Planned { note: None }, }, Record { config: "fetch.pruneTags", usage: Planned { note: None }, }, Record { config: "fetch.writeCommitGraph", usage: Planned { note: None }, }, Record { config: "fetch.parallel", usage: Planned { note: None }, }, Record { config: "fetch.showForcedUpdates", usage: NotApplicable {reason: "we don't support advices"}, }, Record { config: "fetch.output", usage: NotPlanned {reason: "'gix' might support it, but there is no intention on copying the 'git' CLI"}, }, Record { config: "fetch.negotiationAlgorithm", usage: Planned { note: Some("Implements our own 'naive' algorithm, only"), }, }, Record { config: "init.templateDir", usage: Planned { note: Some("copy non-hidden files from here into the GIT_DIR for support") }, }, Record { config: "init.defaultBranch", usage: InModule { name: "init", deviation: Some("If unset, we default to 'main' instead of 'master'") }, }, Record { config: "pack.threads", usage: InModule { name: "remote::connection::fetch", deviation: Some("if unset, it uses all threads as opposed to just 1"), }, }, Record { config: "pack.indexVersion", usage: InModule { name: "remote::connection::fetch", deviation: None, }, }, Record { config: "protocol.allow", usage: InModule { name: "remote::url::scheme_permission", deviation: None, }, }, Record { config: "protocol.<name>.allow", usage: InModule { name: "remote::url::scheme_permission", deviation: None, }, },