npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

text-compare

v0.0.1

Published

A tool for comparing text content efficiently.

Downloads

231

Readme

text-compare 📝

A powerful React hook for comparing text with visual diffs and similarity scores

text-compare is a lightweight yet powerful React hook that helps you compare two texts and visualize their differences. It provides customizable highlighting for added, removed, and common words, along with a similarity percentage score.

All Contributors

Features ✨

  • ⚡ Lightweight and performant
  • 🎨 Customizable highlighting colors
  • 📊 Similarity percentage calculation
  • 🔧 Easy to integrate

Basic Usage 🚀

Install the Package

First, install the text-compare package using npm or yarn:

npm install text-compare
# or
yarn add text-compare

After installing, here's a quick example to get you started:

import { useTextComparison } from 'text-compare';

const TextDiffer = () => {
  const text1 = 'The quick brown fox jumps over the lazy dog';
  const text2 = 'The quick blue fox leaps over the happy dog';

  const { comparisonResult, similarity } = useTextComparison(text1, text2);

  return (
    <>
      <div className="flex gap-1 mb-4">{comparisonResult}</div>
      <div>Similarity: {similarity.toFixed(2)}%</div>
    </>
  );
};

🛠️ Advanced Usage

Customization Options

The useTextComparison hook accepts an options object for customization:

const options = {
  customColors: {
    commonColor: '#1E90FF',    // DodgerBlue for common words
    removedColor: '#FF6347',   // TomatoRed for removed words
    addedColor: '#32CD32',     // LimeGreen for added words
  }
};

const { comparisonResult, similarity } = useTextComparison(text1, text2, options);

Available Options

| Option | Type | Description | |--------|---------|-------------| | customColors | object | An object containing color configurations for text highlighting. Properties: commonColor (for matching words), removedColor (for removed words), addedColor (for added words) |

🚀 Getting Started Guide

Follow the steps below to set up and work with the text-compare project.

1. Clone the Repository

First, clone the repository to your local machine and navigate to the project directory:

git clone https://github.com/CreoWis/text-compare.git
cd text-compare

2. Install pnpm (if you don't have it installed):

If you don't have pnpm installed, you can install it globally using the following command:

npm install -g pnpm

3. Install Dependencies

Navigate to the project directory and install the dependencies using:

pnpm install

4. Testing New Features Locally

If you have added new features and want to test them locally after making changes, follow these steps

a. Build the Project: Compile the latest changes:

npm run build

b. Create a Tarball: Generate a .tgz file for the updated package:

npm pack

c. Copy the Tarball: Copy the generated .tgz file from the project root directory.

d. Add the .tgz File to Your Frontend Project: Place the .tgz file in the root directory of your frontend project.

e. Update package.json: In the dependencies section of your package.json file, add a reference to the .tgz file. For example:

"dependencies": {
  "next": "^14.1.0",
  "react": "^18.2.0",
  "react-dom": "^18.2.0",
  "text-compare": "file:text-compare-0.0.1.tgz"
}

f. Install Dependencies in the Frontend Project:Run the following command to install the updated package:

npm install

g. Start the Frontend Project: Finally, start your development server:

npm run dev
# or
npm start

Contributing 🤝

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

  1. Fork the project
  2. Create your feature branch (git checkout -b issue-(issue number)-amazing-feature)
  3. Commit your changes (git commit -m 'feat: add some amazing feature')
  4. Push to the branch (git push issue-(issue number)-amazing-feature)
  5. Open a Pull Request

For detailed guidelines, please see our Contributing Guide.

🙏 Support Us

This is an OSS project by team CreoWis. We need all the support we can get. Please give this project a ⭐️ to encourage and show that you liked it.

If you found the project helpful, consider supporting us with a coffee.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification.

License 📄

This project is licensed under the MIT License - see the LICENSE file for details.