Part 1 codebase inherited from Haley Huntington, Sam Dlott, Hamzah Kamel, Paretosha Singh
This project aims to use REST API, GraphQL API, and local repository cloning to get metrics (bus factor, correctness, ramp up, responsive maintainer, license) of how trustworthy different packages and repositories are, and to rate these packages and repositories based off a "net score" using the metrics measured.
./run install
- Installs any dependencies
- Prints number of packages installed in accordance with the Sample I/O files on BrightSpace
- Returns 0 on
EXIT_SUCCESS
./run build
- Transpiles the TypeScript programs
- Returns 0 on
EXIT_SUCCESS
./run URL_FILE
- URL_FILE is the absolute location of a file consisting of an ASCII-encoded newline-delimited set of URLs.
- These URLs may be in the npmjs.com domain (e.g. https://www.npmjs.com/package/even) or come directly from GitHub (e.g. https://github.com/jonschlinkert/even)
- Rates the package from [0, 1] as a weighted sum of package attributes
- Outputs the Packages to Stdout in descending order of Net Score in a new-line delimited JSON format
- Returns 0 on
EXIT_SUCCESS
/run test
- Prints to stdout how many tests cases passed, as well as the line coverage achieved
X/Y test cases passed. Z% line coverage achieved. - Returns 0 on
EXIT_SUCCESS
Determines how easy it will be for a new engineer to get familiar with the package - this was rated based on the number of downloads.
Determines how reliable the package is... this was rated based on how many issues the package has.
This was measured based on the number of contributors.
Determines how "responsive" the package is; this was measured with how many forks there are.
Does the package have a license? If yes, then it will receive a high score. If no... then low.
Measured based on how many dependencies are pinned to a major.minor version
Measure based on how many pull requests with a reviewer's approval have been merged divided by total merged pull requests.
Based on the above metrics, the net score will be their weighted sum on a scale from 0 to 1 inclusive using the following formula:
(0.15 ∗ bF) + (0.2 ∗ L) + (0.2 ∗ C) + (0.15 ∗ rU) + (0.1 ∗ rM) + (0.1 * vP) + (0.05 * eP)= nS
where bF is the bus factor; L is license; C is correctness; rU is ramp up; rM is responsive Maintainer; vP is version pinning; eP is engineering process; and nS is the net score of the package overall.