testing

.github/workflows/ci.yml

@@ -3,10 +3,10 @@ name: CI
 on:
   pull_request:
     branches:
-      - main
+      - master
   push:
     branches:
-      - main    
+      - master    
 
 jobs:
   build:
@@ -19,7 +19,7 @@ jobs:
     - name: Set up Node.js
       uses: actions/setup-node@v2
       with:
-        node-version: '18'
+        node-version: '20'
 
     - name: Install dependencies
       run: yarn install

.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Release
 on:
   push:
     branches:
-      - main
+      - master
 
 jobs:
   release:
@@ -16,7 +16,7 @@ jobs:
     - name: Set up Node.js
       uses: actions/setup-node@v2
       with:
-        node-version: '18'
+        node-version: '20'
 
     - name: Install dependencies
       run: yarn install
@@ -30,5 +30,5 @@ jobs:
     - name: Run semantic-release
       run: npx semantic-release
       env:
-        GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+        GH_TOKEN: ${{ secrets.GH_TOKEN }}
         NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -32,17 +32,15 @@ x-fidelity is a CLI tool designed to enforce adherence to a set of opinionated f
 To install x-fidelity, clone the repository and install the dependencies using yarn:
 
 ```sh
-git clone [email protected]:zotoio/x-fidelity.git
-cd x-fidelity
-yarn install
+yarn global add x-fidelity
 ```
 
 ## Usage
 
 To run x-fidelity, use the following command:
 
 ```sh
-yarn start --dir <directory> [--configUrl <url>]
+x-fi --dir <directory> [--configUrl <url>]
 ```
 
 - `--dir <directory>`: The directory of the repository to analyze.
@@ -51,7 +49,7 @@ yarn start --dir <directory> [--configUrl <url>]
 Example:
 
 ```sh
-yarn start --dir my-repo --configUrl https://example.com/config.json
+x-fi --dir my-repo --configUrl https://example.com/config.json
 ```
 
 ## Configuration

package.json

@@ -24,6 +24,7 @@
     "@types/jest": "^29.5.12",
     "@types/lodash": "^4.17.4",
     "@types/node": "^16.18.97",
+    "@types/parse-json": "^4.0.2",
     "@types/semver": "^7.5.8",
     "commitizen": "^4.3.0",
     "conventional-changelog-cli": "^2.2.2",

yarn.lock

@@ -1246,6 +1246,11 @@
   resolved "https://registry.yarnpkg.com/@types/normalize-package-data/-/normalize-package-data-2.4.4.tgz#56e2cc26c397c038fab0e3a917a12d5c5909e901"
   integrity sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA==
 
+"@types/parse-json@^4.0.2":
+  version "4.0.2"
+  resolved "https://registry.yarnpkg.com/@types/parse-json/-/parse-json-4.0.2.tgz#5950e50960793055845e956c427fc2b0d70c5239"
+  integrity sha512-dISoDXWWQwUquiKsyZ4Ng+HX2KsPL7LyHKHQwgGFEA3IaKac4Obd+h2a/a6waisAoepJlBcx9paWqjA8/HVjCw==
+
 "@types/semver@^7.5.5", "@types/semver@^7.5.8":
   version "7.5.8"
   resolved "https://registry.yarnpkg.com/@types/semver/-/semver-7.5.8.tgz#8268a8c57a3e4abd25c165ecd36237db7948a55e"