build: Use node 22 (#27)

* build: Use node 22

* adjust lint rule

* add husky

* move @eslint/js to dev dependencies

Author: Tian Feng

.eslintignore

@@ -0,0 +1,7 @@
+## Description
+
+<!--
+Describe the big picture of your changes here to communicate to the maintainers
+why we should accept this pull request. If it fixes a bug or resolves a feature
+request, be sure to link to that issue.
+-->

.eslintrc

@@ -4,9 +4,9 @@ on:
   workflow_dispatch:
     inputs:
       releaseType:
-        description: 'Release type - major, minor or patch'
+        description: "Release type - major, minor or patch"
         required: false
-        default: 'patch'
+        default: "patch"
 
 jobs:
   publish-release:
@@ -19,10 +19,10 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version-file: '.nvmrc'
-          cache: 'npm'
+          node-version-file: ".nvmrc"
+          cache: "npm"
 
       - name: Install Dependencies
         run: npm ci
@@ -33,10 +33,10 @@ jobs:
           git config --global user.email "devx.bot@saucelabs.com"
 
       - name: Login to NPM
-        run: npm set "//registry.npmjs.org/:_authToken" ${{ secrets.NPM_TOKEN }}
+        run: npm set "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}"
 
       - name: Release
         run: npm run release:ci -- ${{ github.event.inputs.releaseType }}
         env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/PULL_REQUEST_TEMPLATE.md

@@ -13,10 +13,10 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version-file: '.nvmrc'
-          cache: 'npm'
+          node-version-file: ".nvmrc"
+          cache: "npm"
 
       - name: Install Dependencies
         run: npm ci
@@ -35,16 +35,16 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version-file: '.nvmrc'
-          cache: 'npm'
+          node-version-file: ".nvmrc"
+          cache: "npm"
 
       - name: Install Dependencies
         run: npm ci
 
       - name: Integration Tests
         env:
-          SAUCE_USERNAME: ${{secrets.SAUCE_USERNAME}}
-          SAUCE_ACCESS_KEY: ${{secrets.SAUCE_ACCESS_KEY}}
+          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
+          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
         run: npm test tests/integration

.github/workflows/release.yml

@@ -0,0 +1,2 @@
+npx pretty-quick --staged
+npm run lint

.github/workflows/tests.yml

@@ -1 +1 @@
-v20
+v22

.husky/pre-commit

@@ -5,30 +5,31 @@ Sauce Labs SDK for the Test-Composer API.
 # Usage
 
 ## Initialize TestComposer Client
+
 ```javascript
 const { TestComposer } = require('@saucelabs/testcomposer');
 
 const client = new TestComposer({
   region: 'us-west-1',
   username: process.env.SAUCE_USERNAME,
   accessKey: process.env.SAUCE_ACCESS_KEY,
-  headers: {'User-Agent': `your-fancy-reporter/1.2.3`}
+  headers: { 'User-Agent': `your-fancy-reporter/1.2.3` },
 });
 ```
 
 ## Create Reports
 
 ```javascript
 const job = await client.createReport({
-  name: "My Fancy Job!",
+  name: 'My Fancy Job!',
   passed: true,
   startTime: new Date().toISOString(),
   endTime: new Date().toISOString(),
-  browserName: "Chrome",
-  browserVersion: "105",
-  framework: "playwright",
-  frameworkVersion: "1.25.0",
-  platformName: "Windows 11"
+  browserName: 'Chrome',
+  browserVersion: '105',
+  framework: 'playwright',
+  frameworkVersion: '1.25.0',
+  platformName: 'Windows 11',
 });
 console.log(job.id); // the job ID
 console.log(job.url); // the full URL of the job
@@ -44,7 +45,9 @@ const Readable = require('stream').Readable;
 const s = new Readable();
 s.push('hello!');
 s.push(null);
-const uploads = await client.uploadAssets(job.id, [{filename: "console.log", data: s}]);
+const uploads = await client.uploadAssets(job.id, [
+  { filename: 'console.log', data: s },
+]);
 ```
 
 ## Explore More Examples

.nvmrc

@@ -4,14 +4,14 @@
 
 ```javascript
 const job = await client.createReport({
-  name: "My Fancy Espresso Job!",
+  name: 'My Fancy Espresso Job!',
   passed: true,
   startTime: new Date().toISOString(),
   endTime: new Date().toISOString(),
-  framework: "espresso",
-  platformName: "Linux",
-  deviceName: "Android GoogleAPI Emulator",
-  platformVersion: "12.0."
+  framework: 'espresso',
+  platformName: 'Linux',
+  deviceName: 'Android GoogleAPI Emulator',
+  platformVersion: '12.0.',
 });
 
 console.log(job.id); // the job ID
@@ -26,9 +26,7 @@ The minimum `native-log.json` file to populate the command list on Sauce Labs we
 
 ```json
 {
-  "filters": [
-    
-  ],
+  "filters": [],
   "package_name": "com.saucelabs.mydemoapp.android",
   "status": "success",
   "stdout": "I am output",
@@ -49,13 +47,12 @@ The minimum `native-log.json` file to populate the command list on Sauce Labs we
 To upload `native-log.json`:
 
 ```javascript
-const uploads = await client.uploadAssets(
-  job.id,
-  [{
-    filename: "native-log.json",
-    data: fs.createReadStream("native-log.json")
-  }]
-);
+const uploads = await client.uploadAssets(job.id, [
+  {
+    filename: 'native-log.json',
+    data: fs.createReadStream('native-log.json'),
+  },
+]);
 // Upon success, the array `uploads.uploaded` will equal in length to the number of assets you intended to upload.
 // Individual assets that fail to upload will be reported via `uploads.errors`.
 ```

README.md

@@ -6,15 +6,15 @@ Learn how to generate reports for JavaScript frameworks like Cypress, Playwright
 
 ```javascript
 const job = await client.createReport({
-  name: "My Fancy Playwright Job!",
+  name: 'My Fancy Playwright Job!',
   passed: true,
   startTime: new Date().toISOString(),
   endTime: new Date().toISOString(),
-  browserName: "Chrome",
-  browserVersion: "105",
-  framework: "playwright", // alternatives: cypress, playwright, testcafe
-  frameworkVersion: "1.25.0",
-  platformName: "Windows 11"
+  browserName: 'Chrome',
+  browserVersion: '105',
+  framework: 'playwright', // alternatives: cypress, playwright, testcafe
+  frameworkVersion: '1.25.0',
+  platformName: 'Windows 11',
 });
 
 console.log(job.id); // the job ID
@@ -60,16 +60,16 @@ In order to view your test results in the SauceLabs web app, you must upload a t
   "metadata": {}
 }
 ```
+
 To upload `sauce-test-report.json`:
 
 ```javascript
-const uploads = await client.uploadAssets(
-  job.id,
-  [{
-    filename: "sauce-test-report.json",
-    data: fs.createReadStream("sauce-test-report.json")
-  }]
-);
+const uploads = await client.uploadAssets(job.id, [
+  {
+    filename: 'sauce-test-report.json',
+    data: fs.createReadStream('sauce-test-report.json'),
+  },
+]);
 // Upon success, the array `uploads.uploaded` will equal in length to the number of assets you intended to upload.
 // Individual assets that fail to upload will be reported via `uploads.errors`.
 ```