# stemmer
> Porter Stemmer algorithm
Latest version **2.0.1** (published 2022-11-02) · MIT license · 0 weekly downloads
## Install
```sh
npm install stemmer
pnpm add stemmer
yarn add stemmer
bun add stemmer
```
Provides the command `stemmer`.
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.1 |
| Published | 2022-11-02 |
| First published | 2014-06-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 138 |
| Author | Titus Wormer |
| Maintainers | wooorm, zeke |
| Keywords | martin, porter, stemmer, algorithm, cli, bin |
## Links
- npm: https://www.npmjs.com/package/stemmer
- Repository: https://github.com/words/stemmer
- Homepage: https://words.github.io/stemmer/
- Issues: https://github.com/words/stemmer/issues
- Funding: https://github.com/sponsors/wooorm
- npm.io page: https://npm.io/package/stemmer
## Alternatives
- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads
## Recent versions
- 2.0.1 (latest) — 2022-11-02
- 2.0.0 — 2021-04-07
- 1.0.5 — 2020-02-01
- 1.0.4 — 2019-05-17
- 1.0.3 — 2018-08-29
- 1.0.2 — 2017-11-06
- 1.0.1 — 2017-07-18
- 1.0.0 — 2016-09-19
- 0.1.4 — 2015-01-08
- 0.1.1 — 2014-11-25
- 0.1.3 — 2014-10-30
- 0.1.2 — 2014-10-03
- 0.1.0 — 2014-07-08
- 0.0.3 — 2014-06-19
- 0.0.2 — 2014-06-17
- … 1 more at https://npm.io/package/stemmer/versions
## README
# stemmer
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[Porter stemming algorithm][source].
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`stemmer(value)`](#stemmervalue)
* [CLI](#cli)
* [Types](#types)
* [Compatibility](#compatibility)
* [Related](#related)
* [Contribute](#contribute)
* [Security](#security)
* [License](#license)
## What is this?
This package exposes a stemming algorithm.
That means it gets a certain string (typically an English word), and turns it
into a shorter version (a stem), which can then be compared to other stems
(of other words), to check if they are both (likely) the same term.
## When should I use this?
You’re probably dealing with natural language, and know you need this, if
you’re here!
## Install
This package is [ESM only][esm].
In Node.js (version 14.14+, 16.0+), install with [npm][]:
```sh
npm install stemmer
```
In Deno with [`esm.sh`][esmsh]:
```js
import {stemmer} from 'https://esm.sh/stemmer@2'
```
In browsers with [`esm.sh`][esmsh]:
```html
```
## Use
```js
import {stemmer} from 'stemmer'
stemmer('considerations') // => 'consider'
stemmer('detestable') // => 'detest'
stemmer('vileness') // => 'vile'
```
## API
This package exports the identifier `stemmer`.
There is no default export.
### `stemmer(value)`
Get the stem from a given value.
###### `value`
Value to stem (`string`, required).
##### Returns
Stem for `value` (`string`).
## CLI
```txt
Usage: stemmer [options]
Porter Stemmer algorithm
Options:
-h, --help output usage information
-v, --version output version number
Usage:
# output stems
$ stemmer considerations
# consider
# output stems from stdin
$ echo "detestable vileness" | stemmer
# detest vile
```
## Types
This package is fully typed with [TypeScript][].
It exports no additional types.
## 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
* [`stmr.c`](https://github.com/wooorm/stmr.c)
— C API
* [`stmr`](https://github.com/wooorm/stmr)
— C CLI
* [`lancaster-stemmer`](https://github.com/words/lancaster-stemmer)
— lancaster stemming algorithm
* [`double-metaphone`](https://github.com/words/double-metaphone)
— double metaphone algorithm
* [`soundex-code`](https://github.com/words/soundex-code)
— soundex algorithm
* [`dice-coefficient`](https://github.com/words/dice-coefficient)
— sørensen–dice coefficient
* [`levenshtein-edit-distance`](https://github.com/words/levenshtein-edit-distance)
— levenshtein edit distance
* [`syllable`](https://github.com/words/syllable)
— syllable count of English words
## 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/stemmer/workflows/main/badge.svg
[build]: https://github.com/words/stemmer/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/words/stemmer.svg
[coverage]: https://codecov.io/github/words/stemmer
[downloads-badge]: https://img.shields.io/npm/dm/stemmer.svg
[downloads]: https://www.npmjs.com/package/stemmer
[size-badge]: https://img.shields.io/bundlephobia/minzip/stemmer.svg
[size]: https://bundlephobia.com/result?p=stemmer
[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
[source]: https://tartarus.org/martin/PorterStemmer
[npm]: https://www.npmjs.com
---
_Source: https://npm.io/package/stemmer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._