Git Product home page Git Product logo

sheldon's Introduction

Sheldon

Hex.pm Version Hex.pm Downloads Coverage Status Build Status Erlang Versions

Very Simple Erlang Spell Checker.

Note: Sheldon also suggests correct words when some word is misspelled. That functionality was highly inspired by the Elixir project spell_check.

Contact Us

If you find any bugs or have a problem while using this library, please open an issue in this repo (or a pull request :)).

And you can check all of our open-source projects at inaka.github.io.

Installation

NOTE sheldon only works with Erlang 21 or greater

  1. Clone the repo
  2. rebar3 compile

Usage

Erlang Shell

First of all Sheldon is an application and it needs to be started. You can use rebar3 shell to set the necessary paths, then use sheldon:start/0 or application:ensure_all_started(sheldon) in order to start Sheldon but if you are using Sheldon as a dependency you can let OTP starts it from your_app.app file too.

Sheldon only has two main methods, sheldon:check/1 and sheldon:check/2. As a user, you just need to use those.

1> sheldon:check("I want to check this correct text").
ok
2> sheldon:check("I want to check this misspeled text").
#{bazinga => <<"That's no reason to cry. One cries because one is sad. For example, I cry because others are stupid, and that ma"...>>,
  misspelled_words => [#{candidates => ["misspeed","misspelled"],
     line_number => 1,
     word => "misspeled"}]}

Configuration

sheldon:check/2 works like sheldon:check/1 but it accepts a Configuration parameter. With this Conf parameter we can apply some rules to the text we want to check. Those rules are ignore words, ignore patterns and ignore blocks.

This is the format (see sheldon_config.erl), no key is required:

#{ ignore_words    => [string()]
 , ignore_patterns => [regex()]
 , ignore_blocks   => [ignore_block()]
 , adapters        => [adapter()]
 }.

Then, if we call the previous sheldon:check/1 but with configuration we can skip the error

3> sheldon:check("I want to check this misspeled text", #{ignore_words => ["misspeled"]}).
ok

Adapters

Sometimes we have to check the spelling of formatted text but sheldon handles it as a plain text so we will face problems with that. One example is markdown files, if we try to check them sheldon will complain about things like '##' or '*something*'. For these cases sheldon provides adapters. An adapter is an Erlang module with an adapt/1 function which will receive a line in binary() format and returns that line transformed. For example, sheldon provides markdown_adapter which converts from markdown to plain text.

In order to use them we only have to declare them in the config file:

#{adapters => [markdown_adapter]}.

You can create your own adapter which fits your requirements, you only need to implement the sheldon_adapter behavior and to provide some code to adapt/1 function.

-spec adapt(binary()) -> iodata().
adapt(Line) ->
  ...

You can add all the adapters you want and they will be executed in order.

Examples

Check this out.

Results

sheldon:check/1 and sheldon:check/2 have the same result type, you can see sheldon_result.erl. Sheldon will return the ok atom if the check went well else it'll return

    #{ misspelled_words := [misspelled_word()]
     , bazinga          := string()
     }.

misspelled_word's list will be returned ordered by line number. If more than one misspelled word per line appears they will be ordered by order of appearance.

Dependencies

  • Erlang/OTP 23+

sheldon's People

Contributors

amilkr avatar cabol avatar elbrujohalcon avatar ferigis avatar harenson avatar vkatsuba avatar x4lldux avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.