-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
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
[Core] Improve import path for published lib #3921
Conversation
1cb0817
to
bf5fb08
Compare
"coverage": "npm run test", | ||
"coverage:combine": "istanbul report --dir test/coverage/combined --include test/**/*coverage.json text-summary lcovonly json", | ||
"lint": "eslint src docs/src test/browser test/unit && echo \"eslint: no lint errors\"", | ||
"prebuild": "rimraf lib", | ||
"prepublish": "in-publish && npm run build || not-in-publish", | ||
"prebuild": "npm run clean:build", |
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.
Noticed the cleaning is also in the build
"script"
50bc057
to
164a2ae
Compare
"keywords": [ | ||
"react", | ||
"react-component", | ||
"material design", | ||
"material-ui", | ||
"material ui" |
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.
I think that was there to aide search in npmjs for "material ui", but maybe it works anyway with the hyphenated version?
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.
As far as I have used the npm search tool, I have notices that every character matters. Especialy a -
. I think that it's better to keep both keywords.
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.
Woops, I thought this was a duplicate when I first read it, I didn't even see the -
difference.
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.
Let's just be safe and go with @oliviertassinari 's findings.
@nathanmarks - this looks great! |
@mbrookes done that thing! |
@mbrookes should I squash this now? |
This looks good, let's squash and merge @nathanmarks. |
@newoga we'll need to update the |
Yes, in the past @alitaheri has graciously taken on the task for preparing releases, including updating README, changelog, release notes, etc. We'll make sure to do that before official release and publish, I think this is good for now. And I agree we should try to get in @oliviertassinari's codemod before releasing too. |
b47b99f
to
adac3a2
Compare
Improves the import path by creating a package.json inside the build directory so the library can be published with a flattened root folder. The lib root package.json is transformed into a minimal version and the README, CHANGELOG and LICENSE are copied over. Resolves: mui#2679
adac3a2
to
15a57aa
Compare
Squashed it |
@newoga I'm still around, just a bit busy recently 😅 😅. I can take care of the release if you guys are ok with it, it's no trouble 😁 |
That's what I like to hear @alitaheri, you do a great job with it so that would be awesome! 👍 🎉 (And I've been busy too recently, no worries! 😄 ) |
😄 Alright, I'll take care of it as before. Just ping me when it's good to go 😁 |
@alitaheri Awesome, thanks! |
Yeah, 😆 Thanks 😁 😁 |
Anything else needed to get this merged? |
I think this is ready! |
This addresses #2679 by copying a minimal
package.json
along with theREADME.md
,CHANGELOG.md
andLICENSE
to the build folder after the JS files have been babel'd.I added a script to copy the files and put it under
./scripts/
, I also moved thesvg-icon
index generator script there.I haven't added any tests to confirm the output from
npm run build
, but can definitely do so if this is the setup we move forward with.Let me know if there's anything we need to move over that I forgot...!