Skip to content

Commit

Permalink
chore: adding instructions to yalc use (#813)
Browse files Browse the repository at this point in the history
  • Loading branch information
rssilva authored Jul 19, 2023
1 parent 08fb443 commit 29fee1a
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 5 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,32 @@ feat(theme): your commit message goes here
This will help Changesets determine which package `CHANGELOG.md` file to update.
If you are commiting to multiple packages in a single PR, please rebase and
merge the final commits for each package.

## Using locally

install [yalc](https://github.com/wclr/yalc)

```
npm install yalc -g
```

go to the Pluto packages/ folders you need updated locally, for example

**Step 1**

```
cd path_to_pluto_folder/packages/components && yarn build && yalc publish
cd path_to_pluto_folder/packages/theme && yarn build && yalc publish
```

go to the folder of the project that uses Pluto and run

```
yalc link @localyze-pluto/components
```

now every time you do a change you can repeat **Step 1** and then, on the folder of the project that uses Pluto

```
yalc update @localyze-pluto/components
```
18 changes: 13 additions & 5 deletions cspell.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
{
"version": "0.2",
"language": "en",
"words": ["localyze", "localitos"],
"words": [
"localyze",
"localitos"
],
"ignoreWords": [
"eamodio",
"dbaeumer",
Expand All @@ -26,9 +29,12 @@
"uppy",
"formik",
"nextjs",
"lucide"
"lucide",
"yalc"
],
"flagWords": [
"hte"
],
"flagWords": ["hte"],
"allowCompoundWords": true,
"ignorePaths": [
"**/node_modules/**",
Expand All @@ -44,7 +50,9 @@
"overrides": [
{
"filename": "**/{stories,spec,test}.{ts,tsx,js,jsx}",
"dictionaries": ["lorem-ipsum"]
"dictionaries": [
"lorem-ipsum"
]
}
]
}
}

0 comments on commit 29fee1a

Please sign in to comment.