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

docs(README): npm link instructions #511

Merged
merged 1 commit into from
Jul 10, 2022
Merged

Conversation

wesleyboar
Copy link
Member

@wesleyboar wesleyboar commented Jul 10, 2022

Overview

Improve/Fix NPM link instructions.

  1. Current commands listed are not working and are not what I use successfully.
    • I always add --save-dev to the npm link command and remember not to commit the package.json change.
  2. Core-Styles has recently moved to a new repo.
  3. I found https://hirok.io/posts/avoid-npm-link, which suggests npx link.

Related

None

Changes

Testing

Run these commands (change path-to/core-styles). Expect no errors.

npm ci
npx link path-to/core-styles # e.g. npx link ../tup-ui/libs/core-styles
npm run build

Notes

This does not fix all problems, like "de-duping", but it's better than what was in here.

- core-styles repo has moved
- current commands listed are not working

I always add --save-dev to npm link command, then remember not to commit temp change to package.json.

I found https://hirok.io/posts/avoid-npm-link, which suggests npx link.
@wesleyboar wesleyboar marked this pull request as ready for review July 10, 2022 22:26
@wesleyboar wesleyboar merged commit 352668c into main Jul 10, 2022
@wesleyboar wesleyboar deleted the fix/npm-link-instructions branch July 10, 2022 22:46
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.

1 participant