chore(release): v0.18.4

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,50 +0,0 @@
----
-name: Bug report
-about: Report an issue with WXT
-title: ''
-labels: triage
-assignees: ''
----
-
-### Describe the bug
-
-A clear and concise description of what the bug is.
-
-### To Reproduce
-
-Share minimal reproduction. Examples of a minimal reproduction:
-
-- PR with a failing test case
-- ZIP file containing a minimal WXT project (be sure to include your lockfile!!)
-
-> **_⚠️ If you don't upload a minimal reproduction, your issue will be closed until a reproduction is added._**
->
-> Why? https://antfu.me/posts/why-reproductions-are-required
-
-Steps to reproduce the bug using the reproduction:
-
-1. Install dependencies: `pnpm i`
-2. Start dev mode: `pnpm dev`
-3. Click this...
-4. Do that...
-5. Etc...
-
-### Expected behavior
-
-A clear and concise description of what you expected to happen.
-
-### Screenshots
-
-If applicable, add screenshots to help explain your problem.
-
-### Environment
-
-<!--- Run `npx envinfo --system --browsers --binaries --npmPackages wxt,vite` and paste the output below -->
-
-```
-Paste output here
-```
-
-### Additional context
-
-Add any other context about the problem here, otherwise you can delete this section.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,74 @@
+name: "\U0001F41E Bug report"
+description: Report an issue with WXT
+labels: [pending-triage]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
+      placeholder: I am doing ... What I expect is ... What actually happening is ...
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction
+      description: |
+        Please provide a minimal reproduction. This can include:
+
+        - A PR with a failing test case
+        - A link to a github repo
+        - A ZIP you upload to this issue
+
+        A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required ([Why?](https://antfu.me/posts/why-reproductions-are-required)). If a report is vague (e.g. just a generic error message) and has no reproduction or a partial reproduction, it will be closed immediately and labeled with as "needs-reproduction". Once a reproduction is provided, it will be re-opened.
+      placeholder: Reproduction URL or attach a ZIP
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Steps to reproduce
+      description: Please provide any reproduction steps that may need to be described. E.g. if it happens only when running the dev or build script make sure it's clear which one to use.
+      placeholder: Run `npm install` followed by `npm run dev`
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System Info
+      description: Output of `npx envinfo --system --browsers --binaries --npmPackages wxt,vite`
+      render: shell
+      placeholder: System, Binaries, Browsers
+    validations:
+      required: true
+  - type: dropdown
+    id: package-manager
+    attributes:
+      label: Used Package Manager
+      description: Select the used package manager
+      options:
+        - npm
+        - yarn
+        - pnpm
+        - bun
+    validations:
+      required: true
+  - type: checkboxes
+    id: checkboxes
+    attributes:
+      label: Validations
+      description: Before submitting the issue, please make sure you do the following
+      options:
+        - label: Read the [Contributing Guidelines](https://github.com/wxt-dev/wxt/blob/main/CONTRIBUTING.md).
+          required: true
+        - label: Read the [docs](https://wxt.dev/guide/installation.html).
+          required: true
+        - label: Check that there isn't [already an issue](https://github.com/wxt-dev/wxt/issues) that reports the same bug to avoid creating a duplicate.
+          required: true
+        - label: Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/wxt-dev/wxt/discussions) or join our [Discord Chat Server](https://discord.gg/ZFsZqGery9).
+          required: true
+        - label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discord Chat
+    url: https://discord.gg/ZFsZqGery9
+    about: Ask questions and discuss with other WXT users in real time.
+  - name: Questions & Discussions
+    url: https://github.com/wxt-dev/wxt/discussions
+    about: Use GitHub discussions for message-board style questions and discussions.

CONTRIBUTING.md

@@ -37,13 +37,13 @@ pnpm build
 
 ```sh
 # Build WXT package, then build demo extension
-cd demo
+cd packages/wxt-demo
 pnpm build
 ```
 
 ```sh
 # Build WXT package, then start the demo extension in dev mode
-cd demo
+cd packages/wxt-demo
 pnpm dev
 ```
 
@@ -75,7 +75,7 @@ To run tests for a specific file, add the filename at the end of the test comman
 pnpm test manifest-contents
 ```
 
-Unit and E2E tests are ran together via [Vitest workspaces](https://vitest.dev/guide/#workspaces-support).
+All test (unit and E2E) for all packages are ran together via [Vitest workspaces](https://vitest.dev/guide/#workspaces-support).
 
 If you want to manually test a change, you can modify the demo project for your test, but please don't leave those changes committed once you open a PR.
 
@@ -90,7 +90,7 @@ npm run dev
 npm run build
 ```
 
-Note that templates are hardcoded to a specific version of `wxt` from NPM, they do not use the local version. PR checks will test your changes against the templates, but if you want to manually do it, update the package.json dependency:
+Note that templates are hardcoded to a specific version of `wxt` from NPM, they do not use the local version. PR checks will test your PR's changes against the templates, but if you want to manually do it, update the package.json dependency:
 
 ```diff
   "devDependencies": {

packages/wxt/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## v0.18.4
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/v0.18.3...v0.18.4)
+
+### 🩹 Fixes
+
+- Allow zipping hidden files in sources by listing them explicitly in `includeSources` ([#674](https://github.com/wxt-dev/wxt/pull/674))
+- Properly invalidate content script context ([#683](https://github.com/wxt-dev/wxt/pull/683))
+
+### 📖 Documentation
+
+- Update contributing guidelines ([8125d74](https://github.com/wxt-dev/wxt/commit/8125d74))
+
+### ❤️ Contributors
+
+- Hujiulong ([@hujiulong](http://github.com/hujiulong))
+
 ## v0.18.3
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.18.2...v0.18.3)

packages/wxt/e2e/tests/zip.test.ts

@@ -96,4 +96,48 @@ describe('Zipping', () => {
     expect(await project.fileExists(artifactZip)).toBe(true);
     expect(await project.fileExists(sourcesZip)).toBe(true);
   });
+
+  it('should not zip hidden files into sources by default', async () => {
+    const project = new TestProject({
+      name: 'test',
+      version: '1.0.0',
+    });
+    project.addFile(
+      'entrypoints/background.ts',
+      'export default defineBackground(() => {});',
+    );
+    project.addFile('.env');
+    const unzipDir = project.resolvePath('.output/test-1.0.0-sources');
+    const sourcesZip = project.resolvePath('.output/test-1.0.0-sources.zip');
+
+    await project.zip({
+      browser: 'firefox',
+    });
+    await extract(sourcesZip, { dir: unzipDir });
+    console.log(unzipDir); // TODO: Remove log
+    expect(await project.fileExists(unzipDir, '.env')).toBe(false);
+  });
+
+  it('should allow zipping hidden files into sources when explicitly listed', async () => {
+    const project = new TestProject({
+      name: 'test',
+      version: '1.0.0',
+    });
+    project.addFile(
+      'entrypoints/background.ts',
+      'export default defineBackground(() => {});',
+    );
+    project.addFile('.env');
+    const unzipDir = project.resolvePath('.output/test-1.0.0-sources');
+    const sourcesZip = project.resolvePath('.output/test-1.0.0-sources.zip');
+
+    await project.zip({
+      browser: 'firefox',
+      zip: {
+        includeSources: ['.env'],
+      },
+    });
+    await extract(sourcesZip, { dir: unzipDir });
+    expect(await project.fileExists(unzipDir, '.env')).toBe(true);
+  });
 });

packages/wxt/package.json

@@ -1,7 +1,7 @@
 {
   "name": "wxt",
   "type": "module",
-  "version": "0.18.3",
+  "version": "0.18.4",
   "description": "Next gen framework for developing web extensions",
   "repository": {
     "type": "git",

packages/wxt/src/client/content-scripts/content-script-context.ts

@@ -217,7 +217,7 @@ export class ContentScriptContext implements AbortController {
     // Use postMessage so it get's sent to all the frames of the page.
     window.postMessage(
       {
-        event: ContentScriptContext.SCRIPT_STARTED_MESSAGE_TYPE,
+        type: ContentScriptContext.SCRIPT_STARTED_MESSAGE_TYPE,
         contentScriptName: this.contentScriptName,
       },
       '*',

packages/wxt/src/core/zip.ts

@@ -104,15 +104,12 @@ async function zipDir(
       // Ignore node_modules, otherwise this glob step takes forever
       ignore: ['**/node_modules'],
       onlyFiles: true,
+      dot: true,
     })
   ).filter((relativePath) => {
     return (
-      wxt.config.zip.includeSources.some((pattern) =>
-        minimatch(relativePath, pattern),
-      ) ||
-      !wxt.config.zip.excludeSources.some((pattern) =>
-        minimatch(relativePath, pattern),
-      )
+      options?.include?.some((pattern) => minimatch(relativePath, pattern)) ||
+      !options?.exclude?.some((pattern) => minimatch(relativePath, pattern))
     );
   });
   const filesToZip = [