Create unit test and GitHub Actions (#294)

* Update CI workflow, dependencies, and add Vitest for testing

Co-authored-by: overtorment <overtorment@gmail.com>

* Remove Vitest UI and related configuration

Co-authored-by: overtorment <overtorment@gmail.com>

* Move string utils tests to dedicated tests directory

Co-authored-by: overtorment <overtorment@gmail.com>

* Update CI workflow to separate lint and test jobs

Co-authored-by: overtorment <overtorment@gmail.com>

* Rename vitest.config.ts to vitest.config.mts

Co-authored-by: overtorment <overtorment@gmail.com>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>

Author: Overtorment

.github/workflows/ci.yml

@@ -1,37 +1,40 @@
-name: Tests
+name: CI
 
 on: [pull_request]
 
 jobs:
   lint:
-    runs-on: macos-latest
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout project
         uses: actions/checkout@v3
 
-      - name: Specify node version
-        uses: actions/setup-node@v2-beta
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
+          cache: "npm"
 
-      - name: Use npm caches
-        uses: actions/cache@v2
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-npm-
-
-      - name: Use node_modules caches
-        id: cache-nm
-        uses: actions/cache@v2
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run linting
+        run: npm run lint
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
         with:
-          path: node_modules
-          key: ${{ runner.os }}-nm-${{ hashFiles('package-lock.json') }}
+          node-version: 18
+          cache: "npm"
 
-      - name: Install node_modules
-        if: steps.cache-nm.outputs.cache-hit != 'true'
-        run: npm install
+      - name: Install dependencies
+        run: npm ci
 
       - name: Run tests
-        run: npm run lint
+        run: npm run test:run

README.md

@@ -96,7 +96,6 @@ Set them as env variables or put them into `.env` file in project root dir.
 - `GOOGLE_KEY_FILE` - json file with Google key for FCM, in hex
 - `GOOGLE_PROJECT_ID` - acquired with the key file
 
-
 ### Getting certificates
 
 - outdated https://dev.to/jakubkoci/react-native-push-notifications-313i

TESTING.md

@@ -0,0 +1,39 @@
+# Testing
+
+This project uses [Vitest](https://vitest.dev/) for unit testing.
+
+## Running Tests
+
+```bash
+# Run tests once
+npm run test:run
+
+# Run tests in watch mode
+npm test
+```
+
+## Test Structure
+
+Tests are located in the `src/tests/` directory with the `.test.ts` suffix.
+
+Current test coverage includes:
+
+- `StringUtils` - Utility functions for shortening addresses and transaction IDs
+
+## GitHub Actions
+
+The CI pipeline runs on every pull request via GitHub Actions with two separate jobs:
+
+### Lint Job
+
+1. Sets up Node.js 18
+2. Installs dependencies
+3. Runs linting (Prettier + TypeScript compilation)
+
+### Test Job
+
+1. Sets up Node.js 18
+2. Installs dependencies
+3. Executes the test suite
+
+Both jobs run in parallel for faster feedback. The workflow file is located at `.github/workflows/ci.yml`.