syntax-tree / mdast

Markdown Abstract Syntax Tree format
https://unifiedjs.com
1.1k stars 45 forks source link

mdast@latest (3.0.0) npm package contains no code #38

Closed zeke closed 3 years ago

zeke commented 3 years ago

Hi @wooorm!

I'm trying to use the mdast package with npm install mdast. It appears that this package used to be an actual implementation of the parser, but now I'm just seeing the spec document for version 3.0.0:

Screen Shot 2021-02-27 at 5 00 21 PM

https://unpkg.com/browse/mdast@3.0.0/

Is this intended?

ChristianMurphy commented 3 years ago

@wooorm may be able to comment more on the intent, but I believe the docs are the intent from https://github.com/syntax-tree/unist/discussions/32. The parser now lives at https://github.com/syntax-tree/mdast-util-from-markdown for the AST. Or https://github.com/micromark/micromark or you want tokens, or don't need mdast transforms.

zeke commented 3 years ago

Thanks for the context @ChristianMurphy that's helpful.

Might be good to npm deprecate the mdast package so folks get a clarifying message when installing it.

wooorm commented 3 years ago

@zeke It is deprecated?

wooorm commented 3 years ago

It’s been 5 years since I pushed a major version, without code, and deprecated it. First pushing a major and then deprecating that is IMO a better experience, because folks will notice there’s a major when they’re ready to update, and then see that message pop up.

I’m guessing though, as it’s been 5 years since it’s been deprecated, that you’re on an old project and seeing a ton of deprecation message, so maybe missed this one?

zeke commented 3 years ago

Are you sure? I don't see a deprecation message:

$ mkdir mdast-test && cd mdast-test
$ echo "{}" > package.json
$ npm i mdast

npm WARN deprecated mdast@3.0.0: `mdast` was renamed to `remark`
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN mdast-test No description
npm WARN mdast-test No repository field.
npm WARN mdast-test No license field.

+ mdast@3.0.0
added 1 package from 1 contributor and audited 1 package in 0.645s
found 0 vulnerabilities
ChristianMurphy commented 3 years ago
npm WARN deprecated mdast@3.0.0: `mdast` was renamed to `remark`

looks like a deprecation notice to me?

zeke commented 3 years ago

Doh! Ignore me. 🙈