feat: copy LICENSE file from monorepo root on pack #6366
Conversation
|
Hey @merceyz @arcanis, sorry for the ping. I believe this feature requires a breaking change. It's not super crucial, just a feature of pnpm that would be nice to have in Yarn. So I'm happy to keep this PR open and wait for the next available major release slot if you guys think that's the best way to go 🙏. |
| const files = paths.map(path => ({file: path, source: ppath.resolve(workspace.cwd, path)})); | ||
|
|
||
| if (workspace.cwd !== project.cwd) { | ||
| const workspaceHasLicense = paths.some(path => path.match(LICENSE_PATTERN)); |
There was a problem hiding this comment.
Hardcoding something about LICENSE files in this function feels a little too specific. Perhaps instead the files set via the files parameter should all be case insensitive?
There was a problem hiding this comment.
Hey @arcanis the regex is case-insensitive. Also, in this case, it's a little hard to reduce specificity because what we are doing is so specific :p. Would love any suggestion for alternatives.
| const normalizedFiles = files?.map(file => typeof file === `string` | ||
| ? {file, source: ppath.resolve(workspace.cwd, file)} |
There was a problem hiding this comment.
I'd suggest to make source a string parameter (and to read the content of the license file outside of the genPackStream function); this way it gives us a way to generate files within the archive that don't necessarily exist on disk (for example if we wanted to generate the LICENSE file from the SPDX code).
There was a problem hiding this comment.
I believe source is already is a string because PortablePath is in fact a string. I'm not too aware of the differences between the 2 though.
Also because I'm not too familiar with how gzip and tar works. Can give me further guidance on where the inclusion of LICENSE files should happen instead? Are you suggesting that genPackStream should also accept something like { file: PortablePath, content: string | Buffer }?
|
@arcanis any updates regarding the feedbacks? 🙏 |
What's the problem this PR addresses?
#6359
How did you fix it?
Add workspace root LICENSE via
genPackList&genPackStream.Checklist