Merge be41179 into 914194e

.github/workflows/code_format.yml

@@ -0,0 +1,23 @@
+name: Code Format
+on: [push, pull_request]
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+      - name: Install dependencies
+        run: npm ci
+      - name: Run Prettier and ESLint
+        run: |
+          npm run format
+          npm run lint
+      - name: Commit and push formatting changes
+        run: |
+          git config --global user.name 'GitHub Actions'
+          git config --global user.email 'action@github.com'
+          git add -A
+          git commit -m "Auto-fix formatting issues with Prettier and ESLint" || echo "No changes to commit"
+          git push

.prettierignore

@@ -0,0 +1,9 @@
+.github/
+coverage/
+docs/
+etc/
+lib/
+dist/
+package*.json
+LICENSE
+THIRD-PARTY-NOTICES

package.json

@@ -20,7 +20,8 @@
   ],
   "scripts": {
     "build": "rm -rf lib/** && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && npm run api-extractor && npm run generate-docs && npm run generate-notices && vite build",
-    "lint": "eslint .",
+    "format": "prettier --write .",
+    "lint": "eslint . --fix",
     "api-extractor": "api-extractor run --local --verbose",
     "generate-docs": "api-documenter markdown --input-folder temp --output-folder docs && rm -rf temp",
     "prepublishOnly": "npm run build",

tests/AnalyticsEventReporter.test.ts

@@ -149,7 +149,7 @@ describe('Test report function', () => {
       });
   });
 
-  it('should call post with correct fields, report should return error json if post returns an error',
+  it('call post with correct fields, report should return error json if post returns an error',
     async () => {
       const mockSetupSessionId = getOrSetupSessionId as jest.MockedFunction<typeof getOrSetupSessionId>;
 
@@ -217,7 +217,7 @@ describe('Test report function', () => {
     });
 
 
-  it('should call post with correct fields, should set sessionId undefined if session tracking disabled',
+  it('call post with correct fields and set sessionId undefined if session tracking disabled',
     async () => {
       const mockSetupSessionId = getOrSetupSessionId as jest.MockedFunction<typeof getOrSetupSessionId>;
 
@@ -320,7 +320,7 @@ describe('Test report function', () => {
       });
   });
 
-  it('calling report with an argument with no with call should result in request body coming from report',
+  it('report with an argument with no with() should result in request body coming from report',
     async () => {
       mockPostWithBeacon.mockReturnValueOnce(true);
       mockUseBeacon.mockReturnValueOnce(true);
@@ -357,7 +357,7 @@ describe('Test report function', () => {
         });
     });
 
-  it('calling report with no argument and no with call should result in invalid request body and error',
+  it('report with no argument and no with() should result in invalid request body and error',
     async () => {
       mockPostWithFetch.mockResolvedValue({
         ok: false,
@@ -409,7 +409,7 @@ describe('Test report function', () => {
         });
     });
 
-  it('calling with more than once should result in unique objects that can be called with unique values',
+  it('multiple with() should result in unique objects with unique values',
     async () => {
       mockPostWithBeacon.mockReturnValueOnce(true);
       mockUseBeacon.mockReturnValueOnce(true);

tests/post.test.ts

@@ -1,7 +1,7 @@
 import { EventPayload } from '../src/EventPayload';
 import { EventAPIResponse } from '../src/EventAPIResponse';
 import { postWithBeacon, postWithFetch, useBeacon } from '../src/post';
-const fetchMock = /** @type {FetchMockJest} */ (require('fetch-mock-jest'));
+import fetchMock from 'fetch-mock-jest';
 
 describe('Test post util function', () => {