Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/en1-gma/what-the-fork
https://github.com/en1-gma/what-the-fork
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/en1-gma/what-the-fork
- Owner: en1-gma
- License: isc
- Created: 2024-02-27T15:18:35.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-03-02T23:54:03.000Z (11 months ago)
- Last Synced: 2024-12-10T12:11:51.746Z (2 months ago)
- Language: JavaScript
- Size: 24.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# What The Fork
What The Fork is an npm package designed to provide comprehensive statistics based on git repositories. Whether you're interested in commit history, lines of code, or other metrics, What The Fork makes it easy to gather and analyze this data.
## Installation
You can install What The Fork via npm:
```bash
npm install -g what-the-fork@latest
OR
npm install what-the-fork@latest
```
## Usage
To utilize What The Fork globally, simply run the following command in your terminal:
```bash
npx what-the-fork
```
Or via custom command defined inside package.json:
```json
{
"scripts": {
"furck": "what-the-fork"
// Other scripts
}
}
```
And then just
```bash
npm furck
```
Set the wtf.config.js file in your root to ignore some files and/or folders and enhance the behaviours:
```js
module.exports = {
ignore: [
'.git',
'.gitignore',
'.npmrc',
'.vscode',
'LICENSE',
'node_modules',
'package-lock.json',
'README.md',
],
threhsoldTollerance: 10, // Expressed as percentage to enhance "globally" ± the tollerance of the provided threshold.
highlights: [
{
domain: 'gmail.com' // The email's domain you want to analyze.
threhsoldTollerance: 12, // Expressed as percentage, overrides the previous one.
threshold: 60, // Expressed as percentage.
}
],
};
// OR
export default {
ignore: [
'.git',
'.gitignore',
'.npmrc',
'.vscode',
'LICENSE',
'node_modules',
'package-lock.json',
'README.md',
],
threhsoldTollerance: 10, // Expressed as percentage to enhance "globally" ± the tollerance of the provided threshold.
highlights: [
{
domain: 'gmail.com' // The email's domain you want to analyze.
threhsoldTollerance: 12, // Expressed as percentage, overrides the previous one.
threshold: 60, // Expressed as percentage.
}
],
};
```
This will generate a detailed report containing statistics such as:
- Total number of commits
- Number of contributors
- Total lines of project
- Lines of code added/removed
- % Statitiscs
- Some fancy warnings