Skip to content

Latest commit

 

History

History
 
 

json-spell-checker

README.md

@thing-description-playground/JSON-SPELL-CHECKER

This package provides spell-checking support for JSON files when a JSON Schema is given. You can find more information about the Thingweb-Playground here.

Limitations:

  • There is limited nested spell checking. Some of the $ref definitions can be nested infinitely, therefore spell checking stops at the first detection of recursive nesting.
  • This tool mainly developed for Thing Descriptions. Even though it can be used for all JSON Schemas, it may not cover all the rules of a schema. For example 'if, else, then' rule of Open API schema is not supported yet but this functionality could be added in the future.

License

Licensed under the MIT license, see License.

Script based Spell Checking

This is a Node.js based tool.

You can use the functionality of this package by:

  • Install the package with npm npm install @thing-description-playground/json-spell-checker (or clone repo and install the package with npm install)

  • Node.js or Browser

    • Node.js: Require the package and use the validation function
    const jsonSpellChecker = require("@thing-description-playground/json-spell-checker");
    • Browser: Import the JsonSpellChecker as a global by adding a script tag to your HTML.
    <script src="./node_modules/@thing-description-playground/json-spell-checker/dist/web-bundle.min.js"></script>

  • First configure your spell checker using (similarityThreshold should be between 0 and 1 and try to set maxLengthDifference low in case you need quick typo evaluation):

jsonSpellChecker.configure(yourSchema, similarityThreshold, maxLengthDifference);
  • Or just set schema and use default values for similarityThreshold (0.85) and maxLengthDifference (2)
jsonSpellChecker.configure(yourSchema);
  • Then call checkTypos function with your stringified JSON file to find typos
jsonSpellChecker.checkTypos(stringifiedJsonFile);

Structure

The index.js file contains the main validation functionality and exports the modules functionalities.

Examples

Test Usage

Test Examples are located under examples directory. For examples you need to fill 'typoCount' field that corresponds to the number of typos existing in the TD.