|
| 1 | +#![allow(clippy::disallowed_methods)] |
| 2 | +#![allow(clippy::print_stderr)] |
| 3 | +#![allow(clippy::print_stdout)] |
| 4 | + |
| 5 | +use anyhow::Result; |
| 6 | +use cargo_metadata::{Metadata, MetadataCommand}; |
| 7 | +use clap::{Arg, ArgAction}; |
| 8 | +use semver::Version; |
| 9 | +use std::{ |
| 10 | + env, io, |
| 11 | + path::{Path, PathBuf}, |
| 12 | + process::Command, |
| 13 | +}; |
| 14 | + |
| 15 | +const BIN_NAME: &str = "typos"; |
| 16 | +const PKG_NAME: &str = "typos-cli"; |
| 17 | +const TYPOS_STEP_PREFIX: &str = " uses: crate-ci/typos@v"; |
| 18 | + |
| 19 | +fn main() -> anyhow::Result<()> { |
| 20 | + let cli = cli(); |
| 21 | + exec(&cli.get_matches())?; |
| 22 | + Ok(()) |
| 23 | +} |
| 24 | + |
| 25 | +pub fn cli() -> clap::Command { |
| 26 | + clap::Command::new("xtask-spellcheck") |
| 27 | + .arg( |
| 28 | + Arg::new("color") |
| 29 | + .long("color") |
| 30 | + .help("Coloring: auto, always, never") |
| 31 | + .action(ArgAction::Set) |
| 32 | + .value_name("WHEN") |
| 33 | + .global(true), |
| 34 | + ) |
| 35 | + .arg( |
| 36 | + Arg::new("quiet") |
| 37 | + .long("quiet") |
| 38 | + .short('q') |
| 39 | + .help("Do not print cargo log messages") |
| 40 | + .action(ArgAction::SetTrue) |
| 41 | + .global(true), |
| 42 | + ) |
| 43 | + .arg( |
| 44 | + Arg::new("verbose") |
| 45 | + .long("verbose") |
| 46 | + .short('v') |
| 47 | + .help("Use verbose output (-vv very verbose/build.rs output)") |
| 48 | + .action(ArgAction::Count) |
| 49 | + .global(true), |
| 50 | + ) |
| 51 | + .arg( |
| 52 | + Arg::new("write-changes") |
| 53 | + .long("write-changes") |
| 54 | + .short('w') |
| 55 | + .help("Write fixes out") |
| 56 | + .action(ArgAction::SetTrue) |
| 57 | + .global(true), |
| 58 | + ) |
| 59 | +} |
| 60 | + |
| 61 | +pub fn exec(matches: &clap::ArgMatches) -> Result<()> { |
| 62 | + let mut args = vec![]; |
| 63 | + |
| 64 | + match matches.get_one::<String>("color") { |
| 65 | + Some(c) if matches!(c.as_str(), "auto" | "always" | "never") => { |
| 66 | + args.push("--color"); |
| 67 | + args.push(c); |
| 68 | + } |
| 69 | + Some(c) => { |
| 70 | + anyhow::bail!( |
| 71 | + "argument for --color must be auto, always, or \ |
| 72 | + never, but found `{}`", |
| 73 | + c |
| 74 | + ); |
| 75 | + } |
| 76 | + _ => {} |
| 77 | + } |
| 78 | + |
| 79 | + if matches.get_flag("quiet") { |
| 80 | + args.push("--quiet"); |
| 81 | + } |
| 82 | + |
| 83 | + let verbose_count = matches.get_count("verbose"); |
| 84 | + |
| 85 | + for _ in 0..verbose_count { |
| 86 | + args.push("--verbose"); |
| 87 | + } |
| 88 | + if matches.get_flag("write-changes") { |
| 89 | + args.push("--write-changes"); |
| 90 | + } |
| 91 | + |
| 92 | + let metadata = MetadataCommand::new() |
| 93 | + .exec() |
| 94 | + .expect("cargo_metadata failed"); |
| 95 | + |
| 96 | + let required_version = extract_workflow_typos_version(&metadata)?; |
| 97 | + |
| 98 | + let outdir = metadata |
| 99 | + .build_directory |
| 100 | + .unwrap_or_else(|| metadata.target_directory) |
| 101 | + .as_std_path() |
| 102 | + .join("tmp"); |
| 103 | + let workspace_root = metadata.workspace_root.as_path().as_std_path(); |
| 104 | + let bin_path = crate::ensure_version_or_cargo_install(&outdir, required_version)?; |
| 105 | + |
| 106 | + eprintln!("running {BIN_NAME}"); |
| 107 | + Command::new(bin_path) |
| 108 | + .current_dir(workspace_root) |
| 109 | + .args(args) |
| 110 | + .status()?; |
| 111 | + |
| 112 | + Ok(()) |
| 113 | +} |
| 114 | + |
| 115 | +fn extract_workflow_typos_version(metadata: &Metadata) -> anyhow::Result<Version> { |
| 116 | + let ws_root = metadata.workspace_root.as_path().as_std_path(); |
| 117 | + let workflow_path = ws_root.join(".github").join("workflows").join("main.yml"); |
| 118 | + let file_content = std::fs::read_to_string(workflow_path)?; |
| 119 | + |
| 120 | + if let Some(line) = file_content |
| 121 | + .lines() |
| 122 | + .find(|line| line.contains(TYPOS_STEP_PREFIX)) |
| 123 | + && let Some(stripped) = line.strip_prefix(TYPOS_STEP_PREFIX) |
| 124 | + && let Ok(v) = Version::parse(stripped) |
| 125 | + { |
| 126 | + Ok(v) |
| 127 | + } else { |
| 128 | + Err(anyhow::anyhow!("Could not find typos version in workflow")) |
| 129 | + } |
| 130 | +} |
| 131 | + |
| 132 | +/// If the given executable is installed with the given version, use that, |
| 133 | +/// otherwise install via cargo. |
| 134 | +pub fn ensure_version_or_cargo_install( |
| 135 | + build_dir: &Path, |
| 136 | + required_version: Version, |
| 137 | +) -> io::Result<PathBuf> { |
| 138 | + // Check if the user has a sufficient version already installed |
| 139 | + let bin_path = PathBuf::from(BIN_NAME).with_extension(env::consts::EXE_EXTENSION); |
| 140 | + if let Some(user_version) = get_typos_version(&bin_path) { |
| 141 | + if user_version >= required_version { |
| 142 | + return Ok(bin_path); |
| 143 | + } |
| 144 | + } |
| 145 | + |
| 146 | + let tool_root_dir = build_dir.join("misc-tools"); |
| 147 | + let tool_bin_dir = tool_root_dir.join("bin"); |
| 148 | + let bin_path = tool_bin_dir |
| 149 | + .join(BIN_NAME) |
| 150 | + .with_extension(env::consts::EXE_EXTENSION); |
| 151 | + |
| 152 | + // Check if we have already installed sufficient version |
| 153 | + if let Some(misc_tools_version) = get_typos_version(&bin_path) { |
| 154 | + if misc_tools_version >= required_version { |
| 155 | + return Ok(bin_path); |
| 156 | + } |
| 157 | + } |
| 158 | + |
| 159 | + eprintln!("required `typos` version ({required_version}) not found, building from source"); |
| 160 | + |
| 161 | + let mut cmd = Command::new("cargo"); |
| 162 | + // use --force to ensure that if the required version is bumped, we update it. |
| 163 | + cmd.args(["install", "--locked", "--force", "--quiet"]) |
| 164 | + .arg("--root") |
| 165 | + .arg(&tool_root_dir) |
| 166 | + // use --target-dir to ensure we have a build cache so repeated invocations aren't slow. |
| 167 | + .arg("--target-dir") |
| 168 | + .arg(tool_root_dir.join("target")) |
| 169 | + .arg(format!("{PKG_NAME}@{required_version}")) |
| 170 | + // modify PATH so that cargo doesn't print a warning telling the user to modify the path. |
| 171 | + .env( |
| 172 | + "PATH", |
| 173 | + env::join_paths( |
| 174 | + env::split_paths(&env::var("PATH").unwrap()) |
| 175 | + .chain(std::iter::once(tool_bin_dir.clone())), |
| 176 | + ) |
| 177 | + .expect("build dir contains invalid char"), |
| 178 | + ); |
| 179 | + |
| 180 | + let cargo_exit_code = cmd.spawn()?.wait()?; |
| 181 | + if !cargo_exit_code.success() { |
| 182 | + return Err(io::Error::other("cargo install failed")); |
| 183 | + } |
| 184 | + assert!( |
| 185 | + matches!(bin_path.try_exists(), Ok(true)), |
| 186 | + "cargo install did not produce the expected binary" |
| 187 | + ); |
| 188 | + eprintln!("finished {BIN_NAME}"); |
| 189 | + Ok(bin_path) |
| 190 | +} |
| 191 | + |
| 192 | +fn get_typos_version(bin: &PathBuf) -> Option<Version> { |
| 193 | + // ignore the process exit code here and instead just let the version number check fail |
| 194 | + if let Ok(output) = Command::new(&bin).arg("--version").output() |
| 195 | + && let Ok(s) = String::from_utf8(output.stdout) |
| 196 | + && let Some(version_str) = s.trim().split_whitespace().last() |
| 197 | + { |
| 198 | + Version::parse(version_str).ok() |
| 199 | + } else { |
| 200 | + None |
| 201 | + } |
| 202 | +} |
0 commit comments