Skip to content
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

fix(deps): rm jsdoc-to-markdown (vulnerable dep) #144

Merged
merged 2 commits into from
Oct 18, 2022

Conversation

DerekNonGeneric
Copy link
Member

I am removing this dependency because it depends on unmaintained and vulnerable dependencies. One of them is the package put out by the JSDoc project, which has seemingly been abandoned. The package they used to publish now depends on a module w/ a CVE. To make matters worse, that vulnerable module has also been abandoned and does not appear to have any planned fixes. We can't wait for that whole ecosystem, so let's eliminate this dependency tree.

Refs: jsdoc/jsdoc#2013

Signed-off-by: Derek Lewis DerekNonGeneric@inf.is

/cc @jorgebucaran @smorimoto @yuvilio @septs as y'all might like to know — we're looking for a new docs generator (suggestions welcome)

Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
@DerekNonGeneric
Copy link
Member Author

ESDoc looks like a somewhat nice replacement for this but appears not to be able to understand the type space being proposed in the TC39 proposal for type annotations. That means that we would have to continue specifying them in the comment above the function signature and the type space after the colon.

I was not a fan of doing that previously but thought to bring it to y'all's attention (just found out about it myself).

Features

Generates good documentation.
Measures documentation coverage.
Integrate test codes into documentation.
Integrate manual into documentation.
Parse ECMAScript proposals.
Add custom features by [plugin architecture](https://github.com/esdoc/esdoc-plugins)
[ESDoc Hosting Service](https://doc.esdoc.org/)

@DerekNonGeneric DerekNonGeneric added discuss Issues opened for discussions and feedbacks. needs-decision Needs a decision labels Oct 18, 2022
@DerekNonGeneric DerekNonGeneric added this to the Version 3.0 milestone Oct 18, 2022
@DerekNonGeneric
Copy link
Member Author

We can hopefully continue to discuss in this thread and/or surface anything else relevant, but i am going to get this landed now since there is nothing really blocking it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build dependencies deps-dev discuss Issues opened for discussions and feedbacks. documentation needs-decision Needs a decision
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants