Cleanup

- Refactored scripts in package.json
- Replaced old workflow, now supports xvfb + playwright tests

Author: rshaker

.github/workflows/playwright-tests-and-tsdocs.yml

@@ -0,0 +1,90 @@
+name: Run Playwright e2e tests and generate documentation
+
+on:
+    # Runs on pushes targeting the main branch
+    push:
+        branches: [main, dev]
+
+    # Allows you to run this workflow manually from the Actions tab
+    workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+    group: "pages"
+    cancel-in-progress: false
+
+jobs:
+    # Build job: runs tsdocs and playwright tests, then uploads docs and playwright-report to Pages as an artifact
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout repo
+              uses: actions/checkout@v3
+
+            - name: Setup node environment
+              uses: actions/setup-node@v3
+              with:
+                  node-version: "20"
+
+            - name: Configure Github Pages
+              uses: actions/configure-pages@v3
+
+            - name: Install xvfb
+              run: sudo apt-get update && sudo apt-get install -y xvfb
+
+            - name: Install node dependencies
+              run: npm i
+
+            - name: Run tsdocs on the src directory
+              run: npm run docs
+
+            - name: Install Playwright browsers
+              run: npx playwright install --with-deps
+
+            - name: Build the extension
+              run: npm run build:webext
+
+            - name: Run Playwright tests with xvfb
+              run: xvfb-run --auto-servernum --server-args='-screen 0 1280x1024x24' npx playwright test
+
+            - name: Build the artifact directory
+              run: |
+                  mkdir -p build_outputs_folder/
+                  cp -r docs build_outputs_folder/
+                  cp index.html build_outputs_folder/
+                  cp -r assets build_outputs_folder/
+            # Uncomment for debugging purposes
+            # cp -r playwright/playwright-report build_outputs_folder/
+            # cp -r playwright/test-results build_outputs_folder/
+
+            - name: List artifact directory contents
+              run: ls -l build_outputs_folder/*
+
+            - name: Upload the artifact to Pages
+              uses: actions/upload-pages-artifact@v3
+              with:
+                  path: build_outputs_folder/
+
+    # Deployment job: deploys the artifact to GitHub Pages
+    deploy:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        needs: build
+        steps:
+            - name: Download artifact from build
+              uses: actions/download-artifact@v4
+              with:
+                  name: github-pages
+                  path: .
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4

.gitignore

@@ -1,12 +1,12 @@
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
+/webext/*
+
 /playwright/*
-!/playwright/specs
-!/playwright/specs/**
 !/playwright/harness
 !/playwright/harness/**
-
-/webext/*
+!/playwright/specs
+!/playwright/specs/**
 
 # secrets for testing
 .env
@@ -25,6 +25,7 @@ node_modules
 # purgable, throw-away files
 /tmp
 /work
+/docs
 
 # developer notes
 /admin

.npmignore

@@ -1,12 +1,7 @@
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
-/playwright/*
-!/playwright/specs
-!/playwright/specs/**
-!/playwright/harness
-!/playwright/harness/**
-
-/webext/*
+/webext
+/playwright
 
 # secrets for testing
 .env
@@ -25,6 +20,7 @@ node_modules
 # purgable, throw-away files
 /tmp
 /work
+/docs
 
 # developer notes
 /admin

README.md

@@ -2,11 +2,14 @@
 
 ![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue)
 ![License](https://img.shields.io/github/license/rshaker/context-detect)
+![version](https://img.shields.io/github/package-json/v/rshaker/context-detect)
 
 ## Overview
 
 Suppose you're a piece of code running in some context of some browser's javascript engine, and you need to determine what your API options are. This won't tell you your specific options, but it will tell you what type of environment (context) you're saddled with. That's the sole purpose of this library, to tell you in which browser and context you are currently executing.
 
+The library is designed to work in main, isolated, background, extension page, action popup, worker, and shared worker contexts. Not for use in server-side contexts such as Node.
+
 ## Installation
 
 ### npm