Skip to content

Commit

Permalink
chore: update README and package.json to replace Bun with Yarn as the…
Browse files Browse the repository at this point in the history
… package manager
  • Loading branch information
TomTomB committed Jan 24, 2025
1 parent 8e3f558 commit acf4775
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 44 deletions.
35 changes: 7 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ Core functionalities and utils.

```sh
yarn add @ethlete/core
# or
bun add @ethlete/core
```

### @ethlete/query
Expand All @@ -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
Expand All @@ -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
Expand All @@ -76,8 +70,6 @@ Themeable components based on the Ethlete design system.

```sh
yarn add @ethlete/components
# or
bun add @ethlete/components
```

### @ethlete/dsp
Expand All @@ -90,8 +82,6 @@ Utilities for creating and managing design systems.

```sh
yarn add @ethlete/dsp
# or
bun add @ethlete/dsp
```

### @ethlete/cli
Expand All @@ -104,8 +94,6 @@ CLI helper functions.

```sh
yarn add @ethlete/cli
# or
bun add @ethlete/cli
```

### @ethlete/theming
Expand All @@ -118,8 +106,6 @@ Utilities to make component theming easier.

```sh
yarn add @ethlete/theming
# or
bun add @ethlete/theming
```

### @ethlete/contentful
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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:
Expand All @@ -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.
Expand All @@ -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 |
Expand Down
5 changes: 0 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
11 changes: 0 additions & 11 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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"
Expand Down

0 comments on commit acf4775

Please sign in to comment.