The majority of the fuzzy matching logic included in this project is taken from Neil Fraser's google-diff-match-patch
See the README file in the docs directory.
npm install
.npm run test
to run the unit tests for the library. Ensure that they pass before proceeding with any other steps.npm run start
to run the dev server for the library.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.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.
Run npm run generate-docs
to generate the jsdoc
documentation for the library.
[email protected]. See the Acknowledgements section for the original basis for this code.
fuzzymatchingjs is available under the Apache 2 license. See the LICENSE file for more info.
See the Contributing Instructions for details.
https://github.com/seanoshea/fuzzymatchingjs is a Swift version of this library.