Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

fix!: Rename runner to webExt #1180

Merged
merged 6 commits into from
Nov 16, 2024
Merged

Conversation

aklinker1
Copy link
Collaborator

@aklinker1 aklinker1 commented Nov 16, 2024

BREAKING CHANGES:

  • Rename ExtensionRunnerConfig type to WebExtConfig
    -import type { ExtensionRunnerConfig } from 'wxt';
    +import type { WebExtConfig } from 'wxt';

Non-breaking deprecations (you'll see a warning if you haven't migrated):

  • Deprecate InlineConfig#runner in favor of InlineConfig#webExt
    // wxt.config.ts
    export default defineConfig({
    - runner: {
    + webExt: {
        startUrls: ["https://wxt.dev"],
      }, 
    });
  • Deprecate defineRunnerConfig in favor of defineWebExtConfig
    -import { defineRunnerConfig } from 'wxt';
    +import { defineWebExtConfig } from 'wxt';

This improves the consistency of naming between the filename (web-ext.config.ts) and the config (WebExtConfig, InlineConfig#webExt). It also provides a bit more clarity that web-ext isn't apart of WXT.

@aklinker1 aklinker1 self-assigned this Nov 16, 2024
@aklinker1 aklinker1 changed the title fix!: Rename runner → webExtRunner fix!: Rename runnerwebExtRunner Nov 16, 2024
@aklinker1 aklinker1 closed this Nov 16, 2024
@aklinker1
Copy link
Collaborator Author

Gonna hold off on doing this until we actually create a replacement for web-ext.

@aklinker1 aklinker1 reopened this Nov 16, 2024
@aklinker1
Copy link
Collaborator Author

Nevermind, I want to rename the stuff before 1.0, so reopening.

Copy link

codecov bot commented Nov 16, 2024

Codecov Report

Attention: Patch coverage is 42.10526% with 11 lines in your changes missing coverage. Please review.

Project coverage is 81.60%. Comparing base (7c693e8) to head (f69d976).
Report is 1 commits behind head on 0.20.0-breaking-changes.

Files with missing lines Patch % Lines
packages/wxt/src/core/define-web-ext-config.ts 30.00% 7 Missing ⚠️
packages/wxt/src/core/resolve-config.ts 50.00% 4 Missing ⚠️
Additional details and impacted files
@@                     Coverage Diff                     @@
##           0.20.0-breaking-changes    #1180      +/-   ##
===========================================================
+ Coverage                    81.16%   81.60%   +0.44%     
===========================================================
  Files                          124      124              
  Lines                         6519     6529      +10     
  Branches                      1088     1098      +10     
===========================================================
+ Hits                          5291     5328      +37     
+ Misses                        1211     1184      -27     
  Partials                        17       17              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aklinker1 aklinker1 changed the title fix!: Rename runnerwebExtRunner fix!: Rename runnerwebExt Nov 16, 2024
@aklinker1 aklinker1 changed the title fix!: Rename runnerwebExt fix!: Rename runner to webExt Nov 16, 2024
@aklinker1 aklinker1 marked this pull request as ready for review November 16, 2024 17:31
@aklinker1 aklinker1 merged commit 96445c9 into 0.20.0-breaking-changes Nov 16, 2024
12 checks passed
@aklinker1 aklinker1 deleted the rename-runner-config branch November 16, 2024 17:34
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant