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

fuzzymatchingjs

v0.4.1

Published

String Fuzzy Matching

Downloads

3

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

seanosheaseanoshea

Keywords

fuzzymatchstringmatching

Readme

fuzzymatchingjs

CI Status Code Coverage NPM version NPM version License Languages Top Language Open Issues Closed Issues Twitter: @seanoshea

Acknowledgements

The majority of the fuzzy matching logic included in this project is taken from Neil Fraser's google-diff-match-patch

Usage

See the README file in the docs directory.

Development Setup

  1. Install the latest stable version of node using https://github.com/creationix/nvm.
  2. Run npm install.
  3. Run npm run test to run the unit tests for the library. Ensure that they pass before proceeding with any other steps.
  4. Run npm run start to run the dev server for the library.
  5. Navigate to http://localhost:8080 and open the console.

Repository Structure

There's a lot of configuration files and .js files associated with this project. Below is an attempt to explain what each of them are for:

  • .circleci - config files for circle-ci integration.
  • .eslintignore - similar to a .gitignore file. Has a list of files and directories which should be ignore as part of any linting process.
  • .eslintrc.json - eslint config file.
  • .nvmrc - similar to a .ruby-version or .rvmrc file. Specifies the version of node used to run this project.
  • index.js - main entry point for the library as specified in the package.json file. Basically just exports the main functionality of the library.
  • package.json - descriptor file for npm. Includes a lot of the build script configurations.
  • .github - files which are specific to making development easy via github are housed here.
  • dist - generated .js files are housed here. The build scripts defined in package.json output to this directory.
  • docs - documentation configuration files are housed here. See the generate-docs script in package.json for details.
  • src - the source code for the library is housed here.
  • test - jest unit tests are housed here.

Linting

npm run lint will run linting on the source code and the test code for the project. Check out the eslintrc.json file for details on the rules applied to the codebase.

Documentation

Run npm run generate-docs to generate the jsdoc documentation for the library.

Author

[email protected]. See the Acknowledgements section for the original basis for this code.

License

fuzzymatchingjs is available under the Apache 2 license. See the LICENSE file for more info.

Contributing

See the Contributing Instructions for details.

Swift Version

https://github.com/seanoshea/fuzzymatchingjs is a Swift version of this library.