Skip to content

Common Errors Index #34

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

Closed
bishopZ opened this issue Jul 9, 2016 · 5 comments
Closed

Common Errors Index #34

bishopZ opened this issue Jul 9, 2016 · 5 comments

Comments

@bishopZ
Copy link

bishopZ commented Jul 9, 2016

Searching for webpack errors on stackoverflow is more difficult than with other libraries because the error messages are often very opaque, and they use common words that are also used by other build systems and libraries.

I would love to write a document like "twenty possible reasons you might get the error 'Module could not be built'".

I envision the page as a list of common error message. Under each one we would catalogue the various reasons why that error might occur.

@pksjce
Copy link

pksjce commented Jul 9, 2016

Have you considered webpack-validator? It is supposed to statically analyse the config and show possible errors in the build.

@jhnns
Copy link
Member

jhnns commented Jul 13, 2016

I really like this idea. Many confusing error messages and warnings can have simple answers, like:

  • Module build failed
  • Module not found
  • Critical dependencies

However, we should also think about changing the actual error messages. If they can be improved, that's the first step.

@bishopZ
Copy link
Author

bishopZ commented Aug 2, 2016

I am on Webpack Gitter Chat right now. There are two people getting the error "Cannot find module." Both have exhausted all troubleshooting options. I have found multiple unanswered stack questions with the same error.

@bebraw bebraw added this to the webpack 2 Post-release Milestone milestone Nov 23, 2016
dear-lizhihua referenced this issue in docschina/webpack.js.org Jan 8, 2017
Translation of splitting-codes
hzuhyb pushed a commit to hzuhyb/webpack.js.org that referenced this issue Jan 24, 2017
@skipjack skipjack changed the title (docs) Index of common error messages and possible solutions Common Errors Index May 22, 2017
@skipjack
Copy link
Collaborator

This could be somewhat similar to glossary page @rouzbeh84 is currently working in #1223...

However, we should also think about changing the actual error messages. If they can be improved, that's the first step.

I think this definitely key. One of the great things about react is the detailed error messages and links from the error message itself to the piece of documentation that relates to it. We could probably link to the index or other places in the docs from these error message.

@bishopZ if you're still interested in submitting a pr for this page I'd be happy to facilitate the process.

@skipjack
Copy link
Collaborator

skipjack commented Jun 12, 2017

I'm going to close as there are now multiple places where actual error messages are mentioned in the parts of the documentation where they apply. Seeing that we have a search bar, I think they are easily discoverable and, if we started linking to bits of the docs in the error messages themselves, I think we'd be in a pretty good place. If people still feel strongly about this and have the time to tackle it I'd be happy to re-open and facilitate.

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

No branches or pull requests

5 participants