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

upgrade to marked@0.6.2 to fix audit #543

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

zachawilson
Copy link

No description provided.

@vvscode
Copy link

vvscode commented Apr 22, 2019

@h13i32maru

@woolfi182
Copy link

Pls, merge this PR

@lxsmnsyc
Copy link

lxsmnsyc commented May 7, 2019

any news about this?

@ematipico
Copy link

I don't think the author of the package has time to look after this project anymore (at least, not as before). Unless someone else picks it up, bugfixes are going to be slow/null.

@vvscode
Copy link

vvscode commented May 8, 2019

I've sent him a message in twitter

@gomesalexandre
Copy link

gomesalexandre commented May 16, 2019

Getting this error when trying to install this fork :

ENOENT: no such file or directory, chmod '/Users/alexandre/Sites/myRepo/packages/myPackage/node_modules/esdoc/out/src/ESDocCLI.js'

@rohan-deshpande
Copy link

I've sent him a message in twitter

Any response?

@bmaupin
Copy link
Contributor

bmaupin commented Jun 22, 2019

As far as I know only @h13i32maru can merge changes to this repo, which is why @MattMcFarland forked it at https://github.com/esdoc2/esdoc2

@jan-molak
Copy link
Contributor

jan-molak commented Jun 24, 2019

Sadly, the esdoc2 fork @bmaupin mentions hasn't seen an update in a year either.

Since I needed ESDoc to support TypeScript and monorepos, I have resorted to making a copy of esdoc-typescript-plugin and applying the patches locally on my project.
Using local esdoc plugins turned out to be quite easy and you can see an example here.

I hope that @h13i32maru picks up ESDoc again or adds contributors to this repo, but in the meantime, you can consider using my "local patch/hack" approach.

@bmaupin
Copy link
Contributor

bmaupin commented Jun 26, 2019

I'll probably be doing future work with TypeScript and typedoc, which thankfully seems to be well maintained. Although unfortunately that doesn't help for existing projects using esdoc unless I want to take the time to convert them.

@rohan-deshpande
Copy link

rohan-deshpande commented Jul 7, 2019

I wrote a simple bash script to work around this, since you just need the generated docs really, install all your esdoc dependencies, build your docs and then just uninstall them

In my package.json:

"scripts": { 
  "docs:build": "./scripts/docs-build"
}

The contents of ./scripts/docs-build:

ESDOC="esdoc esdoc-ecmascript-proposal-plugin esdoc-standard-plugin"

npm i $ESDOC -D
./node_modules/.bin/esdoc
npm uninstall $ESDOC -D

@vvscode
Copy link

vvscode commented Jul 8, 2019

@rohan-deshpande maybe it's easier to use npx ? )) in that case you're not adding it to deps at all

just

npx esdoc

@rohan-deshpande
Copy link

@vvscode This is a good solution but I need the plugins, not sure you can use npx and include those, also unsure if it would recognise the esdoc.json in the root directory but maybe!

davidjb added a commit to davidjb/sequelize that referenced this pull request Oct 2, 2019
These were previously being rendered via esdoc (which uses marked's
autolink rendering) as `mailto:` links.  There are some
[suggestions](https://gist.github.com/alexpeattie/4729247) about how one
might disable or avoid autolinking but in this case the package
identifiers are in backticks, producing weird behaviour similar to
markedjs/marked#1327.

Assuming the fix attached to this latter issue applied in this case,
then a dependency upgrade of `marked` within `esdoc` might solve the
problem, but there are [maintenance
issues](esdoc/esdoc#543) there.

Until that arrives, this is a workaround to avoiding the weird `mailto:`
links on this page.
davidjb added a commit to davidjb/sequelize that referenced this pull request Oct 2, 2019
These were previously being rendered via esdoc (which uses marked's
autolink rendering) as `mailto:` links.  There are some
[suggestions](https://gist.github.com/alexpeattie/4729247) about how one
might disable or avoid autolinking but in this case the package
identifiers are in backticks, producing weird behaviour similar to
markedjs/marked#1327.

Assuming the fix attached to this latter issue applied in this case,
then a dependency upgrade of `marked` within `esdoc` might solve the
problem, but there are [maintenance
issues](esdoc/esdoc#543) there.

Until that arrives, this is a workaround to avoiding the weird `mailto:`
links on this page.
@DanielRuf
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

10 participants