Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

feat: add modifyEnvironmentConfig hook #2707

Merged
merged 5 commits into from
Jun 26, 2024

Conversation

9aoy
Copy link
Contributor

@9aoy 9aoy commented Jun 26, 2024

Summary

support modify environment config via modifyEnvironmentConfig hook.

Type:

type ModifyEnvironmentConfigUtils = {
  /** environment name. */
  name: string;
  /** Merge multiple Rsbuild environment config objects into one. */
  mergeEnvironmentConfig: (
    config: MergedEnvironmentConfig,
    ...configs: EnvironmentConfig[]
  ) => MergedEnvironmentConfig;
};

function ModifyEnvironmentConfig(
  callback: (
    config: MergedEnvironmentConfig,
    utils: ModifyEnvironmentConfigUtils,
  ) => MaybePromise<MergedEnvironmentConfig | void>,
): void;

Example:

const myPlugin = () => ({
  setup: (api) => {
    api.modifyEnvironmentConfig((config, { name }) => {
      if (name !== 'web') {
          return;
       }
      config.html ||= {};
      config.html.title = 'My Default Title';
    });
  },
});

Related Links

#2620

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copy link

netlify bot commented Jun 26, 2024

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit b514c10
🔍 Latest deploy log https://app.netlify.com/sites/rsbuild/deploys/667bb2c19aa50c0008e03032
😎 Deploy Preview https://deploy-preview-2707--rsbuild.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 78 (🔴 down 10 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

packages/core/src/provider/initConfigs.ts Outdated Show resolved Hide resolved
packages/core/src/provider/initConfigs.ts Outdated Show resolved Hide resolved
packages/shared/src/types/config/index.ts Show resolved Hide resolved
packages/shared/src/types/hooks.ts Show resolved Hide resolved
@chenjiahan chenjiahan merged commit f2483ac into web-infra-dev:main Jun 26, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants