-
-
Notifications
You must be signed in to change notification settings - Fork 375
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
Include readme in npm tarball #806
Conversation
package.json
Outdated
"lint": "eslint ." | ||
"lint": "eslint .", | ||
"prepack": "cp README.md packages/cli/", | ||
"postpack": "rm packages/cli/README.md" |
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.
don't think cp and rm work properly on windows
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.
They're usually used throughout package.json scripts. Should be fine imo
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.
A lot of package.json scripts blow up on windows due to Unix shell commands. I'd recommend testing.
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.
Adding a cp
script under windows 10 bails for me (launched from powershell within vscode) with:
'cp' is not recognized as an internal or external command,
operable program or batch file.
There are various packages you can depend on that let you npx these commands, though.
cp-cli, and rm-cli, for example. Also be aware that cmd1 && cmd2
doesn't seem to work under windows either.
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.
&&
works because npm uses cmd in the background afaik
we're already using rimraf
so might as well use that here and then some non bloated copy cli (looking at cpy-cli
)
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'll push to this later
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.
^
Not even a new dep with that |
Currently it's not included, since the readme is in the repo root.
I wasn't sure if the publishing process happens from within
packages/cli
or the root.https://www.npmjs.com/package/preact-cli/v/3.0.0-rc.2