From acf4775bea1babfc1eb15ad746dc33c5ad8189b2 Mon Sep 17 00:00:00 2001
From: Tom-Rune Bornholdt
Date: Fri, 24 Jan 2025 23:30:23 +0100
Subject: [PATCH] chore: update README and package.json to replace Bun with
Yarn as the package manager
---
README.md | 35 +++++++----------------------------
package.json | 5 -----
yarn.lock | 11 -----------
3 files changed, 7 insertions(+), 44 deletions(-)
diff --git a/README.md b/README.md
index 235a7fb5f..087e7fd63 100644
--- a/README.md
+++ b/README.md
@@ -34,8 +34,6 @@ Core functionalities and utils.
```sh
yarn add @ethlete/core
-# or
-bun add @ethlete/core
```
### @ethlete/query
@@ -48,8 +46,6 @@ Fetch wrapper with caching, request templates, GQL support and Angular helpers
```sh
yarn add @ethlete/query
-# or
-bun add @ethlete/query
```
### @ethlete/cdk
@@ -62,8 +58,6 @@ Component development kit for Ethlete with a11y and performance in mind.
```sh
yarn add @ethlete/cdk
-# or
-bun add @ethlete/cdk
```
### @ethlete/components
@@ -76,8 +70,6 @@ Themeable components based on the Ethlete design system.
```sh
yarn add @ethlete/components
-# or
-bun add @ethlete/components
```
### @ethlete/dsp
@@ -90,8 +82,6 @@ Utilities for creating and managing design systems.
```sh
yarn add @ethlete/dsp
-# or
-bun add @ethlete/dsp
```
### @ethlete/cli
@@ -104,8 +94,6 @@ CLI helper functions.
```sh
yarn add @ethlete/cli
-# or
-bun add @ethlete/cli
```
### @ethlete/theming
@@ -118,8 +106,6 @@ Utilities to make component theming easier.
```sh
yarn add @ethlete/theming
-# or
-bun add @ethlete/theming
```
### @ethlete/contentful
@@ -132,8 +118,6 @@ Helpers for usage with Contentful (e.g. rich text rendering).
```sh
yarn add @ethlete/contentful
-# or
-bun add @ethlete/contentful
```
### @ethlete/types
@@ -146,16 +130,14 @@ Up to date typescript definitions for the Ethlete REST API as well as other type
```sh
yarn add -D @ethlete/types
-# or
-bun add @ethlete/types
```
## How to contribute
This mono repository uses:
-- [Bun](https://bun.sh/) as a package manager.
-- [Conventional commits](http://commitizen.github.io/cz-cli/) for commit messages.
+- [Yarn](https://yarnpkg.com/) as a package manager.
+- [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
- [Changesets](https://github.com/changesets/changesets) for version management and automated releases.
### General workflow
@@ -169,7 +151,7 @@ git clone https://github.com/ethlete-io/ethdk.git
Install dependencies:
```sh
-bun install
+yarn install
```
Create a feat, fix or other branch:
@@ -178,20 +160,18 @@ Create a feat, fix or other branch:
git checkout -B feat/example
```
-Commit your changes via git-cz:
+Commit your changes:
```sh
-bun commit
+git add .
+git commit -m "feat: add example"
```
If the changes made should result in a version bump, create a changeset and commit the generated file.
All SDKs adhere to the [semantic versioning](https://semver.org/) guidelines.
```sh
-bun change
-
-# OR if the command above fails for some reason:
-bunx changeset
+yarn changeset
```
Now all that's left is to create a PR and make sure that all workflows pass.
@@ -200,7 +180,6 @@ Now all that's left is to create a PR and make sure that all workflows pass.
| Script | Description |
| ------------ | ------------------------------------------- |
-| `commit` | Run the commit assistant |
| `change` | Run the changeset assistant |
| `start` | Run the playground (test) app in serve mode |
| `storybook` | Run the storybook instance |
diff --git a/package.json b/package.json
index 48c487eae..26c12f0fa 100644
--- a/package.json
+++ b/package.json
@@ -7,12 +7,8 @@
"libs/*"
],
"scripts": {
- "change": "yarn changeset",
"changeset:prerelease": "node ./tools/scripts/enter-prerelease-mode.js && yarn changeset version && yarn install --mode=update-lockfile",
"changeset:release": "node ./tools/scripts/exit-prerelease-mode.js && yarn changeset version && yarn install --mode=update-lockfile",
- "commit": "yarn git-cz",
- "fix-deps": "rm -f .eslintcache && yarn nx run-many -t lint --skip-nx-cache --fix && yarn install",
- "format": "nx format:write --base=origin/main --head=HEAD",
"prepare:release": "node ./tools/scripts/prepare-release.js",
"release": "yarn prepare:release && yarn changeset publish",
"start": "nx serve playground",
@@ -78,7 +74,6 @@
"eslint": "9.18.0",
"eslint-config-prettier": "10.0.1",
"eslint-plugin-playwright": "2.1.0",
- "git-cz": "4.9.0",
"jest": "29.7.0",
"jest-environment-jsdom": "29.7.0",
"jest-environment-node": "29.7.0",
diff --git a/yarn.lock b/yarn.lock
index 35845a3de..06cb0ddba 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -3206,7 +3206,6 @@ __metadata:
eslint: "npm:9.18.0"
eslint-config-prettier: "npm:10.0.1"
eslint-plugin-playwright: "npm:2.1.0"
- git-cz: "npm:4.9.0"
jest: "npm:29.7.0"
jest-environment-jsdom: "npm:29.7.0"
jest-environment-node: "npm:29.7.0"
@@ -10957,16 +10956,6 @@ __metadata:
languageName: node
linkType: hard
-"git-cz@npm:4.9.0":
- version: 4.9.0
- resolution: "git-cz@npm:4.9.0"
- bin:
- git-cz: bin/git-cz.js
- gitcz: bin/git-cz.js
- checksum: 10c0/c925f9fb2367e16d0f2df1beef1efd38e6823b978690e0c097fec49ca2704774e0e095272354d73060311a71591708367024767d928cdd7c9f08d228acc516dc
- languageName: node
- linkType: hard
-
"git-hooks-list@npm:^3.0.0":
version: 3.1.0
resolution: "git-hooks-list@npm:3.1.0"