webpack image sizes plugin

[n-langle]

Prevent webpack image sizes plugin to be called too many times

Summary by Sourcery

Optimize the WebpackImageSizesPlugin to avoid repeated invocations by tracking build state and file changes, streamline its initialization logic, and correct the SCSS import path for Poppins font mixins.

Enhancements:

• Throttle image sizes generation by tracking build state and skipping runs when no config images change
• Leverage compilation.modifiedFiles in watch mode to detect changes and conditionally invoke the plugin
• Refactor option initialization to apply static defaults before merging custom settings
• Remove redundant path resolutions by extracting compiler context once in the apply hook
• Introduce a static hasBeenBuiltOnce flag to track first build and prevent unnecessary re-generation
• Update watchRun hook signature to use compilation context for change detection

[sourcery-ai]

Reviewer's Guide

This PR refactors the WebpackImageSizesPlugin to streamline default option handling, optimize its execution by skipping redundant runs through build and config-change detection, refactors hook implementations for correct context and parameter usage, and updates the SCSS font mixin import path.

Sequence Diagram for WebpackImageSizesPlugin Conditional Execution

sequenceDiagram
  participant C as WebpackCompiler
  participant P as WebpackImageSizesPlugin

  C->>P: Hook triggered (emit or watchRun) with Compilation
  activate P
  P->>P: runGeneration(compilation, callback)
  alt Initial build OR confImgPath changed in compilation.modifiedFiles
    P->>P: Set hasBeenBuiltOnce = true
    P->>P: Log "Starting WebpackImageSizesPlugin generation..."
    P-->>P: Perform image processing tasks
    P->>C: callback()
  else Not initial build AND no changes in confImgPath
    P->>P: Log "No changes detected in confImgPath"
    P-->>P: Skip image generation
    P->>C: callback()
  end
  deactivate P

Loading

Updated Class Diagram for WebpackImageSizesPlugin

classDiagram
  class WebpackImageSizesPlugin {
    +boolean hasBeenBuiltOnce$
    +constructor(options: Object)
    +apply(compiler: WebpackCompiler)
    +generateDefaultImages(context: string, imageSizes: Object)
  }

Loading

State Diagram for WebpackImageSizesPlugin Build Status

stateDiagram-v2
    [*] --> NotBuiltYet : Initial State
    NotBuiltYet: Plugin has not run successfully yet.
    BuiltOnce: Plugin has run successfully at least once.

    NotBuiltYet --> BuiltOnce : First successful runGeneration completes
    BuiltOnce --> BuiltOnce : Subsequent runGeneration (executes or skips based on changes)

Loading

File-Level Changes

Change	Details	Files
Simplify default option assignment	Define literal defaults before merging with options using spread Remove inline fallback logic in constructor	config/webpack-image-sizes-plugin.js
Optimize plugin execution and hook logic	Add static hasBeenBuiltOnce flag and detect modifiedFiles to skip runs Extract compiler.context at top and remove duplicate path resolutions Update watchRun hook to pass compilation, adjust generateDefaultImages call	config/webpack-image-sizes-plugin.js
Fix SCSS font mixins import path	Change @use path to reference node_modules via relative path	src/scss/03-base/_fonts.scss

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @n-langle - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 3 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[firestar300]

Traiter les retours de Sourcery.