Add checks for some common directories

[richardscollin]

It might be interesting to see how many projects follow the conventions defined here: https://doc.rust-lang.org/cargo/guide/project-layout.html

It would just consist of checking if the repo has the following directories:

• examples/
• src/bin/
• benches/
• tests/

I'm open implementing this, I just don't know how you'd want the information displayed. It's own report page, multiple statistics pages, or maybe both.

[szabgab]

Great idea.

Maybe there could be counters of number of test files in the tests/ folders, or and later number of tests?
Same with the examples and benches. I am not sure about the binaries.

Questions that need to be sorted out at one point:
What would be the case for projects that are in monorepos where the are several crates?
What about projects that don't even have a Cargo.toml in the root? (e.g. one that has implementations in several languages and the crate is in some subfolder?

As for display, I think there could be lists of crates with 0 tests. lists of crates with 0 benches etc.

In any case I'd suggest small PRs as it would be difficult for me to review big ones 😄

[szabgab]

Now that we are also downloading all the released crates from https://crates.io/ I think this should be first implemented for those folders.

We only have repositories for some of the projects and the repository layout can be more complex as some repos include implementations in multiple languages and in some repos we might have several crates. On the other hand we can have all the released crates downloaded and unzipped.

[richardscollin]

That's a good point. There's also a chance that some of those files exist in the project repo, but were explicitly excluded in the crate. See this recent discussion: https://users.rust-lang.org/t/psa-check-if-your-cargo-crates-are-clean-and-tagged/109264

I've actually gotten more interested in looking into the cargo-goggles crate. The main feature I'm interested in (checking if crates match their repos) which is a bit further along there.

Another tricky thing to consider is projects which make use of workspaces. A good example is serde. The github repo contains both serde and serde_derive. You'd have to search for all the Cargo.toml in the repo and find the right one. We can try to infer from the package name in those cargo.toml files

Another interesting idea would be having a pie chart for the major git forges you have here https://rust-digger.code-maven.com/vcs/ would be cool. Charts.js produces good quality charts and is easy to integrate.

[szabgab]

I like charts, but I think I'd prefer some solution in Rust that would generate the chart in the back-end. That would also push that part of the Rust ecosystem.