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

@thing-description-playground/json-spell-checker

v1.0.1

Published

Checks the spelling of a JSON file depending on the JSON schema

Downloads

3

Readme

@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.