git-also - GitLite

KO | EN

gitlite — search

#hacktoberfest #golang #go #android #deep-learning #linux #docker #macos #windows #awesome #cli #awesome-list #ios #open-source

git-also

(★ 187)

For a `file` in your git repository, prints other files that are most often committed together

File Explorer

Download Latest Version (.zip)

- demo.gif
- computeSimilarities.js
- startShell.js
.gitignore
git-also.js
git-cograph.js
index.js
LICENSE
package-lock.json
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/anvaka/git-also

Downloads the entire project code from GitHub to your computer.

cd git-also

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Node.js Node.js must be installed to use npm.

npm install -g git-also

Installs the package published on the npm registry globally — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install -g git-also

Installs the package published on the npm registry globally — no need to clone the source.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# git-also

For a `file` in your git repository, prints other files that are most often committed together.

![demo](https://raw.githubusercontent.com/anvaka/git-also/master/docs/demo.gif)

This is a demo of `git-also` applied on three.js library:

```
> src/core/Object3D.js most often committed with:

# together	Similarity	Name
        51	      0.22	src/core/Geometry.js
        48	      0.21	src/renderers/WebGLRenderer.js
        45	      0.19	build/Three.js
        43	      0.18	src/materials/Material.js
        36	      0.15	build/custom/ThreeWebGL.js
        36	      0.15	src/cameras/Camera.js
        35	      0.15	build/custom/ThreeCanvas.js
        34	      0.15	build/custom/ThreeSVG.js
        34	      0.15	build/custom/ThreeDOM.js
        32	      0.14	src/core/BufferGeometry.js
```

This means that file `Object3D.js` is most often committed with `Geometry.js` -
they both appear together in `51` commits! By looking at this output
you can immediately see core pieces of three.js.

The `Similarity` column shows [`Jaccard index`](https://en.wikipedia.org/wiki/Jaccard_index)
of two files.

# usage

Install the package with npm:

```
npm install -g git-also
```

Run it from command line inside your git repository:

```
git also <file>
```

If you run it without arguments it prints help:

```
  Usage: git-also [options] <file>

For a <file> in your git repository prints other files that are most often committed together

Options:

-h, --help       output usage information
    -V, --version    output the version number
    -c, --count <n>  Print top N other files. N is 10 by default
```

# motivation

Files are often committed together when developers improve code or add new features.
This information could serve as a hint when you are exploring new code:

* What are related file to this file?
* Where else should I look when I fix bugs in this file?

# license

MIT