generate-differences/README.md

Generate differences between original source and formmated source

# generate-differences

[![CI](https://github.com/ntnyq/generate-differences/workflows/CI/badge.svg)](https://github.com/ntnyq/generate-differences/actions)
[![NPM VERSION](https://img.shields.io/npm/v/generate-differences.svg)](https://www.npmjs.com/package/generate-differences)
[![NPM DOWNLOADS](https://img.shields.io/npm/dy/generate-differences.svg)](https://www.npmjs.com/package/generate-differences)
[![LICENSE](https://img.shields.io/github/license/ntnyq/generate-differences.svg)](https://github.com/ntnyq/generate-differences/blob/main/LICENSE)

A starter template for node projects.

## Install

```shell
npm install generate-differences
```

```shell
yarn add generate-differences
```

```shell
pnpm add generate-differences
```

## Usage

```ts
import { generateDifferences } from 'generate-differences'

const differences = generateDifferences('abc', 'edf')

console.log({ differences })
// [
//   {
//     "deleteText": "abc",
//     "insertText": "edf",
//     "offset": 0,
//     "operation": "replace",
//   },
// ]
```

## Credits

- Extracted from [prettier/prettier-linter-helpers](https://github.com/prettier/prettier-linter-helpers) with a little change. Published as ESM with TypeScript support.

## License

[MIT](./LICENSE) License © 2025-PRESENT [ntnyq](https://github.com/ntnyq)