https://github.com/words/smog-formula
Formula to detect the ease of reading a text according to the SMOG (Simple Measure of Gobbledygook) formula (1969)
https://github.com/words/smog-formula
ease gobbledygook readability reading smog
Last synced: about 1 month ago
JSON representation
Formula to detect the ease of reading a text according to the SMOG (Simple Measure of Gobbledygook) formula (1969)
- Host: GitHub
- URL: https://github.com/words/smog-formula
- Owner: words
- License: mit
- Created: 2014-09-15T09:02:58.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2022-11-01T14:52:40.000Z (over 3 years ago)
- Last Synced: 2026-01-30T20:38:37.889Z (3 months ago)
- Topics: ease, gobbledygook, readability, reading, smog
- Language: JavaScript
- Homepage: https://wooorm.com/readability/
- Size: 52.7 KB
- Stars: 18
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: funding.yml
- License: license
Awesome Lists containing this project
README
# smog-formula
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
Formula to detect the grade level of text according to the [SMOG (simple measure
of gobbledygook) formula][formula].
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`smogFormula(counts)`](#smogformulacounts)
* [Types](#types)
* [Compatibility](#compatibility)
* [Related](#related)
* [Contribute](#contribute)
* [Security](#security)
* [License](#license)
## What is this?
This package exposes an algorithm to detect ease of reading of English texts.
## When should I use this?
You’re probably dealing with natural language, and know you need this, if
you’re here!
This algorithm is based on syllables, whereas some others are not, which means
it’s tougher to get right and slower to calculate.
See [`syllable`][syllable] for detecting syllables.
## Install
This package is [ESM only][esm].
In Node.js (version 14.14+, 16.0+), install with [npm][]:
```sh
npm install smog-formula
```
In Deno with [`esm.sh`][esmsh]:
```js
import {smogFormula} from 'https://esm.sh/smog-formula@2'
```
In browsers with [`esm.sh`][esmsh]:
```html
import {smogFormula} from 'https://esm.sh/smog-formula@2?bundle'
```
## Use
```js
import {smogFormula} from 'smog-formula'
// For “The Australian platypus is seemingly a hybrid of a mammal and reptilian
// creature.” (1 sentence; 4 polysillabic words).
smogFormula({sentence: 1, polysillabicWord: 4})
// => 14.554593…
```
## API
This package exports the identifier `smogFormula`.
There is no default export.
### `smogFormula(counts)`
Given an object containing the number of sentences (`sentence`) and the number
of polysillabic (three or more syllables) words (`polysillabicWord`) in a
document, returns the reading ease associated with the document.
##### `counts`
Counts from input document.
###### `counts.sentence`
Number of sentences (`number`, required).
###### `counts.polysillabicWord`
Number of polysillabic (three or more syllables) words (`number`, required).
##### Returns
Reading ease associated with the document (`number`).
## Types
This package is fully typed with [TypeScript][].
It exports the additional type `Counts`.
## Compatibility
This package is at least compatible with all maintained versions of Node.js.
As of now, that is Node.js 14.14+ and 16.0+.
It also works in Deno and modern browsers.
## Related
* [`automated-readability`](https://github.com/words/automated-readability)
— uses character count instead of error-prone syllable parser
* [`coleman-liau`](https://github.com/words/coleman-liau)
— uses letter count instead of an error-prone syllable parser
* [`dale-chall-formula`](https://github.com/words/dale-chall-formula)
— uses a dictionary, suited for higher reading levels
* [`flesch`](https://github.com/words/flesch)
— uses syllable count
* [`flesch-kincaid`](https://github.com/words/flesch-kincaid)
— like `flesch`, returns U.S. grade levels
* [`gunning-fog`](https://github.com/words/gunning-fog)
— uses syllable count, needs POS-tagging and NER
* [`spache-formula`](https://github.com/words/spache-formula)
— uses a dictionary, suited for lower reading levels
## Contribute
Yes please!
See [How to Contribute to Open Source][contribute].
## Security
This package is safe.
## License
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/words/smog-formula/workflows/main/badge.svg
[build]: https://github.com/words/smog-formula/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/words/smog-formula.svg
[coverage]: https://codecov.io/github/words/smog-formula
[downloads-badge]: https://img.shields.io/npm/dm/smog-formula.svg
[downloads]: https://www.npmjs.com/package/smog-formula
[size-badge]: https://img.shields.io/bundlephobia/minzip/smog-formula.svg
[size]: https://bundlephobia.com/result?p=smog-formula
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[typescript]: https://www.typescriptlang.org
[contribute]: https://opensource.guide/how-to-contribute/
[license]: license
[author]: https://wooorm.com
[formula]: https://en.wikipedia.org/wiki/SMOG
[syllable]: https://github.com/words/syllable