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.

Sign up for GitHub

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

Jump to bottom

feat: improve error messages when the project is missing a LICENSE or a README.md #61

Merged
merged 3 commits into from
Jul 14, 2020
Merged

feat: improve error messages when the project is missing a LICENSE or a README.md #61

merged 3 commits into from
Jul 14, 2020

Conversation

marcelltoth
Copy link
Contributor

@marcelltoth marcelltoth commented Jul 13, 2020 •
edited
Loading

Background

Not having a LICENSE or a README.md file in a repo results in ugly error messages. This is a PR to make the DX better in this regard.

Before

image

After

image

@marcelltoth marcelltoth requested review from marbemac and a team July 13, 2020 15:37
@marcelltoth marcelltoth self-assigned this Jul 13, 2020
@marcelltoth
Copy link
Contributor Author

marcelltoth commented Jul 13, 2020 •
edited
Loading

The lock diff is an unknown to me. I suspect there was a bit of garbage left there because people don't usually yarn here at all. I can revert it if you say so.

@billiegoose
Copy link
Contributor

Eh... I'm skeptical that you can legally satisfy the requirements of the license without actually having a LICENSE.txt file in your repo. I don't want to touch this debate without a lawyer though lol.

@marcelltoth
Copy link
Contributor Author

Eh... I'm skeptical that you can legally satisfy the requirements of the license without actually having a LICENSE.txt file in your repo. I don't want to touch this debate without a lawyer though lol.

You are right. I didn't think about this. Even though npm is OK with the SPDX identifier, most licenses do explicitly require packaging the license text along with the distributable.

Let me repurpose this PR so instead of making them optional, it improves the error messages. See updated description

@marcelltoth marcelltoth changed the title feat: make LICENSE file optional when building feat: improve error messages when the project is missing a LICENSE or a README.md Jul 14, 2020
billiegoose
billiegoose approved these changes Jul 14, 2020
View reviewed changes
Copy link
Contributor

@billiegoose billiegoose left a comment

Choose a reason for hiding this comment

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

😍

@billiegoose billiegoose merged commit 565b2cf into master Jul 14, 2020
@billiegoose billiegoose deleted the feat/optional-license branch July 14, 2020 16:01
@stoplight-bot
Copy link
Collaborator

🎉 This PR is included in version 8.2.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@billiegoose billiegoose billiegoose approved these changes

@marbemac marbemac Awaiting requested review from marbemac

Assignees

@marcelltoth marcelltoth

Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@marcelltoth @billiegoose @stoplight-bot