Skip to content

Commit

Permalink
feat: abandon yarn, move to npm (#417)
Browse files Browse the repository at this point in the history
* feat: abandon yarn, move to npm

* fix: github workflows and package

* chore: update dependencies
  • Loading branch information
danigb authored Feb 15, 2024
1 parent 499540c commit f8c355d
Show file tree
Hide file tree
Showing 5 changed files with 11,707 additions and 5,044 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ jobs:
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node_version }}
cache: "yarn"
- run: yarn install
- run: yarn test:ci
cache: "npm"
- run: npm install
- run: npm run test:ci
11 changes: 5 additions & 6 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ We're really glad you're reading this, because we need volunteers to help this p

## Prerequisites

You will need node and yarn installed on your computer to run the code. And git to download it:
You will need node installed on your computer to run the code. And git to download it:

- [node](https://nodejs.org/en/download/)
- [yarn](https://yarnpkg.com/)
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)

## Download the code
Expand All @@ -16,8 +15,8 @@ To download the code, use git:

```bash
git clone https://github.com/tonaljs/tonal
yarn install
yarn build
npm install
npm build
```

## Development
Expand All @@ -29,7 +28,7 @@ If you are adding new functionality or fixing a bug, please add a test for it.
**Run test and build the library before submitting a pull request :pray:**

```bash
yarn test:ci
npm test:ci
```

#### How to add a new module
Expand All @@ -40,7 +39,7 @@ To create a new module:
- Add a new package.json inside the folder (see any of them as an example)
- Add required dependencies to "dependencies" inside package.json. Ensure correct dependency versions. For example, if your module needs to use `tonal/core` look at core's package.json to see what version to use
- Add your functionality and tests
- Ensure everything works: run `yarn test:ci` at root folder
- Ensure everything works: run `npm test:ci` at root folder
- Create a pull request

## Release
Expand Down
Loading

0 comments on commit f8c355d

Please sign in to comment.