https://github.com/seanoshea/fuzzymatchingjs

fuzzymatchingjs
https://github.com/seanoshea/fuzzymatchingjs

fuzzy javascript javascript-library matching nodejs

Last synced: 2 months ago
JSON representation

fuzzymatchingjs

• Host: GitHub
• URL: https://github.com/seanoshea/fuzzymatchingjs
• Owner: seanoshea
• License: other
• Created: 2017-04-16T14:46:42.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2022-12-11T04:36:27.000Z (about 2 years ago)
• Last Synced: 2024-04-13T23:54:58.914Z (9 months ago)
• Topics: fuzzy, javascript, javascript-library, matching, nodejs
• Language: JavaScript
• Size: 2.5 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fuzzymatchingjs

[![CI Status](https://circleci.com/gh/seanoshea/fuzzymatchingjs/tree/develop.svg?style=svg)](https://circleci.com/gh/seanoshea/fuzzymatchingjs/tree/develop)

[![Code Coverage](http://codecov.io/github/seanoshea/fuzzymatchingjs/coverage.svg?branch=develop)](http://codecov.io/github/seanoshea/fuzzymatchingjs?branch=develop)

[![NPM version](https://img.shields.io/npm/v/fuzzymatchingjs)](https://img.shields.io/npm/v/fuzzymatchingjs)

[![NPM version](https://img.shields.io/npm/dt/fuzzymatchingjs)](https://img.shields.io/npm/dt/fuzzymatchingjs)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![Languages](https://img.shields.io/github/languages/count/seanoshea/fuzzymatchingjs)](https://img.shields.io/github/languages/count/seanoshea/fuzzymatchingjs)

[![Top Language](https://img.shields.io/github/languages/top/seanoshea/fuzzymatchingjs)](https://img.shields.io/github/languages/top/seanoshea/fuzzymatchingjs)

[![Open Issues](https://img.shields.io/github/issues/seanoshea/fuzzymatchingjs)](https://img.shields.io/github/issues/seanoshea/fuzzymatchingjs)

[![Closed Issues](https://img.shields.io/github/issues-closed/seanoshea/fuzzymatchingjs)](https://img.shields.io/github/issues-closed/seanoshea/fuzzymatchingjs)

[![Twitter: @seanoshea](https://img.shields.io/badge/[email protected]?style=flat)](https://twitter.com/seanoshea)

## Acknowledgements

The majority of the fuzzy matching logic included in this project is taken from [Neil Fraser's](https://neil.fraser.name/) [google-diff-match-patch](https://code.google.com/p/google-diff-match-patch/)

## Usage

See the [README](docs/README.md) 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](.github/CONTRIBUTING.MD) for details.

## Swift Version

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