# retext-preset-stoicism > Text processor for the Stoicism Compendium Latest version **0.0.1** (published 2020-06-25) · BlueOak-1.0.0 license · 0 weekly downloads ## Install ```sh npm install retext-preset-stoicism pnpm add retext-preset-stoicism yarn add retext-preset-stoicism bun add retext-preset-stoicism ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.0.1 | | Published | 2020-06-25 | | First published | 2020-06-25 | | Weekly downloads | 0 | | License | BlueOak-1.0.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 12 | | Unpacked size | 7.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Sean Leather | | Maintainers | prokopton | | Keywords | retext, preset, stoicism | ## Links - npm: https://www.npmjs.com/package/retext-preset-stoicism - Repository: https://github.com/stoicism-compendium/retext-preset-stoicism - Homepage: https://github.com/stoicism-compendium/retext-preset-stoicism#readme - Issues: https://github.com/stoicism-compendium/retext-preset-stoicism/issues - npm.io page: https://npm.io/package/retext-preset-stoicism ## Dependencies (12) - [retext-emoji](https://npm.io/package/retext-emoji.md) ^7.0.1 - [dictionary-en](https://npm.io/package/dictionary-en.md) ^3.0.0 - [retext-quotes](https://npm.io/package/retext-quotes.md) ^4.0.0 - [retext-english](https://npm.io/package/retext-english.md) ^3.0.4 - [retext-diacritics](https://npm.io/package/retext-diacritics.md) ^3.0.0 - [retext-spell-file](https://npm.io/package/retext-spell-file.md) ^0.0.1 - [retext-syntax-urls](https://npm.io/package/retext-syntax-urls.md) ^2.0.0 - [retext-contractions](https://npm.io/package/retext-contractions.md) ^4.0.0 - [retext-repeated-words](https://npm.io/package/retext-repeated-words.md) ^3.0.0 - [retext-sentence-spacing](https://npm.io/package/retext-sentence-spacing.md) ^4.0.0 - [retext-indefinite-article](https://npm.io/package/retext-indefinite-article.md) ^2.0.1 - [retext-redundant-acronyms](https://npm.io/package/retext-redundant-acronyms.md) ^3.0.0 ## Recent versions - 0.0.1 (latest) — 2020-06-25 ## README # retext-preset-stoicism ![test][test-badge] _**Text processor for the Stoicism Compendium.**_ This is a [**`retext`**][retext] [preset][] defining a number of warnings.
These are the warnings. Each of the plugins is configured to emit a warning for the issue mentioned: | Plugin | Issue | | ------------------------------- | ---------------------------------------------------- | | [`retext-contractions`][] | Incorrect apostrophes in contractions | | [`retext-diacritics`][] | Incorrect diacritics | | [`retext-indefinite-article`][] | Incorrect indefinite articles | | [`retext-quotes`][] | “Straight” quotes and apostrophes instead of “smart” | | [`retext-redundant-acronyms`][] | Redundant acronyms | | [`retext-repeated-words`][] | Repeated words | | [`retext-sentence-spacing`][] | Number of spaces between sentences ≠ 1 |
`retext-preset-stoicism` is used by [`remark-preset-stoicism`][] to check Markdown text in the Stoicism Compendium. ## Prerequisites In the following sections, we describe how to install `retext-preset-stoicism` with [`npm`][npm-cli] and how to use it with [`remark`][remark-cli] to check Markdown files. Alternatives include [`yarn`][yarn] instead of `npm`. ## Installation Install `retext-preset-stoicism` and other dependencies as a [development dependency][npm-dependencies]: ```sh npm install --save-dev \ retext-preset-stoicism \ remark-cli \ remark-retext \ unified ``` ## Usage ### Configuration Create a file called [`.remark.js`][unified-engine-config]: ```js exports.plugins = [ [ require('remark-retext'), require('unified')().use(require('retext-preset-stoicism')), ] ] ``` See [`remark-preset-stoicism`][] for how `retext-preset-stoicism` is used along with a number of other `remark` plugins and settings. ### Script Define a [script][npm-run-script] in your `package.json` to run `remark` on your Markdown files: ```json "scripts": { "check-md": "remark --quiet --frail ." } ``` Run the script with `npm run`: ```sh npm run check-md ``` ## License [Blue Oak Model License 1.0.0][license] © [Sean Leather][author] [`remark-preset-stoicism`]: https://github.com/stoicism-compendium/remark-preset-stoicism [`retext-contractions`]: https://github.com/retextjs/retext-contractions [`retext-diacritics`]: https://github.com/retextjs/retext-diacritics [`retext-indefinite-article`]: https://github.com/retextjs/retext-indefinite-article [`retext-quotes`]: https://github.com/retextjs/retext-quotes [`retext-redundant-acronyms`]: https://github.com/retextjs/retext-redundant-acronyms [`retext-repeated-words`]: https://github.com/retextjs/retext-repeated-words [`retext-sentence-spacing`]: https://github.com/retextjs/retext-sentence-spacing [author]: https://github.com/spl [license]: ./license.md [npm-cli]: https://docs.npmjs.com/cli/install [npm-dependencies]: https://docs.npmjs.com/specifying-dependencies-and-devdependencies-in-a-package-json-file [npm-run-script]: https://docs.npmjs.com/cli/run-script [preset]: https://github.com/unifiedjs/unified#preset [remark-cli]: https://github.com/remarkjs/remark/tree/main/packages/remark-cli [retext]: https://github.com/retextjs/retext [test-badge]: https://github.com/stoicism-compendium/retext-preset-stoicism/workflows/test/badge.svg [unified-engine-config]: https://github.com/unifiedjs/unified-engine/blob/main/doc/configure.md [yarn]: https://yarnpkg.com/ --- _Source: https://npm.io/package/retext-preset-stoicism · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._