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

refactor(package.json & contributing.md): add pnpm link.dist script #474

Merged
merged 2 commits into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Discussing the design up front helps to ensure that we're ready to accept your w

<br/>

### ▶ 3. Fork the this repo and create a branch.
### ▶ 3. Fork this repo and create a branch.

- Hit that "Fork" button above (in this repo's github page).

Expand Down Expand Up @@ -165,3 +165,28 @@ After your pull request is merged, you can safely delete your branch and pull th
### ▶ 11. That's it! Thank you for your contribution! 🙏💓

[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#

<br/>

## Running in your own app

Sometimes you may not face an issue after running the build process, but your consumer app still might.

When that is the case, you can use `pnpm link` to link your own app to your forked version of qwik-ui.

### ▶ 1. Link your fork

Inside the root of your `qwik-ui` branch run:

```
pnpm link.dist
```

### ▶ 2. Link your app

Inside the root of your project run:

```
pnpm install
pnpm link --global @qwik-ui/headless
```
13 changes: 7 additions & 6 deletions package.json
Copy link
Contributor Author

Choose a reason for hiding this comment

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

just re-organized by alphabetical order and added "link.dist"

Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,18 @@
"private": false,
"type": "module",
"scripts": {
"build:headless": "nx build headless",
"commit": "git-cz",
"format:fix": "pretty-quick --staged",
"prepare": "husky install",
"build:headless": "nx build headless",
"link.dist": "cd packages/kit-headless/dist && pnpm link --global",
"lint": "nx affected:lint",
"test:headless": "nx component-test headless",
"test:headless:ci": "nx component-test-ci headless",
"local:npm": "nx local-registry",
"prepare": "husky install",
"story:build:headless": "nx build-storybook headless",
"story:headless": "nx storybook headless",
"website": "nx serve website",
"local:npm": "nx local-registry"
"test:headless": "nx component-test headless",
"test:headless:ci": "nx component-test-ci headless",
"website": "nx serve website"
},
"packageManager": "[email protected]",
"devDependencies": {
Expand Down
Loading