feat: 🎨 Release 7.0

.eslintrc.js → .eslintrc.cjs

@@ -21,14 +21,8 @@ module.exports = {
         ignorePropertyModificationsFor: ["manifest", "previousValue"],
       },
     ],
-    "import/extensions": [
-      "error",
-      "ignorePackages",
-      {
-        js: "never",
-        ts: "never",
-      },
-    ],
+    "import/extensions": "off",
+    "import/no-unresolved": "off",
   },
   globals: {
     browser: "readonly",

.github/CONTRIBUTING.md

@@ -2,6 +2,5 @@
 
 1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
 2. Install the dependencies: `npm install`
-3. Run `npm link` to link the local repo to NPM
-4. Then npm link this repo inside any example app with `npm link webextension-toolbox`
-5. Then you can run your example app with the local version of webextension-toolbox
+3. Go into your local extension and type `npx link <path-to-webextension-toolbox>` (note this is NOT `npm link`!!!)
+4. Then you can run your example app with the local version of webextension-toolbox

.github/workflows/build.yml

@@ -1,29 +1,93 @@
 # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 
-name: Node.js CI
+name: Build
 
 on:
   push:
     branches: [main]
   pull_request:
     branches: [main]
 
+concurrency:
+  group: build-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
+  tests:
+    uses: ./.github/workflows/lint.yml
   build:
     runs-on: ${{ matrix.os }}
+    needs: [tests]
     strategy:
       matrix:
-        node-version: [18.x, 20.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        node-version: [18.x, 20.x, 21.x]
+        os: [ubuntu-latest, macos-latest, windows-latest]
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout Toolbox
+        uses: actions/checkout@v4
+        with:
+          path: 'toolbox'
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm ci
-      - run: npm run lint
-      - run: npm run build
+          cache: 'npm'
+          cache-dependency-path: |
+            ./toolbox/package-lock.json
+            ./js-extension-template/package-lock.json
+      - name: Install Toolbox dependencies
+        run: npm ci
+        working-directory: ./toolbox
+      - name: Build Toolbox binary
+        run: npm run build
+        working-directory: ./toolbox
+      - name: Checkout JS Extension Template
+        uses: actions/checkout@v4
+        with:
+          repository: webextension-toolbox/js-extension-template
+          ref: refs/heads/main
+          path: 'js-extension-template'
+      - name: Install JS Extension Template dependencies
+        run: npm install
+        working-directory: ./js-extension-template
+      - name: Install Additional deps for dev linking
+        run: npm install babel-loader swc-loader
+        working-directory: ./js-extension-template
+      - name: Link toolbox into JS Extension Template on unix
+        if: ${{ matrix.os != 'windows-latest' }}
+        run: npx link $GITHUB_WORKSPACE/toolbox
+        working-directory: ./js-extension-template
+      - name: Link toolbox into JS Extension Template on windows
+        if: ${{ matrix.os == 'windows-latest' }}
+        run: npx link $env:GITHUB_WORKSPACE/toolbox
+        working-directory: ./js-extension-template
+      - name: Build JS Extension Template
+        run: |
+          npm run build -- -o chrome.babel chrome
+          npm run build -- -o firefox.babel firefox
+          npm run build -- -o edge.babel edge
+          npm run build -- -o safari.babel safari
+          npm run build -- -o opera.babel opera
+          npm run build -- -o chrome.swc --swc chrome
+          npm run build -- -o firefox.swc --swc firefox
+          npm run build -- -o edge.swc --swc edge
+          npm run build -- -o safari.swc --swc safari
+          npm run build -- -o opera.swc --swc opera
+        working-directory: ./js-extension-template
+      - name: "Check package existence"
+        uses: andstor/file-existence-action@v2
+        with:
+          files: >-
+            ./js-extension-template/packages/chrome.babel.*,
+            ./js-extension-template/packages/firefox.babel.*,
+            ./js-extension-template/packages/edge.babel.*,
+            ./js-extension-template/packages/safari.babel.*,
+            ./js-extension-template/packages/opera.babel.*,
+            ./js-extension-template/packages/chrome.swc.*,
+            ./js-extension-template/packages/firefox.swc.*,
+            ./js-extension-template/packages/edge.swc.*,
+            ./js-extension-template/packages/safari.swc.*,
+            ./js-extension-template/packages/opera.swc.*
+          fail: true

.github/workflows/codeql-analysis.yml

@@ -20,6 +20,10 @@ on:
   schedule:
     - cron: "45 7 * * 1"
 
+concurrency:
+  group: codeql-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   analyze:
     name: Analyze

.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Lint
+
+on:
+  workflow_call:
+
+concurrency:
+  group: lint-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+        - uses: actions/checkout@v4
+        - uses: actions/setup-node@v4
+          with:
+            node-version: "20"
+        - run: npm ci
+        - run: npm run lint
+
+

.github/workflows/publish.yml

@@ -1,22 +1,26 @@
 # This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
 # For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
 
-name: Node.js Package
+name: Registry Publish
 
 on:
   workflow_dispatch:
   push:
     tags:
       - "*"
 
+concurrency:
+  group: publish-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: "20"
       - run: npm ci
       - run: npm run lint
 
@@ -25,9 +29,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: '18'
+          node-version: '20'
           registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: npm run build
@@ -40,9 +44,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: '18'
+          node-version: '20'
           registry-url: 'https://npm.pkg.github.com'
       - run: npm ci
       - run: npm run build

.github/workflows/release.yml

@@ -6,24 +6,21 @@ on:
     tags:
       - "*"
 
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
-        with:
-          node-version: '18'
-      - run: npm ci
-      - run: npm run lint
+    uses: ./.github/workflows/lint.yml
   create-release:
     needs: lint
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: '18'
+          node-version: '20'
       - run: npm ci
       - run: npm run build
       - run: npm pack

.vscode/settings.json

@@ -3,7 +3,7 @@
   "editor.formatOnSave": true,
   "eslint.format.enable": true,
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "explicit"
   },
   "prettier.prettierPath": "node_modules/prettier"
 }

CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.0.0] - ????-??-??
+
+### Changed
+
+- Uses ESM instead of CJS
+- Optimize code
+- Provide support for SWC
+- Add option to only copy files and not compile them (compileIgnore glob)
+- Additional debugging
+- yaml config file to use instead of or with command options
+- Move examples into their own template repos and use those in testing
+
+### Fixed
+
+- web_accessible_resources ignore js file (#793)
+- Setup with additional webextension-toolbox.config.js config seems to fail on windows 11 (#656)
+- Request for Node.js 20 Support (#847)
+- Chalk is an implicit dependency (should be explicit) (#835)
+
 ## [6.2.0] - 2023-10-28
 
 ### Changed

Makefile

@@ -0,0 +1,5 @@
+act-build:
+	act -j build -W .github/workflows/build.yml  -s GITHUB_TOKEN="$(shell gh auth token)" --artifact-server-path /tmp/artifacts
+
+act-lint:
+	act -j lint -W .github/workflows/lint.yml  -s GITHUB_TOKEN="$(shell gh auth token)" --artifact-server-path /tmp/artifacts