Merge branch 'main' into feat/composition-component-structure

kadena-community · Aug 31, 2023 · 6c3df79 · 6c3df79
2 parents a8bee2f + 6119906
commit 6c3df79
Show file tree

Hide file tree

Showing 41 changed files with 383 additions and 1,112 deletions.
diff --git a/.changeset/clean-buttons-try.md b/.changeset/clean-buttons-try.md
@@ -0,0 +1,6 @@
+---
+"@kadena/client-examples": none
+"@kadena/client": none
+---
+
+Housekeeping after tooling migration
diff --git a/.changeset/gorgeous-ducks-explode.md b/.changeset/gorgeous-ducks-explode.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/.changeset/violet-keys-poke.md b/.changeset/violet-keys-poke.md
@@ -0,0 +1,7 @@
+---
+'@kadena/react-ui': none
+---
+
+Updated the Link and Breadcrumb components to have the option to pass props and
+styles to a child component via an asChild prop. This is the new convention we
+are using for cases when we need to support external links like next/link
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -5,20 +5,19 @@
 /common                                         @alber70g @webpro
 /common/config/rush/pnpm-lock.yaml
 /common/config/rush/repo-state.json
-/packages/apps/graph                            @alber70g @webpro
+/packages/apps/graph                            @alber70g
 /packages/apps/kadena-docs                      @sstraatemans @eileenmguo @realdreamer
 
 /packages/libs/chainweb-stream-client           @Takadenoshi
 
-/packages/libs/bootstrap-lib                    @alber70g @webpro
+/packages/libs/bootstrap-lib                    @alber70g
 /packages/libs/client                           @alber70g @javadkh2 @webpro
-/packages/libs/kadena.js                        @alber70g @webpro
-/packages/libs/pactjs-generator                 @alber70g @webpro
+/packages/libs/kadena.js                        @alber70g
+/packages/libs/pactjs-generator                 @alber70g
 /packages/libs/react-ui                         @eileenmguo @sstraatemans @timoheddes
-/packages/libs/types                            @alber70g @webpro
-/packages/tools/pactjs-cli                      @alber70g @webpro
-/packages/tools/eslint-config                   @alber70g @webpro
-/packages/tools/eslint-plugin                   @alber70g @webpro
-/packages/tools/heft-rig                        @alber70g @webpro
+/packages/libs/types                            @alber70g
+/packages/tools/pactjs-cli                      @alber70g
+/packages/tools/eslint-config                   @alber70g
+/packages/tools/eslint-plugin                   @alber70g
+/packages/tools/heft-rig                        @alber70g
 /packages/tools/remark-plugins                  @webpro
-/packages/tools/rush-fix-versions               @alber70g @webpro
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -43,9 +43,8 @@ pnpm run test --watch   # Keep running tests during development
 
 ## Making a Pull Request
 
-Before making a pull request, please discuss your ideas first.
-
-TODO
+Before making a pull request, please discuss your ideas first. This will
+optimize your time and the review process.
 
 ## Conventions
 
@@ -74,6 +73,8 @@ pnpm format  # Format (using Prettier)
 Run from root to apply to all packages, use `--filter` for a selection, and run
 from any package folder to apply it only there.
 
+See [Filters][6] for more details.
+
 For everything else, please discuss.
 
 ## Workflow
@@ -90,31 +91,31 @@ To publish a new version of updated packages, please make sure you:
 - have push rights to this repository's `main` branch
 - are on a clean `main` branch
 
-Steps:
+We're using [Changesets][7] for our release process. The manual process in [How
+do I run the version and publish commands?][8] is what we use and repeat here:
 
-1. checkout and pull `main`
-2. bump versions
-3. create a new branch and create new "version-bump"-PR
-4. merge PR to `main`
-5. build and publish from `main`
+1.  Check out and pull `main`
+2.  Update changelogs and bump versions
+3.  Create a new branch and open a "version bump" PR
+4.  Merge PR to `main`
+5.  Build and publish from `main`
 
 ```sh
 git checkout main
 git pull
 git checkout -b chore/release-packages
 pnpm changeset version
-git commit -m # "... relevant message"
+git commit -m "Update changelogs and bump versions"
 git push
 ```
 
-Create PR, get approval, and merge PR
+Create a pull request and get it merged to `main`. Then we can publish:
 
 ```sh
 git checkout main
 git pull
 pnpm turbo build lint test --force
-pnpm changeset publish
-# fill your otp token from npm
+pnpm changeset publish # Use your npm OTP token
 git push --tags
 ```
 
@@ -125,3 +126,7 @@ git push --tags
   https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch
 [5]:
   https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request
+[6]: ./docs/pnpm-turbo-filter.md
+[7]: https://github.com/changesets/changesets
+[8]:
+  https://github.com/changesets/changesets/blob/main/docs/automating-changesets.md#how-do-i-run-the-version-and-publish-commands
diff --git a/README.md b/README.md
@@ -29,29 +29,23 @@ Overview of the main packages maintained in this repository:
 | [@kadena-dev/eslint-config][5]       | [![version][7]][6]   |
 | [@kadena-dev/eslint-plugin][8]       | [![version][10]][9]  |
 | [@kadena-dev/heft-rig][11]           | [![version][13]][12] |
-| [@kadena-dev/rush-fix-versions][14]  | [![version][16]][15] |
-| [@kadena/bootstrap-lib][17]          | [![version][19]][18] |
-| [@kadena/chainweb-node-client][20]   | [![version][22]][21] |
-| [@kadena/chainweb-stream-client][23] | [![version][25]][24] |
-| [@kadena/chainwebjs][26]             | [![version][28]][27] |
-| [@kadena/client][29]                 | [![version][31]][30] |
-| [@kadena/cryptography-utils][32]     | [![version][34]][33] |
-| [@kadena/docs][35]                   | [![version][37]][36] |
-| [@kadena/graph][38]                  | [![version][40]][39] |
-| [@kadena/kda-cli][41]                | [![version][43]][42] |
-| [@kadena/pactjs][44]                 | [![version][46]][45] |
-| [@kadena/pactjs-cli][47]             | [![version][49]][48] |
-| [@kadena/pactjs-generator][50]       | [![version][52]][51] |
-| [@kadena/types][53]                  | [![version][55]][54] |
-| [kadena.js][56]                      | [![version][58]][57] |
+| [@kadena/chainweb-node-client][14]   | [![version][16]][15] |
+| [@kadena/chainweb-stream-client][17] | [![version][19]][18] |
+| [@kadena/chainwebjs][20]             | [![version][22]][21] |
+| [@kadena/client][23]                 | [![version][25]][24] |
+| [@kadena/cryptography-utils][26]     | [![version][28]][27] |
+| [@kadena/pactjs][29]                 | [![version][31]][30] |
+| [@kadena/pactjs-cli][32]             | [![version][34]][33] |
+| [@kadena/pactjs-generator][35]       | [![version][37]][36] |
+| [@kadena/types][38]                  | [![version][40]][39] |
 
 <!--packageTable end -->
 
 ## Contributors
 
 Special thanks to the wonderful people who have contributed to this project:
 
-[![Contributors][60]][59]
+[![Contributors][42]][41]
 
 [1]: https://docs.kadena.io
 [2]: https://discord.io/kadena
@@ -70,63 +64,40 @@ Special thanks to the wonderful people who have contributed to this project:
 [12]: packages/tools/heft-rig/CHANGELOG.md
 [13]: https://img.shields.io/npm/v/@kadena-dev/heft-rig.svg
 [14]:
-  https://github.com/kadena-community/kadena.js/tree/main/packages/tools/rush-fix-versions
-[15]: packages/tools/rush-fix-versions/CHANGELOG.md
-[16]: https://img.shields.io/npm/v/@kadena-dev/rush-fix-versions.svg
-[17]:
-  https://github.com/kadena-community/kadena.js/tree/main/packages/libs/bootstrap-lib
-[18]: packages/libs/bootstrap-lib/CHANGELOG.md
-[19]: https://img.shields.io/npm/v/@kadena/bootstrap-lib.svg
-[20]:
   https://github.com/kadena-community/kadena.js/tree/main/packages/libs/chainweb-node-client
-[21]: packages/libs/chainweb-node-client/CHANGELOG.md
-[22]: https://img.shields.io/npm/v/@kadena/chainweb-node-client.svg
-[23]:
+[15]: packages/libs/chainweb-node-client/CHANGELOG.md
+[16]: https://img.shields.io/npm/v/@kadena/chainweb-node-client.svg
+[17]:
   https://github.com/kadena-community/kadena.js/tree/main/packages/libs/chainweb-stream-client
-[24]: packages/libs/chainweb-stream-client/CHANGELOG.md
-[25]: https://img.shields.io/npm/v/@kadena/chainweb-stream-client.svg
-[26]:
+[18]: packages/libs/chainweb-stream-client/CHANGELOG.md
+[19]: https://img.shields.io/npm/v/@kadena/chainweb-stream-client.svg
+[20]:
   https://github.com/kadena-community/kadena.js/tree/main/packages/libs/chainwebjs
-[27]: packages/libs/chainwebjs/CHANGELOG.md
-[28]: https://img.shields.io/npm/v/@kadena/chainwebjs.svg
-[29]:
+[21]: packages/libs/chainwebjs/CHANGELOG.md
+[22]: https://img.shields.io/npm/v/@kadena/chainwebjs.svg
+[23]:
   https://github.com/kadena-community/kadena.js/tree/main/packages/libs/client
-[30]: packages/libs/client/CHANGELOG.md
-[31]: https://img.shields.io/npm/v/@kadena/client.svg
-[32]:
+[24]: packages/libs/client/CHANGELOG.md
+[25]: https://img.shields.io/npm/v/@kadena/client.svg
+[26]:
   https://github.com/kadena-community/kadena.js/tree/main/packages/libs/cryptography-utils
-[33]: packages/libs/cryptography-utils/CHANGELOG.md
-[34]: https://img.shields.io/npm/v/@kadena/cryptography-utils.svg
-[35]: https://github.com/kadena-community/kadena.js/tree/main/packages/apps/docs
-[36]: packages/apps/docs/CHANGELOG.md
-[37]: https://img.shields.io/npm/v/@kadena/docs.svg
-[38]:
-  https://github.com/kadena-community/kadena.js/tree/main/packages/apps/graph
-[39]: packages/apps/graph/CHANGELOG.md
-[40]: https://img.shields.io/npm/v/@kadena/graph.svg
-[41]:
-  https://github.com/kadena-community/kadena.js/tree/main/packages/tools/kda-cli
-[42]: packages/tools/kda-cli/CHANGELOG.md
-[43]: https://img.shields.io/npm/v/@kadena/kda-cli.svg
-[44]:
+[27]: packages/libs/cryptography-utils/CHANGELOG.md
+[28]: https://img.shields.io/npm/v/@kadena/cryptography-utils.svg
+[29]:
   https://github.com/kadena-community/kadena.js/tree/main/packages/libs/pactjs
-[45]: packages/libs/pactjs/CHANGELOG.md
-[46]: https://img.shields.io/npm/v/@kadena/pactjs.svg
-[47]:
+[30]: packages/libs/pactjs/CHANGELOG.md
+[31]: https://img.shields.io/npm/v/@kadena/pactjs.svg
+[32]:
   https://github.com/kadena-community/kadena.js/tree/main/packages/tools/pactjs-cli
-[48]: packages/tools/pactjs-cli/CHANGELOG.md
-[49]: https://img.shields.io/npm/v/@kadena/pactjs-cli.svg
-[50]:
+[33]: packages/tools/pactjs-cli/CHANGELOG.md
+[34]: https://img.shields.io/npm/v/@kadena/pactjs-cli.svg
+[35]:
   https://github.com/kadena-community/kadena.js/tree/main/packages/libs/pactjs-generator
-[51]: packages/libs/pactjs-generator/CHANGELOG.md
-[52]: https://img.shields.io/npm/v/@kadena/pactjs-generator.svg
-[53]:
+[36]: packages/libs/pactjs-generator/CHANGELOG.md
+[37]: https://img.shields.io/npm/v/@kadena/pactjs-generator.svg
+[38]:
   https://github.com/kadena-community/kadena.js/tree/main/packages/libs/types
-[54]: packages/libs/types/CHANGELOG.md
-[55]: https://img.shields.io/npm/v/@kadena/types.svg
-[56]:
-  https://github.com/kadena-community/kadena.js/tree/main/packages/libs/kadena.js
-[57]: packages/libs/kadena.js/CHANGELOG.md
-[58]: https://img.shields.io/npm/v/kadena.js.svg
-[59]: https://github.com/kadena-community/kadena.js/graphs/contributors
-[60]: https://contrib.rocks/image?repo=kadena-community/kadena.js
+[39]: packages/libs/types/CHANGELOG.md
+[40]: https://img.shields.io/npm/v/@kadena/types.svg
+[41]: https://github.com/kadena-community/kadena.js/graphs/contributors
+[42]: https://contrib.rocks/image?repo=kadena-community/kadena.js
diff --git a/docs/pnpm-turbo-filter.md b/docs/pnpm-turbo-filter.md
@@ -0,0 +1,61 @@
+# Filters
+
+Both pnpm and Turborepo have a `--filter` argument.
+
+**tl/dr;** Start commands with `pnpm run [cmd]` or `pnpm turbo [cmd]` to use
+Turborepo and its filtering options. See their docs for all options and syntax:
+
+- pnpm docs: [Filtering][1]
+- Turborepo docs: [Filtering Workspaces][2]
+
+## pnpm
+
+To run the test script of a specific package(s), bypassing Turborepo entirely:
+
+```sh
+pnpm --filter <package_selector> <command>
+```
+
+These commands all do the same, the `--filter` argument is provided to `pnpm`:
+
+```sh
+pnpm --filter @kadena/client test
+pnpm --filter @kadena/client run test
+pnpm test --filter @kadena/client
+pnpm run --filter @kadena/client test
+```
+
+There are also ways to include dependencies, select up to and/or including a
+certain package, packages changed since the `main` branch, etc. You can use
+multiple filters. Refer to the pnpm docs for all the goodies.
+
+## Turborepo
+
+To use Turborepo, automatically include dependencies of the target package and
+enjoy caching:
+
+```sh
+pnpm run test --filter @kadena/client
+```
+
+The `pnpm run test` makes sure the `test` script from the root `package.json`
+are used. You can also execute the `turbo` executable directly to do the same:
+
+```sh
+pnpm turbo test --filter @kadena/client
+pnpm turbo --filter @kadena/client test
+```
+
+The filter syntax is inspired by pnpm's, but it's not the same thing. See the
+Turborepo docs for details.
+
+## Bypass Turborepo cache
+
+To force Turborepo to bypass the cache:
+
+```sh
+pnpm turbo build --force
+```
+
+[1]: https://pnpm.io/filtering
+[2]: https://turbo.build/repo/docs/core-concepts/monorepos/filtering