feat: rewrite in TS

Fix #2

.eslintrc.json

@@ -1,14 +1,9 @@
 {
-  "plugins": ["eslint-plugin-html"],
-  "extends": ["eslint:recommended"],
-  "parserOptions": {
-    "ecmaVersion": 2022,
-    "sourceType": "module"
-  },
-  "env": {
-    "es6": true,
-    "node": true,
-    "browser": true,
-    "jest": true
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "root": true,
+  "rules": {
+    "@typescript-eslint/ban-ts-comment": "off"
   }
 }

.github/workflows/ci.yml

@@ -12,13 +12,9 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          fetch-depth: 2
-
-      - name: Use Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16
+          node-version: current
 
       - name: Install dependencies
         run: npm ci
@@ -32,6 +28,9 @@ jobs:
       - name: Check format
         run: npm run check-format
 
+      - name: Build
+        run: npm run build
+
       - name: Install playwright browsers
         run: npx playwright install --with-deps chromium
 

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 screenshots/*
 !screenshots/.gitkeep
+dist

.npmignore

@@ -1,4 +1,4 @@
 /*
-!index.js
-!index.cjs
-!index.d.ts
+!dist/index.mjs
+!dist/index.cjs
+!dist/index.d.ts

.swcrc

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json.schemastore.org/swcrc",
+  "jsc": {
+    "target": "es2021",
+    "parser": {
+      "syntax": "typescript"
+    }
+  }
+}

CHANGELOG.md

@@ -4,7 +4,6 @@ All notable changes to this project will be documented in this file. See [standa
 
 ### 0.0.1 (2023-01-17)
 
-
 ### Features
 
-* first version ([65aa75b](https://github.com/argos-ci/argos-playwright/commit/65aa75b463a89d14b6208f88193f1a2b5843a90f))
+- first version ([65aa75b](https://github.com/argos-ci/argos-playwright/commit/65aa75b463a89d14b6208f88193f1a2b5843a90f))

index.test.js → example.spec.ts

@@ -1,13 +1,15 @@
-import { test, chromium, expect } from "@playwright/test";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { test, chromium, expect, Page } from "@playwright/test";
 import { fileURLToPath } from "node:url";
 import { stat } from "node:fs/promises";
-import { argosScreenshot } from "./index.js";
-import { argosScreenshot as argosScreenshotCjs } from "./index.cjs";
+import { argosScreenshot } from "./src/index.js";
+// @ts-ignore
+import { argosScreenshot as argosScreenshotCjs } from "./dist/index.cjs";
 
 test.describe.configure({ mode: "serial" });
 const screenshotFolder = "screenshots";
 
-export async function exists(path) {
+export async function exists(path: string) {
   try {
     await stat(path);
     return true;
@@ -16,7 +18,7 @@ export async function exists(path) {
   }
 }
 
-async function screenshotExists(screenshotName) {
+async function screenshotExists(screenshotName: string) {
   const filepath = fileURLToPath(
     new URL(`${screenshotFolder}/${screenshotName}.png`, import.meta.url).href
   );
@@ -25,7 +27,7 @@ async function screenshotExists(screenshotName) {
 
 const url = new URL("fixtures/dummy.html", import.meta.url).href;
 test.describe("#argosScreenshot", () => {
-  let page;
+  let page: Page;
   const screenshotName = "dummy-page";
 
   test.beforeAll(async () => {
@@ -42,28 +44,33 @@ test.describe("#argosScreenshot", () => {
     });
     page.on("console", (msg) => console.log(msg.text()));
     await page.goto(url);
-    await argosScreenshot(page, screenshotName);
+    await argosScreenshot(page, screenshotName, {});
   });
 
   test.afterAll(async () => {
     await page.close();
   });
 
   test("throws without page", async () => {
+    let error: any;
     try {
+      // @ts-expect-error - We want to test the error
       await argosScreenshot();
-    } catch (error) {
-      expect(error.message).toBe("A Playwright `page` object is required.");
+    } catch (e: any) {
+      error = e;
     }
+    expect(error.message).toBe("A Playwright `page` object is required.");
   });
 
   test("throws without name", async () => {
-    expect.assertions(1);
+    let error: any;
     try {
+      // @ts-expect-error - We want to test the error
       await argosScreenshot(page);
-    } catch (error) {
-      expect(error.message).toBe("The `name` argument is required.");
+    } catch (e: any) {
+      error = e;
     }
+    expect(error.message).toBe("The `name` argument is required.");
   });
 
   test("waits for loader hiding", async () => {