cargo-modules 0.26.0

A cargo plugin for showing a tree-like overview of a crate's modules.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

use clap::Parser;

use hir::db::HirDatabase;
use ra_ap_hir::{self as hir};
use ra_ap_ide::{self as ide};
use ra_ap_vfs::{self as vfs};

use crate::analyzer::{self, LoadOptions};

use super::{options::Options, printer::Printer};

use super::scanner::Scanner;

#[derive(Parser, Clone, PartialEq, Eq, Debug)]
pub struct Command {
    #[command(flatten)]
    pub options: Options,
}

impl Command {
    pub fn new(options: Options) -> Self {
        Self { options }
    }

    pub(crate) fn sanitize(&mut self) {}

    #[doc(hidden)]
    pub fn run(
        self,
        krate: hir::Crate,
        db: &ide::RootDatabase,
        vfs: &vfs::Vfs,
        edition: ide::Edition,
    ) -> anyhow::Result<()> {
        let db: &dyn HirDatabase = db;

        tracing::trace!("Building tree ...");

        let crate_name = analyzer::crate_name(krate, db);

        let scanner = Scanner::new(db, vfs, krate, edition);
        let mut orphans = Vec::from_iter(scanner.scan()?);

        orphans.sort_by_cached_key(|orphan| orphan.file_path.clone());

        let mut stdout = std::io::stdout();
        let printer = Printer::new(&self.options);
        printer.fmt(&mut stdout, &orphans[..])?;

        if orphans.is_empty() {
            Ok(())
        } else {
            let count = orphans.len();
            Err(anyhow::anyhow!(
                "Found {count} orphans in crate '{crate_name}'"
            ))
        }
    }

    pub fn load_options(&self) -> LoadOptions {
        LoadOptions {
            cfg_test: self.options.cfg_test,
            sysroot: false,
        }
    }
}