-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(deps): bump remark-lint-strikethrough-marker from 2.1.2 to 3.0.0 #221
Merged
ybiquitous
merged 1 commit into
main
from
dependabot/npm_and_yarn/remark-lint-strikethrough-marker-3.0.0
May 1, 2024
Merged
feat(deps): bump remark-lint-strikethrough-marker from 2.1.2 to 3.0.0 #221
ybiquitous
merged 1 commit into
main
from
dependabot/npm_and_yarn/remark-lint-strikethrough-marker-3.0.0
May 1, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dependabot
bot
added
dependencies
Pull requests that update a dependency file
javascript
Pull requests that update Javascript code
labels
May 1, 2024
Diff between remark-lint-strikethrough-marker 2.1.2 and 3.0.0diff --git a/index.js b/index.js
index v2.1.2..v3.0.0 100644
--- a/index.js
+++ b/index.js
@@ -1,21 +1,52 @@
/**
- * ## When should I use this?
+ * remark-lint rule to warn when the number of GFM strikethrough markers are
+ * inconsistent.
*
- * You can use this package to check that the number of strikethrough
- * markers is consistent.
+ * ## What is this?
+ *
+ * This package checks the number of strikethrough markers.
* Strikethrough is a GFM feature enabled with
- * [`remark-gfm`](https://github.com/remarkjs/remark-gfm).
+ * [`remark-gfm`][github-remark-gfm].
*
+ * ## When should I use this?
+ *
+ * You can use this package to check that GFM strikethrough is consistent.
+ *
* ## API
*
- * The following options (default: `'consistent'`) are accepted:
+ * ### `unified().use(remarkLintStrikethroughMarker[, options])`
*
- * * `'~'`
- * — prefer one strikethrough marker
- * * `'~~'`
- * — prefer two strikethrough markers
- * * `'consistent'`
- * — detect the first used style and warn when further strikethrough differs
+ * Warn when the number of GFM strikethrough markers are inconsistent.
*
+ * ###### Parameters
+ *
+ * * `options` ([`Options`][api-options], default: `'consistent'`)
+ * — preferred style or whether to detect the first style and warn for
+ * further differences
+ *
+ * ###### Returns
+ *
+ * Transform ([`Transformer` from `unified`][github-unified-transformer]).
+ *
+ * ### `Marker`
+ *
+ * Marker (TypeScript type).
+ *
+ * ###### Type
+ *
+ * ```ts
+ * type Marker = '~~' | '~'
+ * ```
+ *
+ * ### `Options`
+ *
+ * Configuration (TypeScript type).
+ *
+ * ###### Type
+ *
+ * ```ts
+ * type Options = Marker | 'consistent'
+ * ```
+ *
* ## Recommendation
*
@@ -26,59 +57,60 @@
* ## Fix
*
- * [`remark-gfm`](https://github.com/remarkjs/remark-gfm)
- * formats all strikethrough with two tildes.
+ * [`remark-stringify`][github-remark-stringify] with
+ * [`remark-gfm`][github-remark-gfm] formats all strikethrough with two tildes.
*
+ * [api-marker]: #marker
+ * [api-options]: #options
+ * [api-remark-lint-strikethrough-marker]: #unifieduseremarklintstrikethroughmarker-options
+ * [github-remark-gfm]: https://github.com/remarkjs/remark-gfm
+ * [github-remark-stringify]: https://github.com/remarkjs/remark/tree/main/packages/remark-stringify
+ * [github-unified-transformer]: https://github.com/unifiedjs/unified#transformer
+ *
* @module strikethrough-marker
- * @summary
- * remark-lint rule to warn when the number of strikethrough markers
- * is inconsistent.
* @author Denis Augsburger
* @copyright 2021 Denis Augsburger
* @license MIT
+ *
* @example
- * {"config": "~", "name": "ok.md", "gfm": true}
+ * {"gfm": true, "label": "input", "name": "not-ok.md"}
*
- * ~foo~
- *
+ * ~Mercury~Venus and ~~Earth~~Mars.
* @example
- * {"config": "~", "name": "not-ok.md", "label": "input", "gfm": true}
+ * {"gfm": true, "label": "output", "name": "not-ok.md"}
*
- * ~~foo~~
+ * 1:20-1:29: Unexpected double tilde strikethrough sequences (`~~`), expected single tilde (`~`)
*
* @example
- * {"config": "~", "name": "not-ok.md", "label": "output", "gfm": true}
+ * {"config": "~", "gfm": true, "name": "ok.md"}
*
- * 1:1-1:8: Strikethrough should use `~` as a marker
+ * ~Mercury~Venus.
*
* @example
- * {"config": "~~", "name": "ok.md", "gfm": true}
+ * {"config": "~", "gfm": true, "label": "input", "name": "not-ok.md"}
*
- * ~~foo~~
- *
+ * ~~Mercury~~Venus.
* @example
- * {"config": "~~", "name": "not-ok.md", "label": "input", "gfm": true}
+ * {"config": "~", "gfm": true, "label": "output", "name": "not-ok.md"}
*
- * ~foo~
+ * 1:1-1:12: Unexpected double tilde strikethrough sequences (`~~`), expected single tilde (`~`)
*
* @example
- * {"config": "~~", "name": "not-ok.md", "label": "output", "gfm": true}
+ * {"config": "~~", "gfm": true, "name": "ok.md"}
*
- * 1:1-1:6: Strikethrough should use `~~` as a marker
+ * ~~Mercury~~Venus.
*
* @example
- * {"name": "not-ok.md", "label": "input", "gfm": true}
+ * {"config": "~~", "gfm": true, "label": "input", "name": "not-ok.md"}
*
- * ~~foo~~
- * ~bar~
- *
+ * ~Mercury~Venus.
* @example
- * {"name": "not-ok.md", "label": "output", "gfm": true}
+ * {"config": "~~", "gfm": true, "label": "output", "name": "not-ok.md"}
*
- * 2:1-2:6: Strikethrough should use `~~` as a marker
+ * 1:1-1:10: Unexpected single tilde strikethrough sequences (`~`), expected double tilde (`~~`)
*
* @example
- * {"config": "💩", "name": "not-ok.md", "label": "output", "positionless": true, "gfm": true}
+ * {"config": "🌍", "name": "not-ok.md", "label": "output", "positionless": true, "gfm": true}
*
- * 1:1: Incorrect strikethrough marker `💩`: use either `'consistent'`, `'~'`, or `'~~'`
+ * 1:1: Unexpected value `🌍` for `options`, expected `'~~'`, `'~'`, or `'consistent'`
*/
@@ -90,11 +122,13 @@
* @typedef {'~' | '~~'} Marker
* Styles.
- * @typedef {'consistent' | Marker} Options
- * Options.
+ *
+ * @typedef {Marker | 'consistent'} Options
+ * Configuration.
*/
import {lintRule} from 'unified-lint-rule'
-import {visit} from 'unist-util-visit'
import {pointStart} from 'unist-util-position'
+import {visitParents} from 'unist-util-visit-parents'
+import {VFileMessage} from 'vfile-message'
const remarkLintStrikethroughMarker = lintRule(
@@ -103,29 +137,66 @@
url: 'https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-strikethrough-marker#readme'
},
- /** @type {import('unified-lint-rule').Rule<Root, Options>} */
- (tree, file, option = 'consistent') => {
+ /**
+ * @param {Root} tree
+ * Tree.
+ * @param {Options | null | undefined} [options='consistent']
+ * Configuration (default: `'consistent'`).
+ * @returns {undefined}
+ * Nothing.
+ */
+ function (tree, file, options) {
const value = String(file)
+ /** @type {VFileMessage | undefined} */
+ let cause
+ /** @type {Marker | undefined} */
+ let expected
- if (option !== '~' && option !== '~~' && option !== 'consistent') {
+ if (options === null || options === undefined || options === 'consistent') {
+ // Empty.
+ } else if (options === '~~' || options === '~') {
+ expected = options
+ } else {
file.fail(
- 'Incorrect strikethrough marker `' +
- option +
- "`: use either `'consistent'`, `'~'`, or `'~~'`"
+ 'Unexpected value `' +
+ options +
+ "` for `options`, expected `'~~'`, `'~'`, or `'consistent'`"
)
}
- visit(tree, 'delete', (node) => {
- const start = pointStart(node).offset
+ visitParents(tree, 'delete', function (node, parents) {
+ const start = pointStart(node)
- if (typeof start === 'number') {
- const both = value.slice(start, start + 2)
- const marker = both === '~~' ? '~~' : '~'
+ if (start && typeof start.offset === 'number') {
+ /* c8 ignore next -- Weird AST. */
+ if (value.charAt(start.offset) !== '~') return
+ const actual = value.charAt(start.offset + 1) === '~' ? '~~' : '~'
- if (option === 'consistent') {
- option = marker
- } else if (marker !== option) {
- file.message(
- 'Strikethrough should use `' + option + '` as a marker',
- node
+ if (expected) {
+ if (actual !== expected) {
+ file.message(
+ 'Unexpected ' +
+ (actual === '~' ? 'single' : 'double') +
+ ' tilde strikethrough sequences (`' +
+ actual +
+ '`), expected ' +
+ (expected === '~' ? 'single' : 'double') +
+ ' tilde (`' +
+ expected +
+ '`)',
+ {ancestors: [...parents, node], cause, place: node.position}
+ )
+ }
+ } else {
+ expected = actual
+ cause = new VFileMessage(
+ "Strikethrough sequence style `'" +
+ actual +
+ "'` first defined for `'consistent'` here",
+ {
+ ancestors: [...parents, node],
+ place: node.position,
+ ruleId: 'strikethrough-marker',
+ source: 'remark-lint'
+ }
)
}
diff --git a/package.json b/package.json
index v2.1.2..v3.0.0 100644
--- a/package.json
+++ b/package.json
@@ -1,20 +1,17 @@
{
"name": "remark-lint-strikethrough-marker",
- "version": "2.1.2",
+ "version": "3.0.0",
"description": "remark-lint rule to warn when strikethrough markers violate the given style",
"license": "MIT",
"keywords": [
+ "lint",
+ "marker",
"remark",
- "lint",
+ "remark-lint",
+ "remark-lint-rule",
"rule",
- "remark-lint-rule",
- "strikethrough",
- "marker"
+ "strikethrough"
],
- "repository": {
- "type": "git",
- "url": "https://github.com/remarkjs/remark-lint",
- "directory": "packages/remark-lint-strikethrough-marker"
- },
+ "repository": "https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-strikethrough-marker",
"bugs": "https://github.com/remarkjs/remark-lint/issues",
"funding": {
@@ -24,29 +21,33 @@
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
"contributors": [
- "Denis Augsburger <denis.augsburger@simpleen.io> (https://simpleen.io)",
- "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
+ "Titus Wormer <tituswormer@gmail.com>"
],
"sideEffects": false,
"type": "module",
- "main": "index.js",
- "types": "index.d.ts",
+ "exports": "./index.js",
"files": [
"index.d.ts",
+ "index.d.ts.map",
"index.js"
],
"dependencies": {
- "@types/mdast": "^3.0.0",
- "unified": "^10.0.0",
- "unified-lint-rule": "^2.0.0",
- "unist-util-position": "^4.0.0",
- "unist-util-visit": "^4.0.0"
+ "@types/mdast": "^4.0.0",
+ "unified-lint-rule": "^3.0.0",
+ "unist-util-position": "^5.0.0",
+ "unist-util-visit-parents": "^6.0.0",
+ "vfile-message": "^4.0.0"
},
"scripts": {},
- "xo": false,
"typeCoverage": {
"atLeast": 100,
"detail": true,
- "strict": true,
- "ignoreCatch": true
+ "ignoreCatch": true,
+ "strict": true
+ },
+ "xo": {
+ "prettier": true,
+ "rules": {
+ "capitalized-comments": "off"
+ }
}
}
diff --git a/readme.md b/readme.md
index v2.1.2..v3.0.0 100644
--- a/readme.md
+++ b/readme.md
@@ -3,52 +3,52 @@
# remark-lint-strikethrough-marker
-[![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]
+[![Build][badge-build-image]][badge-build-url]
+[![Coverage][badge-coverage-image]][badge-coverage-url]
+[![Downloads][badge-downloads-image]][badge-downloads-url]
+[![Size][badge-size-image]][badge-size-url]
+[![Sponsors][badge-funding-sponsors-image]][badge-funding-url]
+[![Backers][badge-funding-backers-image]][badge-funding-url]
+[![Chat][badge-chat-image]][badge-chat-url]
-[`remark-lint`][mono] rule to warn when the number of strikethrough markers
-is inconsistent.
+[`remark-lint`][github-remark-lint] rule to warn when the number of GFM strikethrough markers are
+inconsistent.
## Contents
-* [What is this?](#what-is-this)
-* [When should I use this?](#when-should-i-use-this)
-* [Presets](#presets)
-* [Install](#install)
-* [Use](#use)
-* [API](#api)
- * [`unified().use(remarkLintStrikethroughMarker[, config])`](#unifieduseremarklintstrikethroughmarker-config)
-* [Recommendation](#recommendation)
-* [Fix](#fix)
-* [Examples](#examples)
-* [Compatibility](#compatibility)
-* [Contribute](#contribute)
-* [License](#license)
+* [What is this?](#what-is-this)
+* [When should I use this?](#when-should-i-use-this)
+* [Presets](#presets)
+* [Install](#install)
+* [Use](#use)
+* [API](#api)
+ * [`unified().use(remarkLintStrikethroughMarker[, options])`](#unifieduseremarklintstrikethroughmarker-options)
+ * [`Marker`](#marker)
+ * [`Options`](#options)
+* [Recommendation](#recommendation)
+* [Fix](#fix)
+* [Examples](#examples)
+* [Compatibility](#compatibility)
+* [Contribute](#contribute)
+* [License](#license)
## What is this?
-This package is a [unified][] ([remark][]) plugin, specifically a `remark-lint`
-rule.
-Lint rules check markdown code style.
+This package checks the number of strikethrough markers.
+Strikethrough is a GFM feature enabled with
+[`remark-gfm`][github-remark-gfm].
## When should I use this?
-You can use this package to check that the number of strikethrough
-markers is consistent.
-Strikethrough is a GFM feature enabled with
-[`remark-gfm`](https://github.com/remarkjs/remark-gfm).
+You can use this package to check that GFM strikethrough is consistent.
## Presets
-This rule is not included in a preset maintained here.
+This plugin is not included in presets maintained here.
## Install
-This package is [ESM only][esm].
-In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
+This package is [ESM only][github-gist-esm].
+In Node.js (version 16+),
+install with [npm][npm-install]:
```sh
@@ -56,15 +56,15 @@
```
-In Deno with [`esm.sh`][esmsh]:
+In Deno with [`esm.sh`][esm-sh]:
```js
-import remarkLintStrikethroughMarker from 'https://esm.sh/remark-lint-strikethrough-marker@2'
+import remarkLintStrikethroughMarker from 'https://esm.sh/remark-lint-strikethrough-marker@3'
```
-In browsers with [`esm.sh`][esmsh]:
+In browsers with [`esm.sh`][esm-sh]:
```html
<script type="module">
- import remarkLintStrikethroughMarker from 'https://esm.sh/remark-lint-strikethrough-marker@2?bundle'
+ import remarkLintStrikethroughMarker from 'https://esm.sh/remark-lint-strikethrough-marker@3?bundle'
</script>
```
@@ -75,20 +75,22 @@
```js
+import remarkLint from 'remark-lint'
+import remarkLintStrikethroughMarker from 'remark-lint-strikethrough-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'
-import {remark} from 'remark'
-import remarkLint from 'remark-lint'
-import remarkLintStrikethroughMarker from 'remark-lint-strikethrough-marker'
-main()
+const file = await read('example.md')
-async function main() {
- const file = await remark()
- .use(remarkLint)
- .use(remarkLintStrikethroughMarker)
- .process(await read('example.md'))
+await unified()
+ .use(remarkParse)
+ .use(remarkLint)
+ .use(remarkLintStrikethroughMarker)
+ .use(remarkStringify)
+ .process(file)
- console.error(reporter(file))
-}
+console.error(reporter(file))
```
@@ -96,5 +98,5 @@
```sh
-remark --use remark-lint --use remark-lint-strikethrough-marker example.md
+remark --frail --use remark-lint --use remark-lint-strikethrough-marker .
```
@@ -117,20 +119,44 @@
This package exports no identifiers.
-The default export is `remarkLintStrikethroughMarker`.
+It exports the [TypeScript][typescript] types
+[`Marker`][api-marker] and
+[`Options`][api-options].
+The default export is
+[`remarkLintStrikethroughMarker`][api-remark-lint-strikethrough-marker].
-### `unified().use(remarkLintStrikethroughMarker[, config])`
+### `unified().use(remarkLintStrikethroughMarker[, options])`
-This rule supports standard configuration that all remark lint rules accept
-(such as `false` to turn it off or `[1, options]` to configure it).
+Warn when the number of GFM strikethrough markers are inconsistent.
-The following options (default: `'consistent'`) are accepted:
+###### Parameters
-* `'~'`
- — prefer one strikethrough marker
-* `'~~'`
- — prefer two strikethrough markers
-* `'consistent'`
- — detect the first used style and warn when further strikethrough differs
+* `options` ([`Options`][api-options], default: `'consistent'`)
+ — preferred style or whether to detect the first style and warn for
+ further differences
+###### Returns
+
+Transform ([`Transformer` from `unified`][github-unified-transformer]).
+
+### `Marker`
+
+Marker (TypeScript type).
+
+###### Type
+
+```ts
+type Marker = '~~' | '~'
+```
+
+### `Options`
+
+Configuration (TypeScript type).
+
+###### Type
+
+```ts
+type Options = Marker | 'consistent'
+```
+
## Recommendation
@@ -141,9 +167,26 @@
## Fix
-[`remark-gfm`](https://github.com/remarkjs/remark-gfm)
-formats all strikethrough with two tildes.
+[`remark-stringify`][github-remark-stringify] with
+[`remark-gfm`][github-remark-gfm] formats all strikethrough with two tildes.
## Examples
+##### `not-ok.md`
+
+###### In
+
+> 👉 **Note**: this example uses
+> GFM ([`remark-gfm`][github-remark-gfm]).
+
+```markdown
+~Mercury~Venus and ~~Earth~~Mars.
+```
+
+###### Out
+
+```text
+1:20-1:29: Unexpected double tilde strikethrough sequences (`~~`), expected single tilde (`~`)
+```
+
##### `ok.md`
@@ -152,8 +195,9 @@
###### In
-> 👉 **Note**: this example uses GFM ([`remark-gfm`][gfm]).
+> 👉 **Note**: this example uses
+> GFM ([`remark-gfm`][github-remark-gfm]).
```markdown
-~foo~
+~Mercury~Venus.
```
@@ -168,8 +212,9 @@
###### In
-> 👉 **Note**: this example uses GFM ([`remark-gfm`][gfm]).
+> 👉 **Note**: this example uses
+> GFM ([`remark-gfm`][github-remark-gfm]).
```markdown
-~~foo~~
+~~Mercury~~Venus.
```
@@ -177,5 +222,5 @@
```text
-1:1-1:8: Strikethrough should use `~` as a marker
+1:1-1:12: Unexpected double tilde strikethrough sequences (`~~`), expected single tilde (`~`)
```
@@ -186,8 +231,9 @@
###### In
-> 👉 **Note**: this example uses GFM ([`remark-gfm`][gfm]).
+> 👉 **Note**: this example uses
+> GFM ([`remark-gfm`][github-remark-gfm]).
```markdown
-~~foo~~
+~~Mercury~~Venus.
```
@@ -202,8 +248,9 @@
###### In
-> 👉 **Note**: this example uses GFM ([`remark-gfm`][gfm]).
+> 👉 **Note**: this example uses
+> GFM ([`remark-gfm`][github-remark-gfm]).
```markdown
-~foo~
+~Mercury~Venus.
```
@@ -211,48 +258,35 @@
```text
-1:1-1:6: Strikethrough should use `~~` as a marker
+1:1-1:10: Unexpected single tilde strikethrough sequences (`~`), expected double tilde (`~~`)
```
##### `not-ok.md`
-###### In
+When configured with `'🌍'`.
-> 👉 **Note**: this example uses GFM ([`remark-gfm`][gfm]).
-
-```markdown
-~~foo~~
-~bar~
-```
-
###### Out
```text
-2:1-2:6: Strikethrough should use `~~` as a marker
+1:1: Unexpected value `🌍` for `options`, expected `'~~'`, `'~'`, or `'consistent'`
```
-##### `not-ok.md`
-
-When configured with `'💩'`.
-
-###### Out
-
-```text
-1:1: Incorrect strikethrough marker `💩`: use either `'consistent'`, `'~'`, or `'~~'`
-```
-
## Compatibility
-Projects maintained by the unified collective are compatible with all maintained
+Projects maintained by the unified collective are compatible with maintained
versions of Node.js.
-As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
-Our projects sometimes work with older versions, but this is not guaranteed.
+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-strikethrough-marker@3`,
+compatible with Node.js 16.
+
## Contribute
-See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways
+See [`contributing.md`][github-dotfiles-contributing] in [`remarkjs/.github`][github-dotfiles-health] for ways
to get started.
-See [`support.md`][support] for ways to get help.
+See [`support.md`][github-dotfiles-support] for ways to get help.
-This project has a [code of conduct][coc].
+This project has a [code of conduct][github-dotfiles-coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
@@ -260,55 +294,63 @@
## License
-[MIT][license] © [Titus Wormer][author]
+[MIT][file-license] © [Titus Wormer][author]
-[build-badge]: https://github.com/remarkjs/remark-lint/workflows/main/badge.svg
+[api-marker]: #marker
-[build]: https://github.com/remarkjs/remark-lint/actions
+[api-options]: #options
-[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg
+[api-remark-lint-strikethrough-marker]: #unifieduseremarklintstrikethroughmarker-options
-[coverage]: https://codecov.io/github/remarkjs/remark-lint
+[author]: https://wooorm.com
-[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-strikethrough-marker.svg
+[badge-build-image]: https://github.com/remarkjs/remark-lint/workflows/main/badge.svg
-[downloads]: https://www.npmjs.com/package/remark-lint-strikethrough-marker
+[badge-build-url]: https://github.com/remarkjs/remark-lint/actions
-[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-strikethrough-marker.svg
+[badge-chat-image]: https://img.shields.io/badge/chat-discussions-success.svg
-[size]: https://bundlephobia.com/result?p=remark-lint-strikethrough-marker
+[badge-chat-url]: https://github.com/remarkjs/remark/discussions
-[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
+[badge-coverage-image]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg
-[backers-badge]: https://opencollective.com/unified/backers/badge.svg
+[badge-coverage-url]: https://codecov.io/github/remarkjs/remark-lint
-[collective]: https://opencollective.com/unified
+[badge-downloads-image]: https://img.shields.io/npm/dm/remark-lint-strikethrough-marker.svg
-[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
+[badge-downloads-url]: https://www.npmjs.com/package/remark-lint-strikethrough-marker
-[chat]: https://github.com/remarkjs/remark/discussions
+[badge-funding-backers-image]: https://opencollective.com/unified/backers/badge.svg
-[unified]: https://github.com/unifiedjs/unified
+[badge-funding-sponsors-image]: https://opencollective.com/unified/sponsors/badge.svg
-[remark]: https://github.com/remarkjs/remark
+[badge-funding-url]: https://opencollective.com/unified
-[mono]: https://github.com/remarkjs/remark-lint
+[badge-size-image]: https://img.shields.io/bundlejs/size/remark-lint-strikethrough-marker
-[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+[badge-size-url]: https://bundlejs.com/?q=remark-lint-strikethrough-marker
-[esmsh]: https://esm.sh
+[esm-sh]: https://esm.sh
-[npm]: https://docs.npmjs.com/cli/install
+[file-license]: https://github.com/remarkjs/remark-lint/blob/main/license
-[health]: https://github.com/remarkjs/.github
+[github-dotfiles-coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
-[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md
+[github-dotfiles-contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md
-[support]: https://github.com/remarkjs/.github/blob/main/support.md
+[github-dotfiles-health]: https://github.com/remarkjs/.github
-[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
+[github-dotfiles-support]: https://github.com/remarkjs/.github/blob/main/support.md
-[license]: https://github.com/remarkjs/remark-lint/blob/main/license
+[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
-[author]: https://wooorm.com
+[github-remark-gfm]: https://github.com/remarkjs/remark-gfm
-[gfm]: https://github.com/remarkjs/remark-gfm
+[github-remark-lint]: https://github.com/remarkjs/remark-lint
+
+[github-remark-stringify]: https://github.com/remarkjs/remark/tree/main/packages/remark-stringify
+
+[github-unified-transformer]: https://github.com/unifiedjs/unified#transformer
+
+[npm-install]: https://docs.npmjs.com/cli/install
+
+[typescript]: https://www.typescriptlang.org
diff --git a/index.d.ts b/index.d.ts
index v2.1.2..v3.0.0 100644
--- a/index.d.ts
+++ b/index.d.ts
@@ -1,27 +1,15 @@
-export default remarkLintStrikethroughMarker
-export type Root = import('mdast').Root
+export default remarkLintStrikethroughMarker;
+export type Root = import('mdast').Root;
/**
* Styles.
*/
-export type Marker = '~' | '~~'
+export type Marker = '~' | '~~';
/**
- * Options.
+ * Configuration.
*/
-export type Options = 'consistent' | Marker
-declare const remarkLintStrikethroughMarker: import('unified').Plugin<
- | void[]
- | [
- | Options
- | [
- (
- | boolean
- | import('unified-lint-rule/lib/index.js').Label
- | import('unified-lint-rule/lib/index.js').Severity
- ),
- (Options | undefined)?
- ]
- | undefined
- ],
- import('mdast').Root,
- import('mdast').Root
->
+export type Options = Marker | 'consistent';
+declare const remarkLintStrikethroughMarker: {
+ (config?: import("../../node_modules/unified-lint-rule/lib/index.js").Label | import("../../node_modules/unified-lint-rule/lib/index.js").Severity | Options | [level: import("../../node_modules/unified-lint-rule/lib/index.js").Label | import("../../node_modules/unified-lint-rule/lib/index.js").Severity, option?: Options | null | undefined] | null | undefined): ((tree: import("mdast").Root, file: import("vfile").VFile, next: import("unified").TransformCallback<import("mdast").Root>) => undefined) | undefined;
+ readonly name: string;
+};
+//# sourceMappingURL=index.d.ts.map
\ No newline at end of file
diff --git a/index.d.ts.map b/index.d.ts.map
new file mode 100644
index v2.1.2..v3.0.0
--- a/index.d.ts.map
+++ b/index.d.ts.map
@@ -0,0 +1,1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":";mBAqHa,OAAO,OAAO,EAAE,IAAI;;;;qBAIpB,GAAG,GAAG,IAAI;;;;sBAGV,MAAM,GAAG,YAAY;AASlC;;;EAwEC"}
\ No newline at end of file
Command detailsnpm diff --diff=remark-lint-strikethrough-marker@2.1.2 --diff=remark-lint-strikethrough-marker@3.0.0 --diff-unified=2 See also the Reported by ybiquitous/npm-diff-action@v1.6.0 (Node.js 22.0.0 and npm 10.7.0) |
Bumps [remark-lint-strikethrough-marker](https://github.com/remarkjs/remark-lint) from 2.1.2 to 3.0.0. - [Release notes](https://github.com/remarkjs/remark-lint/releases) - [Changelog](https://github.com/remarkjs/remark-lint/blob/3.0.0/history.md) - [Commits](https://github.com/remarkjs/remark-lint/commits/3.0.0) --- updated-dependencies: - dependency-name: remark-lint-strikethrough-marker dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
dependabot
bot
force-pushed
the
dependabot/npm_and_yarn/remark-lint-strikethrough-marker-3.0.0
branch
from
May 1, 2024 16:37
ee318a5
to
3f8b27e
Compare
ybiquitous
changed the title
build(deps): bump remark-lint-strikethrough-marker from 2.1.2 to 3.0.0
feat(deps): bump remark-lint-strikethrough-marker from 2.1.2 to 3.0.0
May 1, 2024
ybiquitous
deleted the
dependabot/npm_and_yarn/remark-lint-strikethrough-marker-3.0.0
branch
May 1, 2024 16:41
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
dependencies
Pull requests that update a dependency file
javascript
Pull requests that update Javascript code
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bumps remark-lint-strikethrough-marker from 2.1.2 to 3.0.0.
Changelog
Sourced from remark-lint-strikethrough-marker's changelog.
... (truncated)
Commits
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebase
will rebase this PR@dependabot recreate
will recreate this PR, overwriting any edits that have been made to it@dependabot merge
will merge this PR after your CI passes on it@dependabot squash and merge
will squash and merge this PR after your CI passes on it@dependabot cancel merge
will cancel a previously requested merge and block automerging@dependabot reopen
will reopen this PR if it is closed@dependabot close
will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot show <dependency name> ignore conditions
will show all of the ignore conditions of the specified dependency@dependabot ignore this major version
will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor version
will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependency
will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)