fix: Ignore manifest.manifest_version option and warn about incorrect usage
#1419
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for creative-fairy-df92c4 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@wxt-dev/auto-icons
@wxt-dev/i18n
@wxt-dev/module-react
@wxt-dev/module-solid
@wxt-dev/module-vue
@wxt-dev/module-svelte
@wxt-dev/storage
@wxt-dev/unocss
wxt
commit: |
aklinker1
commented
Feb 12, 2025
Comment on lines
+1651
to
+1676
| describe('manifest_version', () => { | ||
| it('should ignore and log a warning when someone sets `manifest_version` inside the manifest', async () => { | ||
| const buildOutput = fakeBuildOutput(); | ||
| const expectedVersion = 2; | ||
| setFakeWxt({ | ||
| logger: mock(), | ||
| config: { | ||
| command: 'build', | ||
| manifestVersion: expectedVersion, | ||
| manifest: { | ||
| manifest_version: 3, | ||
| }, | ||
| }, | ||
| }); | ||
|
|
||
| const { manifest } = await generateManifest([], buildOutput); | ||
|
|
||
| expect(manifest.manifest_version).toBe(expectedVersion); | ||
| expect(wxt.logger.warn).toBeCalledTimes(1); | ||
| expect(wxt.logger.warn).toBeCalledWith( | ||
| expect.stringContaining( | ||
| '`manifest.manifest_version` config was set, but ignored', | ||
| ), | ||
| ); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
This new test failed before I implemented the fix in this PR.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1419 +/- ##
==========================================
- Coverage 81.40% 81.09% -0.32%
==========================================
Files 128 128
Lines 6272 6278 +6
Branches 1068 1070 +2
==========================================
- Hits 5106 5091 -15
- Misses 1151 1172 +21
Partials 15 15 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
manifest.manifest_versionis not how you configure the target manifest version. This PR ignores the option if set (previously, it overwrote the targetmanifest_version, as described in the issue) and logs a warning telling you that it is configured wrong.Manual Testing
See unit tests. No manual testing required.
Related Issue
This PR closes #1388.