Extract scarb-ui crate

commit-id:d43533b4

Author: mkaput

Cargo.lock

@@ -8,6 +8,7 @@ members = [
     "utils/create-output-dir",
     "utils/scarb-build-metadata",
     "utils/scarb-test-support",
+    "utils/scarb-ui",
     "utils/test-for-each-example",
     "xtask",
 ]

Cargo.toml

@@ -27,7 +27,6 @@ cairo-lang-utils.workspace = true
 camino.workspace = true
 clap-verbosity-flag.workspace = true
 clap.workspace = true
-console.workspace = true
 create-output-dir = { path = "../utils/create-output-dir" }
 data-encoding.workspace = true
 deno_task_shell.workspace = true
@@ -41,14 +40,14 @@ gix.workspace = true
 glob.workspace = true
 ignore.workspace = true
 include_dir.workspace = true
-indicatif.workspace = true
 indoc.workspace = true
 itertools.workspace = true
 once_cell.workspace = true
 pathdiff.workspace = true
 petgraph.workspace = true
 scarb-build-metadata = { path = "../utils/scarb-build-metadata" }
 scarb-metadata = { path = "../scarb-metadata", default-features = false, features = ["builder", "packages_filter"] }
+scarb-ui = { path = "../utils/scarb-ui" }
 semver.workspace = true
 serde-value.workspace = true
 serde.workspace = true

scarb/Cargo.toml

@@ -15,10 +15,9 @@ use tracing_log::AsTrace;
 use scarb::compiler::Profile;
 use scarb::core::PackageName;
 use scarb::manifest_editor::DepId;
-use scarb::ui;
-use scarb::ui::OutputFormat;
 use scarb::version;
 use scarb_metadata::packages_filter::PackagesFilter;
+use scarb_ui::OutputFormat;
 
 /// The Cairo package manager.
 #[derive(Parser, Clone, Debug)]
@@ -86,15 +85,15 @@ impl ScarbArgs {
         }
     }
 
-    /// Get [`ui::Verbosity`] out of this arguments.
-    pub fn ui_verbosity(&self) -> ui::Verbosity {
+    /// Get [`ui::Verbosity`] out of these arguments.
+    pub fn ui_verbosity(&self) -> scarb_ui::Verbosity {
         let filter = self.verbose.log_level_filter().as_trace();
         if filter >= LevelFilter::WARN {
-            ui::Verbosity::Verbose
+            scarb_ui::Verbosity::Verbose
         } else if filter > LevelFilter::OFF {
-            ui::Verbosity::Normal
+            scarb_ui::Verbosity::Normal
         } else {
-            ui::Verbosity::Quiet
+            scarb_ui::Verbosity::Quiet
         }
     }
 

scarb/src/bin/scarb/args.rs

@@ -1,6 +1,7 @@
 use anyhow::{Ok, Result};
 
-use scarb::{core::Config, ui::ValueMessage};
+use scarb::core::Config;
+use scarb_ui::ValueMessage;
 
 #[tracing::instrument(skip_all, level = "info")]
 pub fn run(config: &Config) -> Result<()> {

scarb/src/bin/scarb/commands/cache_path.rs

@@ -1,14 +1,16 @@
-use anyhow::Result;
-use serde::{Serialize, Serializer};
 use std::collections::BTreeMap;
 use std::path::PathBuf;
 use std::{env, fmt, fs};
 
-use crate::args::ScarbArgs;
+use anyhow::Result;
+use serde::{Serialize, Serializer};
+
 use scarb::core::Config;
 use scarb::process::is_executable;
-use scarb::ui::Message;
 use scarb::EXTERNAL_CMD_PREFIX;
+use scarb_ui::Message;
+
+use crate::args::ScarbArgs;
 
 #[derive(PartialEq, Eq, PartialOrd, Ord, Debug, Serialize)]
 enum CommandInfo {
@@ -100,15 +102,18 @@ pub fn run(config: &Config) -> Result<()> {
 
 #[cfg(test)]
 mod tests {
-    use super::{list_commands, CommandInfo};
+    use std::collections::BTreeMap;
+    use std::env;
+    use std::path::PathBuf;
+
     use assert_fs::prelude::*;
     use assert_fs::TempDir;
     use camino::Utf8Path;
+
     use scarb::core::Config;
     use scarb::process::make_executable;
-    use std::collections::BTreeMap;
-    use std::env;
-    use std::path::PathBuf;
+
+    use super::{list_commands, CommandInfo};
 
     #[test]
     fn cmd_list() {

scarb/src/bin/scarb/commands/commands.rs

@@ -1,7 +1,7 @@
 use anyhow::Result;
 
 use scarb::core::Config;
-use scarb::ui::ValueMessage;
+use scarb_ui::ValueMessage;
 
 #[tracing::instrument(skip_all, level = "info")]
 pub fn run(config: &Config) -> Result<()> {

scarb/src/bin/scarb/commands/manifest_path.rs

@@ -2,7 +2,7 @@ use anyhow::Result;
 
 use scarb::core::Config;
 use scarb::ops;
-use scarb::ui::MachineMessage;
+use scarb_ui::MachineMessage;
 
 use crate::args::MetadataArgs;
 

scarb/src/bin/scarb/commands/metadata.rs

@@ -10,7 +10,7 @@ use smol_str::SmolStr;
 use scarb::core::errors::ScriptExecutionError;
 use scarb::core::{Config, Package, Workspace};
 use scarb::ops;
-use scarb::ui::Message;
+use scarb_ui::Message;
 
 use crate::args::ScriptsRunnerArgs;
 use crate::errors::ErrorWithExitCode;

scarb/src/bin/scarb/commands/run.rs

@@ -10,7 +10,7 @@ use args::ScarbArgs;
 use scarb::core::errors::ScriptExecutionError;
 use scarb::core::Config;
 use scarb::ops;
-use scarb::ui::Ui;
+use scarb_ui::Ui;
 
 use crate::errors::ErrorWithExitCode;
 

scarb/src/bin/scarb/main.rs

@@ -6,9 +6,10 @@ use cairo_lang_compiler::CompilerConfig;
 use cairo_lang_filesystem::db::FilesGroup;
 use cairo_lang_filesystem::ids::{CrateId, CrateLongId};
 
+use scarb_ui::TypedMessage;
+
 use crate::compiler::CompilationUnit;
 use crate::core::Workspace;
-use crate::ui::TypedMessage;
 
 pub fn build_compiler_config<'c>(unit: &CompilationUnit, ws: &Workspace<'c>) -> CompilerConfig<'c> {
     CompilerConfig {

scarb/src/compiler/helpers.rs

@@ -11,14 +11,15 @@ use tokio::runtime::{Builder, Handle, Runtime};
 use tracing::trace;
 use which::which_in;
 
+use scarb_ui::{OutputFormat, Ui, Verbosity};
+
 use crate::compiler::plugin::CairoPluginRepository;
 use crate::compiler::{CompilerRepository, Profile};
 use crate::core::AppDirs;
 #[cfg(doc)]
 use crate::core::Workspace;
 use crate::flock::{AdvisoryLock, RootFilesystem};
 use crate::internal::fsx;
-use crate::ui::{OutputFormat, Ui, Verbosity};
 use crate::DEFAULT_TARGET_DIR_NAME;
 use crate::SCARB_ENV;
 

scarb/src/core/config.rs

@@ -8,10 +8,11 @@ use camino::{Utf8Path, Utf8PathBuf};
 use fs4::{lock_contended_error, FileExt};
 use tokio::sync::Mutex;
 
+use scarb_ui::Status;
+
 use crate::core::Config;
 use crate::internal::fsx;
 use crate::internal::lazy_directory_creator::LazyDirectoryCreator;
-use crate::ui::Status;
 
 const OK_FILE: &str = ".scarb-ok";
 

scarb/src/flock.rs

@@ -6,6 +6,8 @@
 #![deny(rustdoc::private_intra_doc_links)]
 #![warn(rust_2018_idioms)]
 
+pub use subcommands::EXTERNAL_CMD_PREFIX;
+
 pub mod compiler;
 pub mod core;
 pub mod flock;
@@ -16,12 +18,9 @@ pub mod process;
 mod resolver;
 mod sources;
 mod subcommands;
-pub mod ui;
 pub mod version;
 
 pub const SCARB_ENV: &str = "SCARB";
 pub const MANIFEST_FILE_NAME: &str = "Scarb.toml";
 pub const DEFAULT_SOURCE_PATH: &str = "src/lib.cairo";
 pub const DEFAULT_TARGET_DIR_NAME: &str = "target";
-
-pub use subcommands::EXTERNAL_CMD_PREFIX;

scarb/src/lib.rs

@@ -1,8 +1,9 @@
 use anyhow::{anyhow, Result};
 use toml_edit::Document;
 
+use scarb_ui::Status;
+
 use crate::core::PackageName;
-use crate::ui::Status;
 
 use super::tomlx::get_table_mut;
 use super::{Op, OpCtx};

scarb/src/manifest_editor/remove.rs

@@ -1,13 +1,14 @@
 use anyhow::{anyhow, Result};
 use cairo_lang_compiler::diagnostics::DiagnosticsError;
-use indicatif::HumanDuration;
 use indoc::formatdoc;
 
+use scarb_ui::HumanDuration;
+use scarb_ui::Status;
+
 use crate::compiler::db::{build_scarb_root_database, has_starknet_plugin};
 use crate::compiler::CompilationUnit;
 use crate::core::{PackageId, Utf8PathWorkspaceExt, Workspace};
 use crate::ops;
-use crate::ui::Status;
 
 #[tracing::instrument(skip_all, level = "debug")]
 pub fn compile(packages: Vec<PackageId>, ws: &Workspace<'_>) -> Result<()> {

scarb/src/ops/compile.rs

@@ -1,10 +1,11 @@
+use std::fmt::Display;
+use std::path::{Path, PathBuf};
+use std::sync::atomic::{AtomicBool, Ordering};
+
 use anyhow::Result;
 use cairo_lang_formatter::{CairoFormatter, FormatOutcome, FormatterConfig};
 use ignore::WalkState::{Continue, Skip};
 use ignore::{DirEntry, Error, ParallelVisitor, ParallelVisitorBuilder, WalkState};
-use std::fmt::Display;
-use std::path::{Path, PathBuf};
-use std::sync::atomic::{AtomicBool, Ordering};
 use tracing::{info, warn};
 
 use crate::core::workspace::Workspace;
@@ -19,7 +20,7 @@ pub struct FmtOptions {
 
 #[tracing::instrument(skip_all, level = "debug")]
 pub fn format(opts: FmtOptions, ws: &Workspace<'_>) -> Result<bool> {
-    console::set_colors_enabled(opts.color);
+    ws.config().ui().force_colors_enabled(opts.color);
     let config = FormatterConfig::default();
     let fmt = CairoFormatter::new(config);
     let packages = ws

scarb/src/ops/fmt.rs

@@ -7,11 +7,12 @@ use std::process::Command;
 use anyhow::{bail, Result};
 use tracing::debug;
 
+use scarb_ui::Status;
+
 use crate::core::{Config, Package, Workspace};
 use crate::ops;
 use crate::process::{exec_replace, is_executable};
 use crate::subcommands::{get_env_vars, EXTERNAL_CMD_PREFIX, SCARB_MANIFEST_PATH_ENV};
-use crate::ui::Status;
 
 #[tracing::instrument(level = "debug", skip(config))]
 pub fn execute_external_subcommand(

scarb/src/ops/subcommands.rs

@@ -8,8 +8,9 @@ use std::{fmt, thread};
 use anyhow::{anyhow, bail, Context, Result};
 use tracing::{debug, debug_span, warn, Span};
 
+use scarb_ui::{Spinner, Status};
+
 use crate::core::Config;
-use crate::ui::{Spinner, Status};
 
 // TODO(#125): Do what is documented here, take a look at what cargo-util does.
 /// Replaces the current process with the target process.

scarb/src/process.rs

@@ -13,10 +13,11 @@ use std::process::Command;
 use anyhow::{anyhow, bail, Context, Result};
 use camino::Utf8PathBuf;
 
+use scarb_ui::Verbosity;
+
 use crate::core::{Config, GitReference};
 use crate::flock::Filesystem;
 use crate::process::exec;
-use crate::ui::Verbosity;
 
 use super::canonical_url::CanonicalUrl;
 

scarb/src/sources/git/client.rs

@@ -8,13 +8,13 @@ use url::Url;
 
 use canonical_url::CanonicalUrl;
 use client::{GitRemote, Rev};
+use scarb_ui::Status;
 
 use crate::core::source::Source;
 use crate::core::{
     Config, GitReference, ManifestDependency, Package, PackageId, SourceId, Summary,
 };
 use crate::sources::git::client::GitDatabase;
-use crate::ui::Status;
 
 use super::PathSource;
 

scarb/src/sources/git/mod.rs

@@ -14,6 +14,7 @@ itertools.workspace = true
 once_cell.workspace = true
 scarb = { path = "../../scarb" }
 scarb-build-metadata = { path = "../scarb-build-metadata" }
+scarb-ui = { path = "../scarb-ui" }
 semver.workspace = true
 serde.workspace = true
 serde_json.workspace = true

utils/scarb-test-support/Cargo.toml

@@ -12,7 +12,7 @@ use snapbox::cmd::Command as SnapboxCommand;
 
 use crate::cargo::cargo_bin;
 use scarb::core::Config;
-use scarb::ui::Verbosity;
+use scarb_ui::Verbosity;
 
 use crate::fsx::{AssertFsUtf8Ext, PathUtf8Ext};