-
Notifications
You must be signed in to change notification settings - Fork 409
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
[WIP] Add support for missing README files and other README file extensions #420
Conversation
d636dd3
to
237ead1
Compare
Build is failing due to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this case, we should probably check whether the file exists or not, or else if there is no README.md file at all, we will return an error, which shouldn't be the case. So I don't think we want this particular change. Does this pass tests? If so, we should have a test for building without a README.md file.
This also made me realize that we don't handle arbitrary README files, so I filed #421
Sure thing -- sounds good to me! I updated the title of the PR to reflect this change in direction. |
one thing to share- we should not error if the readme is missing. only warn. |
After reading the associated issue I want to warn that npm does not support these Readme files so i'm not entirely sure that we should? I am curious why you thought this was a bug @fitzgen |
I had no idea npm doesn't support non-md READMEs! This was motivated by github's support for other kinds of READMEs, which means that some projects use that support. It is perhaps worth reconsidering if npm doesn't allow it, though! |
Sorry for the delay but I have everything ready to be pushed up and reviewed now. Is this something we still want or should we close this for now since NPM doesn't support anything except for .md files? |
for the moment i think we should close this as npm doesn't support other README file extensions. if there's a usecase for supporting other README file extensions, and a way to make sure folks aren't confused about npm not supporting the other formats, i'm open to hearing it! |
Based on feedback from @fitzgen on #411 I went back and updated the copying of the README.md file to propagate the error as well if one occurs. I had referenced that functionality in writing the license copy so I figured it would be good to go back and update that one as well.
Make sure these boxes are checked! 📦✅
rustfmt
installed and have yourcloned directory set to nightly
$ rustup override set nightly $ rustup component add rustfmt-preview --toolchain nightly
rustfmt
on the code base before submitting✨✨ 😄 Thanks so much for contributing to wasm-pack! 😄 ✨✨