TypeScript Docs

.eslintignore

@@ -0,0 +1,4 @@
+build/**
+dist/**
+coverage/**
+*.d.ts

.eslintrc.js → .eslintrc.cjs

@@ -1,5 +1,6 @@
 module.exports = {
-  plugins: ['svelte3', 'typescript'],
+  plugins: ['svelte3', '@typescript-eslint'],
+  parser: '@typescript-eslint/parser',
   rules: {
     'no-console': 0,
     'no-undefined': 1,

.github/workflows/pages.yml

@@ -0,0 +1,32 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x.x
+
+      - run: yarn
+      - run: yarn typedoc src/index.ts
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs
+

.github/workflows/tag.yml

@@ -18,6 +18,7 @@ jobs:
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
       - run: yarn
       - run: yarn build
+      - run: yarn tsc
       - uses: JS-DevTools/npm-publish@v1
         with:
           token: ${{ secrets.NPM_TOKEN }}

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Unit tests
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x.x
+          node-version: 18.x.x
       - run: yarn
       - run: yarn test
       - name: cypress
@@ -38,17 +38,27 @@ jobs:
       - name: Lints
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x.x
+          node-version: 18.x.x
       - run: yarn
       - run: yarn lint
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Type Check
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x.x
+      - run: yarn
+      - run: yarn typecheck
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - name: Lints
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x.x
+          node-version: 18.x.x
       - run: yarn
       - run: yarn build
 

.gitignore

@@ -9,6 +9,7 @@ cypress/videos
 dist
 build
 public
+docs
 .idea
 test-report.xml
 

.npmignore

@@ -11,6 +11,7 @@ test-report.xml
 # misc folders
 coverage
 dist
+docs
 public
 recipes
 cypress

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.0 - JSDoc type coverage, docs site
+
+- chore: cover codebase with JSDoc types
+- chore: add typecheck CI step
+- feat: support ESM/CommonJS `jambox.config.js` in config files
+- feat: build & publish TS types
+- fix: wait for full reset when cwd is changed via api
+
 ## 0.1.3 - Match paths containing dots, serialize browser config values
 
 - fix: match pathnames with dot('.') literals in them

babel.config.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   plugins: [],
   presets: [
     [

cypress-node-events.js

@@ -1,7 +1,7 @@
-const fetch = require('node-fetch');
-const waitOn = require('wait-on');
+import fetch from 'node-fetch';
+import waitOn from 'wait-on';
 
-function nodeEvents(on) {
+export default function nodeEvents(on) {
   on('task', {
     jambox: {
       // Configure Jambox with a dynamic config during a test
@@ -31,5 +31,3 @@ function nodeEvents(on) {
     },
   });
 }
-
-module.exports = nodeEvents;

cypress.config.js

@@ -1,8 +1,10 @@
-const fetch = require('node-fetch');
-const { defineConfig } = require('cypress');
-const webpackConfig = require('./webpack.config.js');
+// @ts-check
+import fetch from 'node-fetch';
+import { defineConfig } from 'cypress';
+import webpackConfig from './webpack.config.js';
+import nodeEvents from './cypress-node-events.js';
 
-module.exports = defineConfig({
+const config = defineConfig({
   viewportHeight: 720,
   viewportWidth: 1280,
   chromeWebSecurity: false,
@@ -15,7 +17,7 @@ module.exports = defineConfig({
       webpackConfig,
     },
     setupNodeEvents(on, config) {
-      require('./cypress-node-events')(on);
+      nodeEvents(on);
 
       // Shutdown the server after `yarn cypress run --component completes
       // This ensures that c8 outputs the lcov.info file properly
@@ -26,3 +28,5 @@ module.exports = defineConfig({
     },
   },
 });
+
+export default config;

cypress/support/commands.js

@@ -1,25 +1 @@
-// ***********************************************
-// This example commands.js shows you how to
-// create various custom commands and overwrite
-// existing commands.
-//
-// For more comprehensive examples of custom
-// commands please read more here:
-// https://on.cypress.io/custom-commands
-// ***********************************************
-//
-//
-// -- This is a parent command --
-// Cypress.Commands.add('login', (email, password) => { ... })
-//
-//
-// -- This is a child command --
-// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
-//
-//
-// -- This is a dual command --
-// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
-//
-//
-// -- This will overwrite an existing command --
-// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+// empty

cypress/support/component.js

@@ -1,28 +1,4 @@
-// ***********************************************************
-// This example support/component.js is processed and
-// loaded automatically before your test files.
-//
-// This is a great place to put global configuration and
-// behavior that modifies Cypress.
-//
-// You can change the location of this file or turn off
-// automatically serving support files with the
-// 'supportFile' configuration option.
-//
-// You can read more here:
-// https://on.cypress.io/configuration
-// ***********************************************************
+import './commands.js';
+import { mount } from 'cypress/svelte';
 
-// Import commands.js using ES2015 syntax:
-// import './commands';
-
-// Alternatively you can use CommonJS syntax:
-// require('./commands')
-
-// import { mount } from 'cypress/svelte/dist/cypress-svelte.esm-bundler.js';
-require('./commands');
-const { mount } = require('cypress/svelte');
 Cypress.Commands.add('mount', mount);
-
-// Example use:
-// cy.mount(MyComponent)

e2e-backend.mjs

@@ -2,7 +2,7 @@
 import http from 'http';
 import tinyServer from './src/utils/tiny-server.mjs';
 import jamboxServer from './src/server/index.mjs';
-import { enable as enableDiagnostics } from './src/diagnostics.js';
+import { enable as enableDiagnostics } from './src/diagnostics.cjs';
 
 enableDiagnostics();
 

ext/Api.js

@@ -1,16 +1,12 @@
 // @ts-check
 import Observable from 'zen-observable';
-import { debounce } from './nodash';
-
-/**
- * @typedef {import('./types').Subscribtion} Subscribtion
- */
+import { debounce } from './nodash.js';
 
 const WEBSOCKET_RETRY_TIMER = 3000;
 
 export default class API {
   /**
-   * @type {?Subscribtion}
+   * @type {?ZenObservable.Subscription}
    * */
   #sub;
   /**

ext/App.cy.js

@@ -1,4 +1,4 @@
-import API from './Api';
+import API from './Api.js';
 import App from './App.svelte';
 
 let api;

ext/Cache.cy.js

@@ -1,4 +1,4 @@
-import API from './Api';
+import API from './Api.js';
 import App from './App.svelte';
 
 let api;

ext/manifest.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   name: 'Jambox',
   description: 'Examine and edit proxied requests',
   version: '0.0.2',

ext/panel.js

@@ -1,5 +1,5 @@
 import App from './App.svelte';
-import API from './Api';
+import API from './Api.js';
 
 const boot = async () => {
   const api = await API.create();

jam-server.mjs

@@ -5,7 +5,7 @@ import server from './src/server/index.mjs';
 import fs from 'fs';
 import fetch from 'node-fetch';
 import Tail from 'tail-file';
-import { enable as enableDiagnostics } from './src/diagnostics.js';
+import { enable as enableDiagnostics } from './src/diagnostics.cjs';
 
 enableDiagnostics();
 

jam.mjs

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import entrypoint from './src/entrypoint.mjs';
 import * as constants from './src/constants.mjs';
-import { enable as enableDiagnostics } from './src/diagnostics.js';
+import { enable as enableDiagnostics } from './src/diagnostics.cjs';
 
 enableDiagnostics();
 

jambox.config.js

@@ -1,3 +1,4 @@
+// @ts-check
 /**
  * This config is used for integration tests
  *
@@ -6,7 +7,11 @@
  * - Causes .jambox/default.tape.zip to be written
  * - Leave .jambox/default.tape.zip empty after integration tests
  */
-module.exports = {
+
+/**
+ * @type {import('./src/index.js').FileConfig}
+ */
+export default {
   blockNetworkRequests: false,
   forward: {
     'http://jambox-test.com': {

manifest-plugin.js

@@ -1,7 +1,7 @@
-const prettier = require('prettier');
-const manifest = require('./ext/manifest');
+import prettier from 'prettier';
+import manifest from './ext/manifest.js';
 
-class ManifestPlugin {
+export default class ManifestPlugin {
   apply(compiler) {
     compiler.hooks.make.tap('ManifestPlugin', (compilation) => {
       const fileName = 'manifest.json';
@@ -20,5 +20,3 @@ class ManifestPlugin {
     });
   }
 }
-
-module.exports = ManifestPlugin;