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.

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

Merged
merged 2 commits into from
Jun 7, 2019
Merged

Include readme in npm tarball #806

merged 2 commits into from
Jun 7, 2019

Conversation

developit
Copy link
Member

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

package.json Outdated
"lint": "eslint ."
"lint": "eslint .",
"prepack": "cp README.md packages/cli/",
"postpack": "rm packages/cli/README.md"
Copy link
Member

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

Copy link
Member

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

Copy link

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.

Copy link

@mseddon mseddon Jun 3, 2019

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.

Copy link
Member

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)

Copy link
Member

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

Copy link
Member

@ForsakenHarmony ForsakenHarmony left a comment

Choose a reason for hiding this comment

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

^

@ForsakenHarmony
Copy link
Member

Not even a new dep with that

@ForsakenHarmony ForsakenHarmony merged commit b7e19e2 into master Jun 7, 2019
@prateekbh prateekbh deleted the monorepo-readme branch June 7, 2019 00:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants