micromark / micromark-extension-gfm-strikethrough Goto Github PK

Subject of the issue

try to roundtrip the following mdast:

root[1]
└─0 heading[4]
    │ depth: 2
    ├─0 text "Hello, "
    ├─1 delete[1]
    │   └─0 text "world."
    ├─2 text " stray "
    └─3 delete[0]

stringify produces:

## Hello, ~~world.~~ stray ~~~~

parsing this again produces:

root[1] (1:1-2:1, 0-32)
└─0 heading[3] (1:1-1:32, 0-31)
    │ depth: 2
    ├─0 text "Hello, " (1:4-1:11, 3-10)
    ├─1 delete[1] (1:11-1:21, 10-20)
    │   └─0 text "world." (1:13-1:19, 12-18)
    └─2 text " stray ~~~~" (1:21-1:32, 20-31)

Your environment

$ npm ls --depth 0
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
└── [email protected]

Steps to reproduce

const remark = require('remark-parse');
const stringify = require('remark-stringify');
const unified = require('unified');
const gfm = require('remark-gfm');
const inspect = require('unist-util-inspect');
const {
  root,
  text,
  heading,
  strike,
} = require('mdast-builder');

const mdast = root([
  heading(2, [
    text('Hello, '),
    strike(text('world.')),
    text(' stray '),
    strike([])
  ]),
]);

console.log('original:')
console.log(inspect(mdast));

const doc = unified()
  .use(stringify)
  .use(gfm)
  .stringify(mdast);

console.log('markdown:')
console.log(doc);

const mdast2 = unified()
  .use(remark)
  .use(gfm)
  .parse(doc);


console.log('roundtripped:')
console.log(inspect(mdast2));

Expected behavior

the empty strikethrough node should not be lost when reparsing.

Actual behavior

the empty strikethrough node is converted to text.

Workaround

since the empty strikethrough nodes have no semantic meaning, they could be removed from the mdast prior to serialization, or suppressed by gfm-to-markdown automatically.

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Affected packages and versions

1.0.7

Link to runnable example

No response

Steps to reproduce

Install the latest version

Expected behavior

It should run fine there should not be any issues while building the project

Actual behavior

I had some dependency issues so I deleted the yarn.lock file and re-installed everything, but some of the packages depend internally on this package, and since deleting yarn.lock file caused the internal packages to go to the latest version in this case from 1.0.1 to 1.0.7 and it started to fail the build of the project. Here are the errors I am getting.

"../../node_modules/micromark-extension-gfm-footnote/index.d.ts(5,8): error TS1005: ',' expected.\n" +
    "../../node_modules/micromark-extension-gfm-footnote/index.d.ts(6,8): error TS1005: ',' expected.\n" +
    "../../node_modules/micromark-extension-gfm-strikethrough/index.d.ts(2,32): error TS1005: ',' expected

While I know this is a bit cryptic but since you released the 1.0.7 just today can you check why its happening?

The dependency which is causing the issue:
[email protected]#[email protected]#[email protected]

Runtime

Node v14

Package manager

yarn v1

OS

macOS

Build and bundle tools

Webpack