1 use crate::{t, VERSION};
2 use std::fmt::Write as _;
3 use std::path::{Path, PathBuf};
4 use std::process::Command;
11 #[derive(Clone, Copy, Eq, PartialEq)]
21 fn include_path(&self, src_path: &Path) -> PathBuf {
22 PathBuf::from(format!("{}/src/bootstrap/defaults/config.{}.toml", src_path.display(), self))
25 pub fn all() -> impl Iterator<Item = Self> {
27 // N.B. these are ordered by how they are displayed, not alphabetically
28 [Library, Compiler, Codegen, Tools, User].iter().copied()
31 pub fn purpose(&self) -> String {
34 Library => "Contribute to the standard library",
35 Compiler => "Contribute to the compiler itself",
36 Codegen => "Contribute to the compiler, and also modify LLVM or codegen",
37 Tools => "Contribute to tools which depend on the compiler, but do not modify it directly (e.g. rustdoc, clippy, miri)",
38 User => "Install Rust from source",
43 pub fn all_for_help(indent: &str) -> String {
44 let mut out = String::new();
45 for choice in Profile::all() {
46 writeln!(&mut out, "{}{}: {}", indent, choice, choice.purpose()).unwrap();
52 impl FromStr for Profile {
55 fn from_str(s: &str) -> Result<Self, Self::Err> {
57 "lib" | "library" => Ok(Profile::Library),
58 "compiler" => Ok(Profile::Compiler),
59 "llvm" | "codegen" => Ok(Profile::Codegen),
60 "maintainer" | "user" => Ok(Profile::User),
61 "tools" | "tool" | "rustdoc" | "clippy" | "miri" | "rustfmt" | "rls" => {
64 _ => Err(format!("unknown profile: '{}'", s)),
69 impl fmt::Display for Profile {
70 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
72 Profile::Compiler => write!(f, "compiler"),
73 Profile::Codegen => write!(f, "codegen"),
74 Profile::Library => write!(f, "library"),
75 Profile::User => write!(f, "user"),
76 Profile::Tools => write!(f, "tools"),
81 pub fn setup(src_path: &Path, profile: Profile) {
82 let cfg_file = env::var_os("BOOTSTRAP_CONFIG").map(PathBuf::from);
84 if cfg_file.as_ref().map_or(false, |f| f.exists()) {
85 let file = cfg_file.unwrap();
87 "error: you asked `x.py` to setup a new config file, but one already exists at `{}`",
90 println!("help: try adding `profile = \"{}\"` at the top of {}", profile, file.display());
92 "note: this will use the configuration in {}",
93 profile.include_path(src_path).display()
95 std::process::exit(1);
98 let path = cfg_file.unwrap_or_else(|| "config.toml".into());
99 let settings = format!(
100 "# Includes one of the default files in src/bootstrap/defaults\n\
102 changelog-seen = {}\n",
105 t!(fs::write(path, settings));
107 let include_path = profile.include_path(src_path);
108 println!("`x.py` will now use the configuration at {}", include_path.display());
110 let suggestions = match profile {
111 Profile::Codegen | Profile::Compiler => &["check", "build", "test"][..],
115 "test src/test/rustdoc*",
116 "test src/tools/clippy",
117 "test src/tools/miri",
118 "test src/tools/rustfmt",
120 Profile::Library => &["check", "build", "test library/std", "doc"],
121 Profile::User => &["dist", "build"],
126 t!(install_git_hook_maybe(src_path));
130 println!("To get started, try one of the following commands:");
131 for cmd in suggestions {
132 println!("- `x.py {}`", cmd);
135 if profile != Profile::User {
137 "For more suggestions, see https://rustc-dev-guide.rust-lang.org/building/suggested.html"
142 // Used to get the path for `Subcommand::Setup`
143 pub fn interactive_path() -> io::Result<Profile> {
144 fn abbrev_all() -> impl Iterator<Item = ((String, String), Profile)> {
147 .map(|(letter, number)| (letter.to_string(), number.to_string()))
151 fn parse_with_abbrev(input: &str) -> Result<Profile, String> {
152 let input = input.trim().to_lowercase();
153 for ((letter, number), profile) in abbrev_all() {
154 if input == letter || input == number {
161 println!("Welcome to the Rust project! What do you want to do with x.py?");
162 for ((letter, _), profile) in abbrev_all() {
163 println!("{}) {}: {}", letter, profile, profile.purpose());
165 let template = loop {
167 "Please choose one ({}): ",
168 abbrev_all().map(|((l, _), _)| l).collect::<Vec<_>>().join("/")
170 io::stdout().flush()?;
171 let mut input = String::new();
172 io::stdin().read_line(&mut input)?;
173 if input.is_empty() {
174 eprintln!("EOF on stdin, when expecting answer to question. Giving up.");
175 std::process::exit(1);
177 break match parse_with_abbrev(&input) {
178 Ok(profile) => profile,
180 println!("error: {}", err);
181 println!("note: press Ctrl+C to exit");
189 // install a git hook to automatically run tidy --bless, if they want
190 fn install_git_hook_maybe(src_path: &Path) -> io::Result<()> {
191 let mut input = String::new();
193 "Rust's CI will automatically fail if it doesn't pass `tidy`, the internal tool for ensuring code quality.
194 If you'd like, x.py can install a git hook for you that will automatically run `tidy --bless` on each commit
195 to ensure your code is up to par. If you decide later that this behavior is undesirable,
196 simply delete the `pre-commit` file from .git/hooks."
199 let should_install = loop {
200 print!("Would you like to install the git hook?: [y/N] ");
201 io::stdout().flush()?;
203 io::stdin().read_line(&mut input)?;
204 break match input.trim().to_lowercase().as_str() {
206 "n" | "no" | "" => false,
208 println!("error: unrecognized option '{}'", input.trim());
209 println!("note: press Ctrl+C to exit");
216 let src = src_path.join("src").join("etc").join("pre-commit.sh");
217 let git = t!(Command::new("git").args(&["rev-parse", "--git-common-dir"]).output().map(
219 assert!(output.status.success(), "failed to run `git`");
220 PathBuf::from(t!(String::from_utf8(output.stdout)).trim())
223 let dst = git.join("hooks").join("pre-commit");
224 match fs::hard_link(src, &dst) {
226 "error: could not create hook {}: do you already have the git hook installed?\n{}",
230 Ok(_) => println!("Linked `src/etc/pre-commit.sh` to `.git/hooks/pre-commit`"),
233 println!("Ok, skipping installation!");