Package com.vaadin.flow.plugin.base

Class CleanOptions

java.lang.Object
com.vaadin.flow.plugin.base.CleanOptions
public class CleanOptions extends Object
Options for cleaning the frontend files to a clean state.

  • Constructor Details

    • CleanOptions

      public CleanOptions()

  • Method Details

    • withRemovePackageLock

      public CleanOptions withRemovePackageLock(boolean removePackageLock)
      Set to false to keep package lock file (pnpm-lock.yaml or bun.lockb or package-lock.json).
      Parameters:
      removePackageLock - whether to remove lock file
      Returns:
      for chaining

    • withRemovePnpmFile

      public CleanOptions withRemovePnpmFile(boolean removePnpmFile)
      Set to false to keep the .pnpmfile.cjs file as is.
      Parameters:
      removePnpmFile - whether to remove .pnpmfile.cjs file
      Returns:
      for chaining

    • withRemoveGeneratedTSFolder

      public CleanOptions withRemoveGeneratedTSFolder(boolean removeGeneratedTSFolder)
      Set to false to keep the generated ts folder as is.
      Parameters:
      removeGeneratedTSFolder - whether to remove the generated ts folder
      Returns:
      for chaining

    • withRemoveFrontendGeneratedFolder

      public CleanOptions withRemoveFrontendGeneratedFolder(boolean removeFrontendGeneratedFolder)
      Set to false to keep the frontend generated folder as is.
      Parameters:
      removeFrontendGeneratedFolder - whether to remove the frontend generated folder
      Returns:
      for chaining

    • withCleanPackageJson

      public CleanOptions withCleanPackageJson(boolean cleanPackageJson)
      Set to false to keep the package.json file as is.
      Parameters:
      cleanPackageJson - whether to clean the package.json file
      Returns:
      for chaining

    • withRemoveDevBundle

      public CleanOptions withRemoveDevBundle(boolean removeDevBundle)
      Set to false to keep the dev bundle as is.
      Parameters:
      removeDevBundle - whether to remove the dev bundle
      Returns:
      for chaining

    • withRemoveNodeModules

      public CleanOptions withRemoveNodeModules(boolean removeNodeModules)
      Set to false to keep the node_modules folder as is.
      Parameters:
      removeNodeModules - whether to remove the node_modules folder
      Returns:
      for chaining

    • isRemovePackageLock

      public boolean isRemovePackageLock()
      Returns:
      whether to remove package lock file (pnpm-lock.yaml or bun.lockb or package-lock.json)

    • isRemovePnpmFile

      public boolean isRemovePnpmFile()
      Returns:
      whether to remove .pnpmfile.cjs file

    • isRemoveGeneratedTSFolder

      public boolean isRemoveGeneratedTSFolder()
      Returns:
      whether to remove the generated ts folder where flow will put TS API files for client projects.

    • isRemoveFrontendGeneratedFolder

      public boolean isRemoveFrontendGeneratedFolder()
      Returns:
      whether to remove the frontend generated folder

    • isCleanPackageJson

      public boolean isCleanPackageJson()
      Returns:
      whether to clean the package.json file

    • isRemoveDevBundle

      public boolean isRemoveDevBundle()
      Returns:
      whether to remove the dev bundle

    • isRemoveNodeModules

      public boolean isRemoveNodeModules()
      Returns:
      whether to remove the node_modules folder