From 5b027363b5d01535030c9efc4f0140b2770a8c98 Mon Sep 17 00:00:00 2001 From: danigb Date: Thu, 15 Feb 2024 22:13:00 +0100 Subject: [PATCH] fix: github workflows and package --- .github/workflows/tests.yml | 2 +- docs/CONTRIBUTING.md | 11 +++++------ package.json | 2 +- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index d1df4ecb..62b0f7e0 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -19,4 +19,4 @@ jobs: node-version: ${{ matrix.node_version }} cache: "npm" - run: npm install - - run: npm test:ci + - run: npm run test:ci diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 0d407b1f..eaaecce9 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/package.json b/package.json index 6cbf10a7..01d125dc 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ "test": "jest --coverage", "lint": "eslint 'packages/**/*.ts'", "lint:fix": "eslint 'packages/**/*.ts' --fix", - "test:ci": "npm format && npm lint && npm build && npm test -- --no-cache", + "test:ci": "npm run format && npm run lint && npm run build && npm run test -- --no-cache", "doc": "npm typedoc" }, "prettier": {},