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($markdown): notify error when not found snippet #1872 #1910

Merged
merged 2 commits into from
Oct 11, 2019

Conversation

ivandevp
Copy link
Contributor

@ivandevp ivandevp commented Oct 3, 2019

Summary

Fix #1872

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

@kefranabg
Copy link
Collaborator

Hi @ivandevp, thanks for your PR. From your comment in the related issue, I'm not sure to understand this:

I haven't found a way to throw an error in other plugins used in the codebase

Do you mean that you did not found a better way to throw an error than with logger.error?

token.info = ''
logger.error(errorMessage)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think temp variable is really useful here. Error log message can also be improved (now that it's also log in the server console)

Here is a suggestion

token.content = `Code snippet path not found: ${src}`
token.info = ''
logger.error(token.content)

@ivandevp
Copy link
Contributor Author

ivandevp commented Oct 7, 2019

Thanks for the suggestion @kefranabg. I've just made the changes. And regarding

Do you mean that you did not found a better way to throw an error than with logger.error?

Not exactly. In the issue the description mentioned to fail the render, so I wasn't sure if just showing the error log is enough. I think it can work good in a CI/CD env.

@kefranabg
Copy link
Collaborator

Calling logger.error will exit process with error code on production mode (vuepress build), so it will fail on CI/CD. In dev mode (vuepress dev), it will just print error in the console.

What you did looks good to me

@ulivz ulivz merged commit 6aaa7d7 into vuejs:master Oct 11, 2019
@vue-bot
Copy link

vue-bot commented Oct 11, 2019

Hey @ivandevp, thank you for your time and effort spent on this PR, contributions like yours help make Vue better for everyone. Cheers! 💚

@meichstedt
Copy link

Thank you @ivandevp for implementing this ❤️

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.

Vuepress should fail if imported code snippets is not found
5 participants