Skip to content
This repository has been archived by the owner on Oct 25, 2024. It is now read-only.

Commit

Permalink
Mark retext-sentiment as legacy
Browse files Browse the repository at this point in the history
  • Loading branch information
@wooorm
wooorm committed Aug 22, 2021
1 parent 0c1c1ac commit 5b3b8f5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 219 deletions.
22 changes: 2 additions & 20 deletions package.json
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,9 @@
{
"name": "retext-sentiment",
"version": "6.0.0",
"description": "retext plugin to detect the sentiment of text",
"description": "Legacy retext plugin to detect the sentiment of text",
"license": "MIT",
"keywords": [
"unified",
"retext",
"retext-plugin",
"plugin",
"natural",
"language",
"afinn",
"sentiment",
"subjective",
"subjectivity",
"polarity",
"opinion",
"emotion",
"attitude",
"sentiment",
"detect",
"guess"
],
"keywords": [],
"repository": "retextjs/retext-sentiment",
"bugs": "https://github.com/retextjs/retext-sentiment/issues",
"funding": {
Expand Down
208 changes: 9 additions & 199 deletions readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,213 +1,23 @@
# retext-sentiment

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
**Stability: Legacy**.
This package is no longer recommended for use.
It’s still covered by semantic-versioning guarantees and not yet deprecated,
but use of this package should be avoided.
Please use a different way to detect sentiment, such as
with [`words/polarity`][polarity].

[**retext**][retext] plugin to detect sentiment.

Useful for other plugins as it adds information to [**nlcst**][nlcst] nodes.

## Install

This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
Node 12+ is needed to use it and it must be `import`ed instead of `require`d.

[npm][]:

```sh
npm install retext-sentiment
```

## Use

Say we have the following file, `example.txt`:

```txt
I hate forgetting to bring a book somewhere I
definitely should have brought a book to.
This product is not bad at all.
Hai sexy! 😏
```

You’ll note that `bad` is a negative word, but that it’s actually positive
as it’s preceded by `not`.

…and our script, `example.js`, looks like this:

```js
import {readSync} from 'to-vfile'
import {inspect} from 'unist-util-inspect'
import {unified} from 'unified'
import retextEnglish from 'retext-english'
import retextSentiment from 'retext-sentiment'

const file = readSync('example.txt')
const processor = unified().use(retextEnglish).use(retextSentiment)

const tree = processor.runSync(processor.parse(file), file)

console.log(inspect(tree))
```

Note that we’re not using [`.process()`][process], as that would not give
access to our tree.

Now, running `node example` yields (abbreviated):

```txt
RootNode[6] (1:1-7:1, 0-135) [data={"polarity":5,"valence":"positive"}]
├─ ParagraphNode[1] (1:1-2:42, 0-87) [data={"polarity":-3,"valence":"negative"}]
│ └─ SentenceNode[32] (1:1-2:42, 0-87) [data={"polarity":-3,"valence":"negative"}]
│ ├─ WordNode[1] (1:1-1:2, 0-1)
│ │ └─ TextNode: "I" (1:1-1:2, 0-1)
│ ├─ WhiteSpaceNode: " " (1:2-1:3, 1-2)
│ ├─ WordNode[1] (1:3-1:7, 2-6) [data={"polarity":-3,"valence":"negative"}]
│ │ └─ TextNode: "hate" (1:3-1:7, 2-6) [data={"polarity":-3,"valence":"negative"}]
│ ├─ WhiteSpaceNode: " " (1:7-1:8, 6-7)
│ ...
│ └─ PunctuationNode: "." (2:41-2:42, 86-87)
├─ WhiteSpaceNode: "\n\n" (2:42-4:1, 87-89)
├─ ParagraphNode[1] (4:1-4:32, 89-120) [data={"polarity":3,"valence":"positive"}]
│ └─ SentenceNode[14] (4:1-4:32, 89-120) [data={"polarity":3,"valence":"positive"}]
│ ├─ WordNode[1] (4:1-4:5, 89-93)
│ │ └─ TextNode: "This" (4:1-4:5, 89-93)
│ ...
│ ├─ WordNode[1] (4:17-4:20, 105-108)
│ │ └─ TextNode: "not" (4:17-4:20, 105-108)
│ ├─ WhiteSpaceNode: " " (4:20-4:21, 108-109)
│ ├─ WordNode[1] (4:21-4:24, 109-112) [data={"polarity":-3,"valence":"negative"}]
│ │ └─ TextNode: "bad" (4:21-4:24, 109-112) [data={"polarity":-3,"valence":"negative"}]
│ ├─ WhiteSpaceNode: " " (4:24-4:25, 112-113)
│ ...
│ └─ PunctuationNode: "." (4:31-4:32, 119-120)
├─ WhiteSpaceNode: "\n\n" (4:32-6:1, 120-122)
├─ ParagraphNode[1] (6:1-6:13, 122-134) [data={"polarity":5,"valence":"positive"}]
│ └─ SentenceNode[6] (6:1-6:13, 122-134) [data={"polarity":5,"valence":"positive"}]
│ ├─ WordNode[1] (6:1-6:4, 122-125)
│ │ └─ TextNode: "Hai" (6:1-6:4, 122-125)
│ ├─ WhiteSpaceNode: " " (6:4-6:5, 125-126)
│ ├─ WordNode[1] (6:5-6:9, 126-130) [data={"polarity":3,"valence":"positive"}]
│ │ └─ TextNode: "sexy" (6:5-6:9, 126-130) [data={"polarity":3,"valence":"positive"}]
│ ├─ PunctuationNode: "!" (6:9-6:10, 130-131)
│ ├─ WhiteSpaceNode: " " (6:10-6:11, 131-132)
│ └─ SymbolNode: "😏" (6:11-6:13, 132-134) [data={"polarity":2,"valence":"positive"}]
└─ WhiteSpaceNode: "\n" (6:13-7:1, 134-135)
```

## API

This package exports no identifiers.
The default export is `retextSentiment`.

### `unified().use(retextSentiment[, options])`

Automatically detects the sentiment of each [**text**][text] and
[**word**][word] (using [`afinn-165`][afinn] and [`emoji-emotion`][emoticon]),
and stores the valence in `node.data.valence` and polarity in
`node.data.polarity`.

Valence?
Either `"neutral"`, `"positive"`, or `"negative"`.
Polarity?
A number between `-5` and `5` (both including).

In addition, the plugin reflects a calculated sentiment on parents
([**sentence**][sentence]s, [**paragraph**][paragraph]s, and [**root**][root]s),
through the same `valence` and `polarity` properties.
This calculated sentiment includes negation, so a word such as `bad`, with a
polarity of `-3`, is calculated as `3` when preceded by a word such as `not`,
`neither`, `nor`, or a word ending in `n’t`.

###### `options`

Mapping strings (words, other symbols) to numbers (`Object.<number>`, optional).
Used to insert custom values or for overwriting existing values with new
weights.

## Support

`retext-sentiment` supports all [`afinn-165`][afinn] words and
[`emoji-emotion`][emoticon] emoji / gemoji.

## Contribute

See [`contributing.md`][contributing] in [`retextjs/.github`][health] for ways
to get started.
See [`support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
Legacy [documentation for this package](https://github.com/retextjs/retext-sentiment/tree/5cbb516)
is still available in Git.

## License

[MIT][license] © [Titus Wormer][author]

<!-- Definitions -->

[build-badge]: https://github.com/retextjs/retext-sentiment/workflows/main/badge.svg

[build]: https://github.com/retextjs/retext-sentiment/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/retextjs/retext-sentiment.svg

[coverage]: https://codecov.io/github/retextjs/retext-sentiment

[downloads-badge]: https://img.shields.io/npm/dm/retext-sentiment.svg

[downloads]: https://www.npmjs.com/package/retext-sentiment

[size-badge]: https://img.shields.io/bundlephobia/minzip/retext-sentiment.svg

[size]: https://bundlephobia.com/result?p=retext-sentiment

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/retextjs/retext/discussions

[npm]: https://docs.npmjs.com/cli/install

[health]: https://github.com/retextjs/.github

[contributing]: https://github.com/retextjs/.github/blob/HEAD/contributing.md

[support]: https://github.com/retextjs/.github/blob/HEAD/support.md

[coc]: https://github.com/retextjs/.github/blob/HEAD/code-of-conduct.md

[license]: license

[author]: https://wooorm.com

[retext]: https://github.com/retextjs/retext

[nlcst]: https://github.com/syntax-tree/nlcst

[text]: https://github.com/syntax-tree/nlcst#text

[word]: https://github.com/syntax-tree/nlcst#word

[sentence]: https://github.com/syntax-tree/nlcst#sentence

[paragraph]: https://github.com/syntax-tree/nlcst#paragraph

[root]: https://github.com/syntax-tree/nlcst#root

[afinn]: https://github.com/words/afinn-165

[emoticon]: https://github.com/words/emoji-emotion

[process]: https://github.com/unifiedjs/unified#processorprocessfilevalue-done
[polarity]: https://github.com/words/polarity

0 comments on commit 5b3b8f5

Please sign in to comment.