Fix typos: npm --> yarn

jcam1 · Aug 21, 2024 · ecabcf5 · ecabcf5
1 parent 100277c
commit ecabcf5
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 28 deletions.
diff --git a/.github/workflows/check-core.yml b/.github/workflows/check-core.yml
@@ -26,14 +26,14 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-      - name: Install Dependencies
-        run: yarn
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
       - name: Compile
-        run: npm run compile
+        run: yarn run compile
       - name: Lint
-        run: npm run lint:dry-run
+        run: yarn run lint:dry-run
       - name: Format
-        run: npm run format:dry-run
+        run: yarn run format:dry-run
 
   test:
     runs-on: ubuntu-latest
@@ -43,7 +43,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-      - name: Install Dependencies
-        run: yarn
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
       - name: Run tests
-        run: npm run test
+        run: yarn run test
diff --git a/.github/workflows/check-v1.yml b/.github/workflows/check-v1.yml
@@ -26,11 +26,11 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-      - name: Install Dependencies
-        run: yarn
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
       - name: Compile
-        run: npm run compile:sdk
+        run: yarn run compile:sdk
       - name: Lint
-        run: npm run lint:dry-run
+        run: yarn run lint:dry-run
       - name: Format
-        run: npm run format:dry-run
+        run: yarn run format:dry-run
diff --git a/.npmrc b/.npmrc
diff --git a/README.md b/README.md
@@ -36,12 +36,12 @@ $ cd sdks
 $ yarn
 ```
 
-### NPM Scripts
+### Yarn Scripts
 
-To run npm scripts defined in workspaces, run the following. 
+To run yarn scripts defined in workspaces, run the following. 
 
 ```sh
-$ npm run -w <workspace name> <command name>
+$ yarn workspace <workspace name> run <command name>
 ```
 
 ### Dependencies

diff --git a/package.json b/package.json
@@ -25,16 +25,16 @@
   },
   "lint-staged": {
     "packages/core/**/*.{ts,js}": [
-      "npm run -w @jpyc/sdk-core lint"
+      "yarn workspace @jpyc/sdk-core run lint"
     ],
     "packages/core/**/*.{ts,js,md,json}": [
-      "npm run -w @jpyc/sdk-core format"
+      "yarn workspace @jpyc/sdk-core run format"
     ],
     "packages/v1/**/*.{ts,js}": [
-      "npm run -w @jpyc/sdk-v1 lint"
+      "yarn workspace @jpyc/sdk-v1 run lint"
     ],
     "packages/v1/**/*.{ts,js,md,json}": [
-      "npm run -w @jpyc/sdk-v1 format"
+      "yarn workspace @jpyc/sdk-v1 run format"
     ]
   }
 }
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -4,7 +4,7 @@ JPYC core SDK implements a set of constants, types and functions, commonly used
 
 ## 🤖 Available Commands
 
-The following commands are available as npm scripts for local development & testing.
+The following commands are available as yarn scripts for local development & testing.
 
 |          Command | Description                          |
 | ---------------: | :----------------------------------- |

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -4,6 +4,9 @@
   "repository": "https://github.com/jcam1/sdks.git",
   "license": "MIT",
   "version": "1.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
   "engines": {
     "node": "^20.12.0",
     "yarn": "^1.22.22"

diff --git a/packages/v1/README.md b/packages/v1/README.md
@@ -8,7 +8,7 @@ Please follow the following steps to configure our SDK.
 
 #### 1. Install Packages
 
-Install npm packages.
+Install packages.
 
 ```sh
 # yarn
@@ -78,7 +78,7 @@ For your reference, we provide code examples in `examples` directory. Please fol
 
 ## 🤖 Available Commands
 
-The following commands are available as npm scripts for local development & testing.
+The following commands are available as yarn scripts for local development & testing.
 
 |                       Command | Description                                             |
 | ----------------------------: | :------------------------------------------------------ |

diff --git a/packages/v1/examples/README.md b/packages/v1/examples/README.md
@@ -7,15 +7,15 @@ We provide code examples that use JPYC V1 SDK as an interface to locally-deploye
 Run the following command to start running local Hardhat network and its accompanying node.
 
 ```sh
-$ npm run node
+$ yarn run node
 ```
 
 ### 2. Deploy Contracts
 
 **Open a different window** and run the following command to deploy JPYCv2 contracts to the local network. Once successfully deployed, a new directory will be created, and you can find deployed contract addresses at `/packages/v1/ignition/deployments/chain-31337/deployed_addresses.json`.
 
 ```sh
-$ npm run deploy
+$ yarn run deploy
 ```
 
 ### 3. Set Environment Variables
@@ -26,7 +26,7 @@ Run the following commands, and edit the generated `.env` file accordingly. Set
 # cd into this directory
 $ cd /packages/v1
 # copy `.env.example` to `.env`
-$ npm run env
+$ yarn run env
 ```
 
 ### 4. Run Code Examples
@@ -48,5 +48,5 @@ Run the following commands to execute our code examples.
 For example, to mint JPYC tokens on local network, run the following.
 
 ```sh
-$ npm run mint
+$ yarn run mint
 ```
diff --git a/packages/v1/package.json b/packages/v1/package.json
@@ -4,6 +4,9 @@
   "repository": "https://github.com/jcam1/sdks.git",
   "license": "MIT",
   "version": "1.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
   "engines": {
     "node": "^20.12.0",
     "yarn": "^1.22.22"

diff --git a/yarnrc.yml b/yarnrc.yml
@@ -0,0 +1,3 @@
+npmAlwaysAuth: true
+npmAuthToken: "${NODE_AUTH_TOKEN}"
+npmPublishRegistry: "https://registry.npmjs.org"