diff --git a/Cargo.toml b/Cargo.toml
index cbb91bf32..885bcf071 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -9,6 +9,7 @@ version = "0.0.9"
authors = ["uutils developers"]
license = "MIT"
description = "coreutils ~ GNU coreutils (updated); implemented as universal (cross-platform) utils, written in Rust"
+default-run = "coreutils"
homepage = "https://github.com/uutils/coreutils"
repository = "https://github.com/uutils/coreutils"
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 000000000..0b2699ecb
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,2 @@
+book
+_generated
\ No newline at end of file
diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html
new file mode 100644
index 000000000..80098ad2d
--- /dev/null
+++ b/docs/CONTRIBUTING.html
@@ -0,0 +1,185 @@
+
+
+
+
+ Contributing - Uutils Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
(utils: &UtilityMap, name: &str) {
- println!("{} {}\n", name, VERSION);
- println!("Generate markdown documentation for uutils");
- println!("Usage: {} [util]\n", name);
- println!("Currently defined functions:\n");
- #[allow(clippy::map_clone)]
- let mut utils: Vec<&str> = utils.keys().map(|&s| s).collect();
- utils.sort_unstable();
- let display_list = utils.join(", ");
- let width = cmp::min(textwrap::termwidth(), 100) - 4 * 2; // (opinion/heuristic) max 100 chars wide with 4 character side indentions
- println!(
- "{}",
- textwrap::indent(&textwrap::fill(&display_list, width), " ")
- );
-}
-
-fn binary_path(args: &mut impl Iterator- ) -> PathBuf {
- match args.next() {
- Some(ref s) if !s.is_empty() => PathBuf::from(s),
- _ => std::env::current_exe().unwrap(),
- }
-}
-
-fn name(binary_path: &Path) -> &str {
- binary_path.file_stem().unwrap().to_str().unwrap()
-}
-
fn main() {
uucore::panic::mute_sigpipe_panic();
- let utils = util_map();
- let mut args = uucore::args_os();
+ let utils = util_map::
>>();
- let binary = binary_path(&mut args);
- let binary_as_util = name(&binary);
-
- // binary name equals util name?
- if let Some(&(uumain, _)) = utils.get(binary_as_util) {
- process::exit(uumain((vec![binary.into()].into_iter()).chain(args)));
- }
-
- // binary name equals prefixed util name?
- // * prefix/stem may be any string ending in a non-alphanumeric character
- let util_name = if let Some(util) = utils.keys().find(|util| {
- binary_as_util.ends_with(*util)
- && !(&binary_as_util[..binary_as_util.len() - (*util).len()])
- .ends_with(char::is_alphanumeric)
- }) {
- // prefixed util => replace 0th (aka, executable name) argument
- Some(OsString::from(*util))
- } else {
- // unmatched binary name => regard as multi-binary container and advance argument list
- uucore::set_utility_is_second_arg();
- args.next()
- };
-
- // 0th argument equals util name?
- if let Some(util_os) = util_name {
- fn not_found(util: &OsStr) -> ! {
- println!("{}: function/utility not found", util.maybe_quote());
- process::exit(1);
+ for (name, (_, app)) in utils {
+ let p = format!("docs/_generated/{}-help.md", name);
+ if let Ok(f) = File::create(&p) {
+ write_markdown(f, &mut app());
+ println!("Wrote to '{}'", p);
}
-
- let util = match util_os.to_str() {
- Some(util) => util,
- None => not_found(&util_os),
- };
-
- match utils.get(util) {
- Some(&(uumain, app)) => {
- print_markdown(app);
- }
- None => {
- if util == "--help" || util == "-h" {
- usage(&utils, binary_as_util);
- process::exit(0);
- } else {
- not_found(&util_os);
- }
- }
- }
- } else {
- // no arguments provided
- usage(&utils, binary_as_util);
- process::exit(0);
}
}
-fn print_markdown(app: &App) {
- for arg in app.get_arguments() {}
+fn write_markdown(mut w: impl Write, app: &mut App) {
+ write_summary(&mut w, app);
+ write_options(&mut w, app);
+}
+
+fn write_summary(w: &mut impl Write, app: &App) {
+ if let Some(about) = app.get_long_about().or_else(|| app.get_about()) {
+ let _ = writeln!(w, "Summary ");
+ let _ = writeln!(w, "{}", about);
+ }
+}
+
+fn write_options(w: &mut impl Write, app: &App) {
+ let _ = writeln!(w, "Options ");
+ let _ = write!(w, "");
+ for arg in app.get_arguments() {
+ let _ = write!(w, "");
+ let mut first = true;
+ for l in arg.get_long_and_visible_aliases().unwrap_or_default() {
+ if !first {
+ let _ = write!(w, ", ");
+ } else {
+ first = false;
+ }
+ let _ = write!(w, "--{}", l);
+ }
+ for l in arg.get_short_and_visible_aliases().unwrap_or_default() {
+ if !first {
+ let _ = write!(w, ", ");
+ } else {
+ first = false;
+ }
+ let _ = write!(w, "-{}", l);
+ }
+ let _ = writeln!(w, " ");
+
+ let _ = writeln!(w, "{} ", arg.get_help().unwrap_or_default());
+ }
+ let _ = writeln!(w, " ");
}