Skip to content

Commit

Permalink
Address PR feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
charliermarsh committed Sep 26, 2024
1 parent f76e93f commit 087ebc4
Show file tree
Hide file tree
Showing 11 changed files with 206 additions and 201 deletions.
3 changes: 0 additions & 3 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions crates/uv-cli/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use url::Url;
use uv_cache::CacheArgs;
use uv_configuration::{
ConfigSettingEntry, ExportFormat, IndexStrategy, KeyringProviderType, PackageNameSpecifier,
TargetTriple, TrustedHost, TrustedPublishing, VersionControl,
TargetTriple, TrustedHost, TrustedPublishing, VersionControlSystem,
};
use uv_normalize::{ExtraName, PackageName};
use uv_python::{PythonDownloads, PythonPreference, PythonVersion};
Expand Down Expand Up @@ -2373,12 +2373,12 @@ pub struct InitArgs {
#[arg(long, alias="script", conflicts_with_all=["app", "lib", "package"])]
pub r#script: bool,

/// Initialize a new repository for the given version control system.
/// Initialize a version control system for the project.
///
/// By default, uv will try to initialize a Git repository (`git`).
/// Use `none` to skip repository initialization.
#[arg(long, value_enum)]
pub vcs: Option<VersionControl>,
/// By default, uv will initialize a Git repository (`git`). Use `--vcs none` to explicitly
/// avoid initializing a version control system.
#[arg(long, value_enum, conflicts_with = "script")]
pub vcs: Option<VersionControlSystem>,

/// Do not create a `README.md` file.
#[arg(long)]
Expand Down
4 changes: 0 additions & 4 deletions crates/uv-configuration/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,11 @@ pypi-types = { workspace = true }
uv-auth = { workspace = true }
uv-cache = { workspace = true }
uv-cache-info = { workspace = true }
uv-fs = { workspace = true }
uv-normalize = { workspace = true }
uv-warnings = { workspace = true }

anyhow = { workspace = true }
clap = { workspace = true, features = ["derive"], optional = true }
either = { workspace = true }
fs-err = { workspace = true }
indoc = { workspace = true }
rustc-hash = { workspace = true }
schemars = { workspace = true, optional = true }
serde = { workspace = true }
Expand Down
4 changes: 2 additions & 2 deletions crates/uv-configuration/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pub use sources::*;
pub use target_triple::*;
pub use trusted_host::*;
pub use trusted_publishing::*;
pub use vcs_options::*;
pub use vcs::*;

mod authentication;
mod build_options;
Expand All @@ -38,4 +38,4 @@ mod sources;
mod target_triple;
mod trusted_host;
mod trusted_publishing;
mod vcs_options;
mod vcs;
120 changes: 120 additions & 0 deletions crates/uv-configuration/src/vcs.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
use std::io::Write;
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};

use serde::Deserialize;
use tracing::debug;

#[derive(Debug, thiserror::Error)]
pub enum VersionControlError {
#[error("Attempted to initialize a Git repository, but `git` was not found in PATH")]
GitNotInstalled,
#[error("Failed to initialize Git repository at `{0}`\nstdout: {1}\nstderr: {2}")]
GitInit(PathBuf, String, String),
#[error("`git` command failed")]
GitCommand(#[source] std::io::Error),
#[error(transparent)]
Io(#[from] std::io::Error),
}

/// The version control system to use.
#[derive(Clone, Copy, Debug, PartialEq, Default, Deserialize)]
#[serde(deny_unknown_fields, rename_all = "kebab-case")]
#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
pub enum VersionControlSystem {
/// Use Git for version control.
#[default]
Git,
/// Do not use any version control system.
None,
}

impl VersionControlSystem {
/// Initializes the VCS system based on the provided path.
pub fn init(&self, path: &Path) -> Result<(), VersionControlError> {
match self {
Self::Git => {
let Ok(git) = which::which("git") else {
return Err(VersionControlError::GitNotInstalled);
};

if path.join(".git").try_exists()? {
debug!("Git repository already exists at: `{}`", path.display());
} else {
let output = Command::new(git)
.arg("init")
.current_dir(path)
.stdout(Stdio::piped())
.stderr(Stdio::piped())
.output()
.map_err(VersionControlError::GitCommand)?;
if !output.status.success() {
let stdout = String::from_utf8_lossy(&output.stdout);
let stderr = String::from_utf8_lossy(&output.stderr);
return Err(VersionControlError::GitInit(
path.to_path_buf(),
stdout.to_string(),
stderr.to_string(),
));
}
}

// Create the `.gitignore`, if it doesn't exist.
match fs_err::OpenOptions::new()
.write(true)
.create_new(true)
.open(path.join(".gitignore"))
{
Ok(mut file) => file.write_all(GITIGNORE.as_bytes())?,
Err(err) if err.kind() == std::io::ErrorKind::AlreadyExists => (),
Err(err) => return Err(err.into()),
}

Ok(())
}
Self::None => Ok(()),
}
}

/// Detects the VCS system based on the provided path.
pub fn detect(path: &Path) -> Option<Self> {
// Determine whether the path is inside a Git work tree.
if which::which("git").is_ok_and(|git| {
Command::new(git)
.arg("rev-parse")
.arg("--is-inside-work-tree")
.current_dir(path)
.stdout(Stdio::null())
.stderr(Stdio::null())
.status()
.map(|status| status.success())
.unwrap_or(false)
}) {
return Some(Self::Git);
}

None
}
}

impl std::fmt::Display for VersionControlSystem {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::Git => write!(f, "git"),
Self::None => write!(f, "none"),
}
}
}

const GITIGNORE: &str = "# Python-generated files
__pycache__/
*.py[oc]
build/
dist/
wheels/
*.egg-info
# Virtual environments
.venv
";
123 changes: 0 additions & 123 deletions crates/uv-configuration/src/vcs_options.rs

This file was deleted.

Loading

0 comments on commit 087ebc4

Please sign in to comment.