Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.39 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.39 KB
Raw

Metrics

Crate to analyze dependencies. See project's README.

Architecture

Ideally, this would be easily extendable for any languages, but to move fast let's just create the code for rust and then seek to make it more generable and extandable.

Current directory structure at the time of this writing:

  • dependabot. Contains scripts to use dependabot (a useful library to check dependencies of a repo).
  • resources. Contains results of guppy execution for test or to populate the database with some data.
  • src/bin. Contains CLIs to populate the database with test data.
  • src/common. Analysis code relevant for any languages (e.g. querying github.com).
  • src/model. Abstraction around the mongodb database.
  • src/rust. Code that handles parsing and fetching dependencies in different languages or types of file.
  • src/analysis.rs. The main analysis code
  • src/git.rs. Abstraction around the git tool.
  • src/lib.rs. A service component that can be started and receive one request at a time.

Documentation

In the root folder this command will generate and open doc:

make doc

Running without Docker

This will require dependabot

cd dependabot
rbenv install 2.6.6
rbenv global 2.6.6
bundle install