Address PR feedback

crates/uv-cli/src/lib.rs

@@ -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};
@@ -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)]

crates/uv-configuration/Cargo.toml

@@ -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 }

crates/uv-configuration/src/lib.rs

@@ -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;
@@ -38,4 +38,4 @@ mod sources;
 mod target_triple;
 mod trusted_host;
 mod trusted_publishing;
-mod vcs_options;
+mod vcs;

crates/uv-configuration/src/vcs.rs

@@ -0,0 +1,272 @@
+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("`git` is not installed")]
+ 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 = "# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+# For a library or package, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+# However, in case of collaboration, if having platform-specific dependencies or dependencies
+# having no cross-platform support, pipenv may install dependencies that don't work, or not
+# install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+# This is especially recommended for binary packages to ensure reproducibility, and is more
+# commonly ignored for libraries.
+# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+# in version control.
+# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+# and can be added to the global gitignore or merged into this file. For a more nuclear
+# option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+";