Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
remark-textr
Advanced tools
Readme
remark plugin to improve typography with Textr.
This package is a unified (remark) plugin to support Textr.
This project is useful if you want to automatically improve the text in your markdown documents. Textr is a simple way to do that: no need to worry about ASTs. On the other hand, ASTs are powerful, so some things are better done with custom plugins: see Create a plugin.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-textr
In Deno with esm.sh
:
import remarkTextr from 'https://esm.sh/remark-textr@6'
In browsers with esm.sh
:
<script type="module">
import remarkTextr from 'https://esm.sh/remark-textr@6?bundle'
</script>
Say we have the following file example.md
:
## spread operator...
```js
function(...args) { return args; }
```
…and a module example.js
:
/**
* @typedef {import('remark-textr').TextrPlugin} TextrPlugin
*/
import {remark} from 'remark'
import remarkTextr from 'remark-textr'
import {read} from 'to-vfile'
const file = await remark()
.use(remarkTextr, {plugins: [ellipses]})
.process(await read('example.md'))
console.log(String(file))
/**
* Replace triple dots with ellipses.
*
* @type {TextrPlugin}
*/
function ellipses(input) {
return input.replace(/\.{3}/gim, '…')
}
…then running node example.js
yields:
## spread operator…
```js
function(...args) { return args; }
```
This package exports no identifiers.
The default export is remarkTextr
.
unified().use(remarkTextr[, options])
Improve typography with Textr.
options
(Options
, optional)
— configurationTransform (Transformer
).
Options
Configuration (TypeScript type).
options
(object
, optional)
— configuration passed to textr
;
for example, you may want to set the ISO 639-1 locale code
of the content, which is important for stuff like the correct primary and
secondary quotesplugins
(Array<TextrPlugin | string>
, optional)
— textr plugins;
if strings are passed in, those are loaded with import
TextrPlugin
Textr plugin (TypeScript type).
Textr plugins are available on npm labelled with a textr
keyword.
You can also create them yourself, as shown in the example above.
value
(string
)
— value to transformoptions
(object
)
— global configuration passed to textrChanged text (string
, optional).
This package is fully typed with TypeScript.
It exports the additional types Options
and
TextrPlugin
.
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, remark-textr@^6
,
compatible with Node.js 16.
This plugin works with unified
version 6+ and remark
version 7+.
Use of remark-textr
does not involve rehype (hast) or user
content so there are no openings for cross-site scripting (XSS)
attacks.
Textr operates on text nodes, which are always escaped by remark.
See contributing.md
in remarkjs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
remark plugin to improve typography with Textr
The npm package remark-textr receives a total of 36,888 weekly downloads. As such, remark-textr popularity was classified as popular.
We found that remark-textr demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.