Merge pull request #34 from caffeine-addictt/feature/typescript

Using typescript

.eslintignore

@@ -0,0 +1 @@
+dist/*

.github/workflows/check-dist.yml

@@ -0,0 +1,42 @@
+name: Check Transpiled JavaScript
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  check-dist:
+    name: dist/ up to date
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/[email protected]
+        with:
+          cache: npm
+
+      - name: Install Dependencies
+        run: npm i
+
+      - name: Build dist/ Directory
+        run: npm run build
+
+      # This will fail the workflow if the `dist/` directory is different than
+      # expected.
+      - name: Compare Directories
+        run: |
+          if [ "$(git diff --ignore-space-at-eol --text dist/ | wc -l)" -gt "0" ]; then
+            echo "Detected uncommitted changes after build. See status below:"
+            git diff --ignore-space-at-eol --text dist/
+            exit 1
+          fi

.github/workflows/test-worker.yml

@@ -1,4 +1,4 @@
-name: Run Test Suite
+name: Run Tests
 
 on:
   push:
@@ -16,9 +16,8 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
 
 jobs:
-  # This test suite will run for every language version for every OS defined in the matrix
-  tests-os-matrix:
-    name: '${{ matrix.language_version }} on ${{ matrix.os }}'
+  tests:
+    name: 'Node.Js ${{ matrix.node_version }} on ${{ matrix.os }}'
     runs-on: '${{ matrix.os }}-latest'
 
     strategy:
@@ -28,76 +27,38 @@ jobs:
           - ubuntu
           - windows
           - macos
-        # Place your language versions you want to test
-        language_version: ['v1.0.0', 'v2.0.0']
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      # Setup your language (This is specific to each language)
-      # - name: Set up language ${{ matrix.language_version }}
-      #   uses: actions/setup-python@v5
-      #   with:
-      #     language-version: ${{ matrix.language_version }}
 
-      - name: Install dependencies
-        run: |
-          set -xe
-          echo "Installed dependencies"
-          # python -m pip install -r requirements.txt (for example)
-
-      - name: Build project
-        run: |
-          set -xe
-          echo "Building"
-          # Place your code to build your project here
-
-      - name: Testing
-        run: |
-          set -xe
-          echo "Testing project"
-          # Place your code to test your project here
-
-  # This test will run once
-  tests:
-    name: 'Testing'
-    runs-on: ubuntu-latest
+        node_version:
+          - 16
+          - 18
+          - 20
+          - latest
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      # Setup your language (This is specific to each language)
-      # - name: Set up language ${{ matrix.language_version }}
-      #   uses: actions/setup-python@v5
-      #   with:
-      #     language-version: ${{ matrix.language_version }}
+      - name: Set up Node.js ${{ matrix.node_version }}
+        uses: actions/[email protected]
+        with:
+          cache: npm
+          node-version: ${{ matrix.node_version }}
 
       - name: Install dependencies
         run: |
           set -xe
-          echo "Installed dependencies"
-          # python -m pip install -r requirements.txt (for example)
-
-      - name: Build project
-        run: |
-          set -xe
-          echo "Building"
-          # Place your code to build your project here
+          npm i
 
       - name: Testing
         run: |
           set -xe
-          echo "Testing project"
-          # Place your code to test your project here
+          npm run test
 
-  # It is recommended to require this check to pass before merging a pull request
   check:
     if: always()
     name: Tests Successful
     runs-on: ubuntu-latest
-    needs: [tests-os-matrix, tests]
+    needs: [tests]
 
     steps:
       - name: Whether the whole test suite passed

.gitignore

@@ -1 +1,2 @@
 node_modules/
+.eslintcache

.prettierignore

@@ -1,2 +1,3 @@
 # Ignore {{}} syntax in CITATION.cff
 template/CITATION.cff
+dist/*

README.md

@@ -45,9 +45,7 @@ A simple repository template to get started with GitHub.
 Run the setup script to get started!
 
 ```sh
-# Mark setup as executable
-chmod +x ./setup.sh
-./setup.sh
+node ./setup.js
 ```
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>