npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

remark-lint-strong-marker

v4.0.0

Published

remark-lint rule to warn when importance (strong) markers violate the given style

Downloads

481,751

Readme

remark-lint-strong-marker

Build Coverage Downloads Size Sponsors Backers Chat

remark-lint rule to warn when strong markers are inconsistent.

Contents

What is this?

This package checks the style of strong markers.

When should I use this?

You can use this package to check that strong is consistent.

Presets

This plugin is included in the following presets:

| Preset | Options | | - | - | | remark-preset-lint-consistent | 'consistent' | | remark-preset-lint-markdown-style-guide | '*' |

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-lint-strong-marker

In Deno with esm.sh:

import remarkLintStrongMarker from 'https://esm.sh/remark-lint-strong-marker@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintStrongMarker from 'https://esm.sh/remark-lint-strong-marker@4?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintStrongMarker from 'remark-lint-strong-marker'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'

const file = await read('example.md')

await unified()
  .use(remarkParse)
  .use(remarkLint)
  .use(remarkLintStrongMarker)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-strong-marker .

On the CLI in a config file (here a package.json):

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-strong-marker",
     …
   ]
 }
 …

API

This package exports no identifiers. It exports the TypeScript types Marker and Options. The default export is remarkLintStrongMarker.

unified().use(remarkLintStrongMarker[, options])

Warn when strong markers are inconsistent.

Parameters
  • options (Options, default: 'consistent') — preferred style or whether to detect the first style and warn for further differences
Returns

Transform (Transformer from unified).

Marker

Marker (TypeScript type).

Type
type Marker = '*' | '_'

Options

Configuration (TypeScript type).

Type
type Options = Marker | 'consistent'

Recommendation

Whether asterisks or underscores are used affects how and whether strong works. Underscores are sometimes used to represent normal underscores inside words, so there are extra rules in markdown to support that. Asterisks are not used in natural language, so they don’t need these rules, and thus can form strong in more cases. Asterisks can also be used as the marker of more constructs than underscores: lists. Due to having simpler parsing rules, looking more like syntax, and that they can be used for more constructs, it’s recommended to prefer asterisks.

Fix

remark-stringify formats strong with asterisks by default. Pass strong: '_' to always use underscores.

Examples

ok-asterisk.md

When configured with '*'.

In
**Mercury**.
Out

No messages.

not-ok-asterisk.md

When configured with '*'.

In
__Mercury__.
Out
1:1-1:12: Unexpected strong marker `_`, expected `*`
ok-underscore.md

When configured with '_'.

In
__Mercury__.
Out

No messages.

not-ok-underscore.md

When configured with '_'.

In
**Mercury**.
Out
1:1-1:12: Unexpected strong marker `*`, expected `_`
not-ok-consistent.md
In
**Mercury** and __Venus__.
Out
1:17-1:26: Unexpected strong marker `_`, expected `*`
not-ok.md

When configured with '🌍'.

Out
1:1: Unexpected value `🌍` for `options`, expected `'*'`, `'_'`, or `'consistent'`

Compatibility

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-lint-strong-marker@4, compatible with Node.js 16.

Contribute

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.

License

MIT © Titus Wormer