https://github.com/piecioshka/git-similarity-index

🔨 Calculates the similarity index between two files.
https://github.com/piecioshka/git-similarity-index

cli git

Last synced: 19 days ago
JSON representation

🔨 Calculates the similarity index between two files.

• Host: GitHub
• URL: https://github.com/piecioshka/git-similarity-index
• Owner: piecioshka
• Created: 2024-11-18T07:49:09.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2026-01-12T15:49:38.000Z (6 months ago)
• Last Synced: 2026-04-23T12:34:49.455Z (2 months ago)
• Topics: cli, git
• Language: TypeScript
• Homepage:
• Size: 107 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# git-similarity-index

[![cli-available](https://badgen.net/static/cli/available/?icon=terminal)](#cli)

[![node version](https://img.shields.io/node/v/git-similarity-index.svg)](https://www.npmjs.com/package/git-similarity-index)

[![npm version](https://badge.fury.io/js/git-similarity-index.svg)](https://badge.fury.io/js/git-similarity-index)

[![downloads count](https://img.shields.io/npm/dt/git-similarity-index.svg)](https://www.npmjs.com/package/git-similarity-index)

[![size](https://packagephobia.com/badge?p=git-similarity-index)](https://packagephobia.com/result?p=git-similarity-index)

[![license](https://img.shields.io/npm/l/git-similarity-index.svg)](https://piecioshka.mit-license.org)

[![github-ci](https://github.com/piecioshka/git-similarity-index/actions/workflows/testing.yml/badge.svg)](https://github.com/piecioshka/git-similarity-index/actions/workflows/testing.yml)

🔨 Calculates the similarity index between two files.

## Motivation

I would like to calculate the similarity between two files. Unfortunately, but Git does not provide a command that would count the ‘similarity index’. Therefore, I decided to write such a tool myself that counts this index.

![](./screenshots/demo-similarity-index.png)

## CLI

```bash

npm install -g git-similarity-index

git-similarity-index mocks/file1.txt mocks/file2.txt

# or

git-similarity-index mocks/file1.txt mocks/file2.txt --use-git

```

## Usage

### `getSimilarityIndex` + `getLinesBytes`

```js

import { getSimilarityIndex, getLinesBytes } from "git-similarity-index";

(function () {

  const toBytes = (text) => Buffer.from(text).toJSON().data;

  const firstPattern = "a\n";

  const secondPattern = "a\nb";

  const similarityIndex = getSimilarityIndex(

    getLinesBytes(toBytes(firstPattern)),

    getLinesBytes(toBytes(secondPattern)),

    toBytes(secondPattern).length,

  );

  console.log(similarityIndex); // 66.67

})();

```

### `getSimilarityIndexForText`

```js

import { getSimilarityIndexForText } from "git-similarity-index";

(function () {

  const firstPattern = "a\nb\nc\n";

  const secondPattern = "a\nb\nc\nd";

  const similarityIndex = getSimilarityIndexForText(

    firstPattern,

    secondPattern,

  );

  console.log(similarityIndex); // 85.71

})();

```

### `getSimilarityIndexForFiles`

```js

import { getSimilarityIndexForFiles } from "git-similarity-index";

(async function () {

  const similarityIndex = await getSimilarityIndexForFiles(

    "mocks/file1.txt",

    "mocks/file2.txt",

  );

  console.log(similarityIndex); // 46.34

})();

```

### `getSimilarityIndexForFiles` (with `useGit` option)

```js

import { getSimilarityIndexForFiles } from "git-similarity-index";

(async function () {

  const similarityIndex = await getSimilarityIndexForFiles(

    "mocks/file1.txt",

    "mocks/file2.txt",

    { useGit: true },

  );

  console.log(similarityIndex); // 46.34

})();

```

## Debug

The tool itself uses the `debug` library. You can enable debugging by setting the `DEBUG` environment variable.

```bash

# to display all logs

DEBUG=git-similarity-index:* git-similarity-index mocks/file1.txt mocks/file2.txt

# focus only of bytes

DEBUG=git-similarity-index:bytes git-similarity-index mocks/file1.txt mocks/file2.txt

# focus only of text

DEBUG=git-similarity-index:text git-similarity-index mocks/file1.txt mocks/file2.txt

# focus only of files

DEBUG=git-similarity-index:files git-similarity-index mocks/file1.txt mocks/file2.txt

```

## License

[The MIT License](https://piecioshka.mit-license.org) @ 2024