fix: remove @podium/dev-tool and extension feature (#158)

Author: wkillerud

.github/workflows/pull-request.yml

@@ -14,11 +14,7 @@ on:
 
 jobs:
   run-all-tests:
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest]
-        node-version: [18, 20]
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
@@ -27,7 +23,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: 22
 
       - name: Install dependencies
         run: npm install
@@ -37,9 +33,3 @@ jobs:
 
       - name: Build
         run: npm run build
-
-      - name: Run all tests
-        run: npm test
-
-      - name: Generate and check types
-        run: npm run types

.github/workflows/release.yml

@@ -23,14 +23,15 @@ jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
+
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
 
       - name: Install dependencies
         run: npm install
@@ -41,14 +42,8 @@ jobs:
       - name: Build
         run: npm run build
 
-      - name: Test
-        run: npm run test
-
-      - name: Generate and check types
-        run: npm run types
-
       - name: Release and publish
-        run: npx multi-semantic-release
+        run: npx semantic-release
         env:
           FIREFOX_API_KEY: ${{ secrets.FIREFOX_API_KEY }}
           FIREFOX_SECRET_KEY: ${{ secrets.FIREFOX_SECRET_KEY }}

.gitignore

@@ -1,3 +1,24 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+/dist
+
+# misc
 .DS_Store
-.idea
-node_modules
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.multi-releaserc.json

@@ -1,29 +1,71 @@
 # Contributing
 
-Welcome, and thanks for showing an interest in contributing 💜
+Thank you for showing an interest in contributing 💜
 
-This module is an `npm` [workspace]. You will need:
+The goal of this browser extension is to help developers of [Podium applications](https://podium-lib.io/) test and debug their apps.
 
-- Node latest LTS
-- `npm`
+The extension targets [WebExtension](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions) Manifest V3 for [cross-browser support](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Build_a_cross_browser_extension).
 
-See also [the browser extension's CONTRIBUTING.md](packages/client/CONTRIBUTING.md) since the workflow there is different.
+If you're new to extension development, a great place to start is Mozilla's [WebExtension workshop](https://extensionworkshop.com/). Some other documentation for extension authors that may be helpful:
 
-## 🧞 Commands
+- [MDN - Build a cross-browser extension](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Build_a_cross_browser_extension)
+- [Chrome - Your first extension](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world)
+- [MDN - Your first extension](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension)
+- [Chrome - Extend DevTools](https://developer.chrome.com/docs/extensions/how-to/devtools/extend-devtools)
 
-All commands are run from the root of the project, from a terminal:
+## Building
 
-| Command                          | Action                                                                          |
-| -------------------------------- | ------------------------------------------------------------------------------- |
-| `npm install --legacy-peer-deps` | Installs dependencies across the workspace                                      |
-| `npm test`                       | Runs unit tests across the workspace                                            |
-| `npm run lint`                   | Does a check with [ESLint](./.eslintrc) across the workspace                    |
-| `npm run types`                  | Generates type definitions from JSDoc and does a typecheck across the workspace |
+To build the extension:
 
-To only run the command for an individual package, either:
+```
+npm install --legacy-peer-deps
+npm run build
+```
+
+The packaged extension is built to `dist/`.
+
+## Testing
+
+We use [`web-ext`](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/) to get a quick and simple development environment in Chrome and Firefox.
+
+1. Run `npm install`
+2. Run `npm start`
+
+Chrome will open automatically.
+
+- In the browser window, go to a test application (for instance start [server/example](../server/example/)) and open the devtools to reveal the Podium panel.
+- Right click inside the panel and Inspect to open the "devtools for the devtool".
+
+To test in Firefox, run `npm run start:firefox`.
+
+### Manual testing
+
+The process is similar across browsers. Also note that some changes may require a reinstall or a refresh inside the browser settings.
+
+- [Chrome: Reload the extension](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#reload)
+- [Firefox: Testing](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension#testing)
+
+#### Firefox
+
+- Open [about:debugging](about:debugging#/runtime/this-firefox) and click This Firefox
+- Click Load Temporary Add-on
+- Select `build/manifest.json`
+
+You'll have to [repeat the steps](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension#installing) the next time you start Firefox, and hit the refresh button when you rebuild the extension.
+
+NB: you may have to give the Podium extension permission to run. Look for a dot on the extension and consider allowing it to always run on the domain you're working on.
+
+#### Chrome
+
+The approach should be similar in Chromium-based browsers.
+
+- Open [chrome://extensions/](chrome://extensions/)
+  - Toggle Developer mode on in the top-right if it's not on already.
+- Click Load unpacked
+- Select the `build/` directory
+
+The extension should now be installed and ready for testing. You may have to [hit the refresh button when you rebuild](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#reload) the extension.
 
-- Run the command from the package folder
-- Append ` --workspace=<package name>` to the command
 
 ## 🚚 Continuous deployment
 

packages/client/.releaserc.json .releaserc.jsonpackages/client/.releaserc.json renamed to .releaserc.json

@@ -1,11 +1,11 @@
-# Podium dev tools
+# Podium Developer Tools
 
-## 📦 Packages
+This browser extension helps you test and debug your [Podium applications](https://podium-lib.io/).
 
-This is an npm workspace containing:
+To get started, download the extension:
 
-- A [browser extension](packages/client/) for developers of Podium applications
-- [@podium/dev-tool](packages/server/), a module that adds APIs to your podlet needed by the browser extension
+- Chrome web store
+- Firefox Add-ons
 
 ## 🧑‍💻 Development
 

packages/client/CHANGELOG.md CHANGELOG.mdpackages/client/CHANGELOG.md renamed to CHANGELOG.md

@@ -1,3 +1,3 @@
-import config from '@podium/eslint-config';
+import config from "@podium/eslint-config";
 
 export default config;