1 // Copyright 2015-2016 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 // Inspired by Paul Woolcock's cargo-fmt (https://github.com/pwoolcoc/cargo-fmt/)
16 extern crate cargo_metadata;
18 extern crate serde_json as json;
22 use std::hash::{Hash, Hasher};
23 use std::io::{self, Write};
24 use std::path::{Path, PathBuf};
25 use std::process::{Command, ExitStatus};
27 use std::collections::HashSet;
28 use std::iter::FromIterator;
30 use getopts::{Matches, Options};
33 let exit_status = execute();
34 std::io::stdout().flush().unwrap();
35 std::process::exit(exit_status);
42 let mut opts = getopts::Options::new();
43 opts.optflag("h", "help", "show this message");
44 opts.optflag("q", "quiet", "no output printed to stdout");
45 opts.optflag("v", "verbose", "use verbose output");
49 "specify package to format (only usable in workspaces)",
52 opts.optflag("", "all", "format all packages (only usable in workspaces)");
54 // If there is any invalid argument passed to `cargo fmt`, return without formatting.
55 let mut is_package_arg = false;
56 for arg in env::args().skip(2).take_while(|a| a != "--") {
57 if arg.starts_with("-") {
58 is_package_arg = arg.starts_with("--package");
59 } else if !is_package_arg {
60 print_usage_to_stderr(&opts, &format!("Invalid argument: `{}`.", arg));
63 is_package_arg = false;
67 let matches = match opts.parse(env::args().skip(1).take_while(|a| a != "--")) {
70 print_usage_to_stderr(&opts, &e.to_string());
75 let verbosity = match (matches.opt_present("v"), matches.opt_present("q")) {
76 (false, false) => Verbosity::Normal,
77 (false, true) => Verbosity::Quiet,
78 (true, false) => Verbosity::Verbose,
80 print_usage_to_stderr(&opts, "quiet mode and verbose mode are not compatible");
85 if matches.opt_present("h") {
86 print_usage_to_stdout(&opts, "");
90 let strategy = CargoFmtStrategy::from_matches(&matches);
92 match format_crate(verbosity, &strategy) {
94 print_usage_to_stderr(&opts, &e.to_string());
101 status.code().unwrap_or(failure)
107 macro_rules! print_usage {
108 ($print:ident, $opts:ident, $reason:expr) => ({
109 let msg = format!("{}\nusage: cargo fmt [options]", $reason);
111 "{}\nThis utility formats all bin and lib files of the current crate using rustfmt. \
112 Arguments after `--` are passed to rustfmt.",
118 fn print_usage_to_stdout(opts: &Options, reason: &str) {
119 print_usage!(println, opts, reason);
122 fn print_usage_to_stderr(opts: &Options, reason: &str) {
123 print_usage!(eprintln, opts, reason);
126 #[derive(Debug, Clone, Copy, PartialEq)]
134 verbosity: Verbosity,
135 strategy: &CargoFmtStrategy,
136 ) -> Result<ExitStatus, io::Error> {
137 let rustfmt_args = get_fmt_args();
138 let targets = if rustfmt_args.iter().any(|s| s == "--dump-default-config") {
141 get_targets(strategy)?
144 // Currently only bin and lib files get formatted
145 let files: Vec<_> = targets
148 if verbosity == Verbosity::Verbose {
149 println!("[{}] {:?}", t.kind, t.path)
155 format_files(&files, &rustfmt_args, verbosity)
158 fn get_fmt_args() -> Vec<String> {
159 // All arguments after -- are passed to rustfmt
160 env::args().skip_while(|a| a != "--").skip(1).collect()
163 /// Target uses a `path` field for equality and hashing.
166 /// A path to the main source file of the target.
168 /// A kind of target (e.g. lib, bin, example, ...).
173 pub fn from_target(target: &cargo_metadata::Target) -> Self {
174 let path = PathBuf::from(&target.src_path);
175 let canonicalized = fs::canonicalize(&path).unwrap_or(path);
179 kind: target.kind[0].clone(),
184 impl PartialEq for Target {
185 fn eq(&self, other: &Target) -> bool {
186 self.path == other.path
190 impl Eq for Target {}
192 impl Hash for Target {
193 fn hash<H: Hasher>(&self, state: &mut H) {
194 self.path.hash(state);
198 #[derive(Debug, PartialEq, Eq)]
199 pub enum CargoFmtStrategy {
200 /// Format every packages and dependencies.
202 /// Format pacakges that are specified by the command line argument.
204 /// Format the root packages only.
208 impl CargoFmtStrategy {
209 pub fn from_matches(matches: &Matches) -> CargoFmtStrategy {
210 match (matches.opt_present("all"), matches.opt_present("p")) {
211 (false, false) => CargoFmtStrategy::Root,
212 (true, _) => CargoFmtStrategy::All,
213 (false, true) => CargoFmtStrategy::Some(matches.opt_strs("p")),
218 /// Based on the specified CargoFmtStrategy, returns a set of main source files.
219 fn get_targets(strategy: &CargoFmtStrategy) -> Result<HashSet<Target>, io::Error> {
220 let mut targets = HashSet::new();
223 CargoFmtStrategy::Root => get_targets_root_only(&mut targets)?,
224 CargoFmtStrategy::All => get_targets_recursive(None, &mut targets, &mut HashSet::new())?,
225 CargoFmtStrategy::Some(ref hitlist) => get_targets_with_hitlist(hitlist, &mut targets)?,
228 if targets.is_empty() {
230 io::ErrorKind::Other,
231 format!("Failed to find targets"),
238 fn get_targets_root_only(targets: &mut HashSet<Target>) -> Result<(), io::Error> {
239 let metadata = get_cargo_metadata(None)?;
241 for package in metadata.packages {
242 for target in package.targets {
243 if target.name == package.name {
244 targets.insert(Target::from_target(&target));
252 fn get_targets_recursive(
253 manifest_path: Option<&Path>,
254 mut targets: &mut HashSet<Target>,
255 visited: &mut HashSet<String>,
256 ) -> Result<(), io::Error> {
257 let metadata = get_cargo_metadata(manifest_path)?;
259 for package in metadata.packages {
260 add_targets(&package.targets, &mut targets);
262 // Look for local dependencies.
263 for dependency in package.dependencies {
264 if dependency.source.is_some() || visited.contains(&dependency.name) {
268 let mut manifest_path = PathBuf::from(&package.manifest_path);
271 manifest_path.push(&dependency.name);
272 manifest_path.push("Cargo.toml");
274 if manifest_path.exists() {
275 visited.insert(dependency.name);
276 get_targets_recursive(Some(&manifest_path), &mut targets, visited)?;
284 fn get_targets_with_hitlist(
286 targets: &mut HashSet<Target>,
287 ) -> Result<(), io::Error> {
288 let metadata = get_cargo_metadata(None)?;
290 let mut workspace_hitlist: HashSet<&String> = HashSet::from_iter(hitlist);
292 for package in metadata.packages {
293 for target in package.targets {
294 if workspace_hitlist.remove(&target.name) {
295 targets.insert(Target::from_target(&target));
300 if workspace_hitlist.is_empty() {
303 let package = workspace_hitlist.iter().next().unwrap();
305 io::ErrorKind::InvalidInput,
306 format!("package `{}` is not a member of the workspace", package),
311 fn add_targets(target_paths: &[cargo_metadata::Target], targets: &mut HashSet<Target>) {
312 for target in target_paths {
313 targets.insert(Target::from_target(&target));
320 verbosity: Verbosity,
321 ) -> Result<ExitStatus, io::Error> {
322 let stdout = if verbosity == Verbosity::Quiet {
323 std::process::Stdio::null()
325 std::process::Stdio::inherit()
328 if verbosity == Verbosity::Verbose {
334 print!(" {}", f.display());
339 let mut command = Command::new("rustfmt")
344 .map_err(|e| match e.kind() {
345 io::ErrorKind::NotFound => io::Error::new(
346 io::ErrorKind::Other,
347 "Could not run rustfmt, please make sure it is in your PATH.",
355 fn get_cargo_metadata(manifest_path: Option<&Path>) -> Result<cargo_metadata::Metadata, io::Error> {
356 match cargo_metadata::metadata(manifest_path) {
357 Ok(metadata) => Ok(metadata),
358 Err(..) => Err(io::Error::new(
359 io::ErrorKind::Other,
360 "`cargo manifest` failed.",