Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rezach/grammarify
Grammarify is a npm package that safely cleans up text that has mispellings, improper capitalization, lexical illusions, among other things.
https://github.com/rezach/grammarify
grammar-checker spelling-correction text-cleaning
Last synced: 29 days ago
JSON representation
Grammarify is a npm package that safely cleans up text that has mispellings, improper capitalization, lexical illusions, among other things.
- Host: GitHub
- URL: https://github.com/rezach/grammarify
- Owner: reZach
- License: mit
- Created: 2018-04-22T05:10:49.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-08T22:45:40.000Z (almost 2 years ago)
- Last Synced: 2024-11-11T21:21:12.486Z (about 1 month ago)
- Topics: grammar-checker, spelling-correction, text-cleaning
- Language: JavaScript
- Homepage:
- Size: 412 KB
- Stars: 67
- Watchers: 5
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Grammarify is a npm package that safely cleans up text that has mispellings, improper capitalization, lexical illusions, among other things.
## How to use
```
var grammarify = require("grammarify");
var sentence = "im so borrreeedddd";
console.log(grammarify.clean(sentence)); // "I'm so bored."
```
---
## Features
##### Automatically add periods at the end of sentences
```
"I am a sentence" -> "I am a sentence."
```
##### Remove "safe" lexical illusions
_(Some words are grammatically correct if repeated twice, words that are not are removed if duplicated)_
```
"The the pig snorted." -> "The pig snorted."
```
##### Spellcheck words
```
"I was mad becuase I left home early." -> "I was mad because I left home early."
```
##### Capitalize words at the beginning of sentences
```
"I like to run. he runs faster than I." -> "I like to run. He runs faster than I."
```
##### Change SMS/shorthand to full words
```
"Meet me at home asap." -> "Meet me at home as soon as possible."
```
##### Shrink stretched words
```
"I'm so borreedddd." -> "I'm so bored."
```
##### Combine separated words
```
"Yesterday and to day we flew kites." -> "Yesterday and today we flew kites."
```
##### Split up sentences if connected
```
"Writing C# code is fun.It is much better than Java." -> "Writing C# code is fun. It is much better than Java."
```
##### Fix intended ellipsis
_(Intended ellipsis are any two or more periods separated by any number of periods and/or spaces)_
```
"I was thinking yesterday..that I should go outside." -> "I was thinking yesterday... that I should go outside."
```
##### Add spaces between comma/semicolon/colon-separated words
```
"She likes to eat,cook,clean and dance!" -> "She likes to eat, cook, clean and dance!"
```
##### Fix extra spaces in between words
```
"Wow what an extra long coat!" -> "Wow what an extra long coat!"
```
##### Fix duplicate punctuation
```
" what a daay. i must have had 1,,000 shots" -> "What a day. I must have had 1,000 shots."
```
---
## Bugs or suggestions?
Go to our [Github page](https://github.com/reZach/grammarify).
Our [NPM package](https://www.npmjs.com/package/grammarify)