Merge branch 'develop' into chore-re-formatting

.github/workflows/update-deps.yml

@@ -0,0 +1,27 @@
+name: Update Dependencies
+
+on: workflow_dispatch
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - uses: zidious/[email protected]
+        with:
+          latest: >
+            @crypto-coffee/coingecko-api,chalk,json2csv,meow@types/chai,
+            @types/json2csv,@types/mocha,@types/node,@typescript-eslint/eslint-plugin,
+            @typescript-eslint/parser,chai,eslint,execa,husky,lint-staged,mocha,prettier,
+            rimraf,ts-node,typescript
+      - uses: peter-evans/create-pull-request@v3     
+        with:
+          token: ${{ secrets.PAT }}
+          commit-message: 'chore: update dependencies'
+          branch: robot-update-dependencies
+          base: develop
+          title: 'chore: update dependencies'
+          body: 'This PR updates dependencies'

README.md

@@ -43,7 +43,7 @@ Note: `--price, --p` is required for any of the subsequent flags.
 Coin price change (%) in the past 24 hours.
 
 ```sh
---priceChange, --pc
+--price-change, --pc
 ```
 
 Coin volume in the past 24 hours.
@@ -73,7 +73,7 @@ Coin all time high price.
 Percent price change from the all time high.
 
 ```sh
---athChange, --athc
+--ath-change, --athc
 ```
 
 Save coin data via JSON and/or CSV

package.json

@@ -28,27 +28,27 @@
   "type": "module",
   "dependencies": {
     "@crypto-coffee/coingecko-api": "^1.2.0",
-    "chalk": "5.2.0",
-    "json2csv": "^5.0.7",
+    "chalk": "^5.3.0",
+    "json2csv": "^6.0.0-alpha.2",
     "meow": "^11.0.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.4",
     "@types/json2csv": "^5.0.3",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.14.6",
-    "@typescript-eslint/eslint-plugin": "^5.54.0",
+    "@types/node": "^20.6.0",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
     "@typescript-eslint/parser": "^5.54.0",
-    "chai": "^4.3.7",
-    "eslint": "^8.35.0",
-    "execa": "^7.0.0",
+    "chai": "^4.3.8",
+    "eslint": "^8.49.0",
+    "execa": "^8.0.1",
     "husky": "^8.0.3",
-    "lint-staged": "^13.1.2",
+    "lint-staged": "^14.0.1",
     "mocha": "^10.2.0",
-    "prettier": "^2.8.4",
+    "prettier": "^3.0.3",
     "rimraf": "^4.3.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.2.2"
   },
   "lint-staged": {
     "*.{md,ts}": [

src/index.test.ts

@@ -96,7 +96,7 @@ describe('crypto-cli', () => {
       })
     })
 
-    describe('with `--priceChange, --pc`', () => {
+    describe('with `--price-change, --pc`', () => {
       describe('with a valid coin name', () => {
         it('returns the price change percentage', async () => {
           const results = await execa(CLI, [
@@ -160,7 +160,7 @@ describe('crypto-cli', () => {
       })
     })
 
-    describe('with `--athChange`', () => {
+    describe('with `--ath-change`', () => {
       describe('with a valid coin name', () => {
         it('returns the percentage from the all time high price', async () => {
           const results = await execa(CLI, [

src/index.ts

@@ -10,12 +10,12 @@ const cli = meow(
 
   Options:
   --price, --p - coin name
-  --priceChange, --pc - coin price change (%) in the past 24 hours
+  --price-change, --pc - coin price change (%) in the past 24 hours
   --volume, --v - coin volume in the past 24 hours
   --high - highest price sold in the past 24 hours
   --low - lowest price sold in the past 24 hours
   --ath - coin all time high price
-  --athChange, --athc - percent price change from ATH
+  --ath-change, --athc - percent price change from ATH
   --version - current version of the crypto-cli tool
   --save - export all coin data to CSV and/or JSON