feat: allow excluding extensions from building assets, fixes #286

FriendsOfShopware · Jan 14, 2024 · 071c9c7 · 071c9c7
1 parent 9a2c0eb
commit 071c9c7
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 5 deletions.
diff --git a/cmd/extension/extension_admin_watch.go b/cmd/extension/extension_admin_watch.go
@@ -4,6 +4,7 @@ import (
 	_ "embed"
 	"encoding/json"
 	"fmt"
+	"github.com/FriendsOfShopware/shopware-cli/shop"
 	"io"
 	"net/http"
 	"net/url"
@@ -57,7 +58,12 @@ var extensionAdminWatchCmd = &cobra.Command{
 		for _, extensionPath := range args[:len(args)-1] {
 			ext, err := extension.GetExtensionByFolder(extensionPath)
 			if err != nil {
-				sources = append(sources, extension.FindAssetSourcesOfProject(cmd.Context(), extensionPath)...)
+				shopCfg, err := shop.ReadConfig(path.Join(extensionPath, ".shopware-project.yml"), true)
+				if err != nil {
+					return err
+				}
+
+				sources = append(sources, extension.FindAssetSourcesOfProject(cmd.Context(), extensionPath, shopCfg)...)
 				continue
 			}
 

diff --git a/cmd/project/ci.go b/cmd/project/ci.go
@@ -67,7 +67,7 @@ var projectCI = &cobra.Command{
 
 		logging.FromContext(cmd.Context()).Infof("Looking for extensions to build assets in project")
 
-		sources := extension.FindAssetSourcesOfProject(cmd.Context(), args[0])
+		sources := extension.FindAssetSourcesOfProject(cmd.Context(), args[0], shopCfg)
 
 		assetCfg := extension.AssetBuildConfig{
 			CleanupNodeModules:           true,

diff --git a/cmd/project/project_admin_build.go b/cmd/project/project_admin_build.go
@@ -1,6 +1,7 @@
 package project
 
 import (
+	"github.com/FriendsOfShopware/shopware-cli/shop"
 	"os/exec"
 
 	"github.com/FriendsOfShopware/shopware-cli/extension"
@@ -21,9 +22,14 @@ var projectAdminBuildCmd = &cobra.Command{
 			return err
 		}
 
+		shopCfg, err := shop.ReadConfig(projectConfigPath, true)
+		if err != nil {
+			return err
+		}
+
 		logging.FromContext(cmd.Context()).Infof("Looking for extensions to build assets in project")
 
-		sources := extension.FindAssetSourcesOfProject(cmd.Context(), projectRoot)
+		sources := extension.FindAssetSourcesOfProject(cmd.Context(), projectRoot, shopCfg)
 
 		assetCfg := extension.AssetBuildConfig{
 			DisableStorefrontBuild: true,

diff --git a/cmd/project/project_storefront_build.go b/cmd/project/project_storefront_build.go
@@ -1,6 +1,7 @@
 package project
 
 import (
+	"github.com/FriendsOfShopware/shopware-cli/shop"
 	"os/exec"
 
 	"github.com/FriendsOfShopware/shopware-cli/extension"
@@ -21,9 +22,14 @@ var projectStorefrontBuildCmd = &cobra.Command{
 			return err
 		}
 
+		shopCfg, err := shop.ReadConfig(projectConfigPath, true)
+		if err != nil {
+			return err
+		}
+
 		logging.FromContext(cmd.Context()).Infof("Looking for extensions to build assets in project")
 
-		sources := extension.FindAssetSourcesOfProject(cmd.Context(), projectRoot)
+		sources := extension.FindAssetSourcesOfProject(cmd.Context(), projectRoot, shopCfg)
 
 		assetCfg := extension.AssetBuildConfig{
 			DisableAdminBuild: true,

diff --git a/extension/project.go b/extension/project.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"github.com/FriendsOfShopware/shopware-cli/shop"
 	"os"
 	"path"
 	"path/filepath"
@@ -40,7 +41,7 @@ func GetShopwareProjectConstraint(project string) (*version.Constraints, error)
 	return &c, nil
 }
 
-func FindAssetSourcesOfProject(ctx context.Context, project string) []asset.Source {
+func FindAssetSourcesOfProject(ctx context.Context, project string, shopCfg *shop.Config) []asset.Source {
 	extensions := FindExtensionsFromProject(ctx, project)
 	sources := ConvertExtensionsToSources(ctx, extensions)
 
@@ -81,6 +82,17 @@ func FindAssetSourcesOfProject(ctx context.Context, project string) []asset.Sour
 		})
 	}
 
+	if len(shopCfg.Build.ExcludeExtensions) > 0 {
+		logging.FromContext(ctx).Infof("Excluded extensions in project: %s", shopCfg.Build.ExcludeExtensions)
+		for _, excludedExtension := range shopCfg.Build.ExcludeExtensions {
+			for i, source := range sources {
+				if source.Name == excludedExtension {
+					sources = append(sources[:i], sources[i+1:]...)
+				}
+			}
+		}
+	}
+
 	return sources
 }
 

diff --git a/shop/config.go b/shop/config.go
@@ -27,6 +27,7 @@ type ConfigBuild struct {
 	KeepExtensionSource   bool     `yaml:"keep_extension_source,omitempty"`
 	CleanupPaths          []string `yaml:"cleanup_paths,omitempty"`
 	Browserslist          string   `yaml:"browserslist,omitempty"`
+	ExcludeExtensions     []string `yaml:"exclude_extensions,omitempty"`
 }
 
 type ConfigAdminApi struct {

diff --git a/shop/shopware-project-schema.json b/shop/shopware-project-schema.json
@@ -50,6 +50,11 @@
                 "browserslist": {
                     "type": "string",
                     "description": "Browserslist configuration for the Storefront build"
+                },
+                "exclude_extensions": {
+                    "type": "array",
+                    "items": {"type": "string"},
+                    "description": "Extensions to exclude from the build"
                 }
             }
         },

diff --git a/wiki/docs/shopware-project-yml-schema.md b/wiki/docs/shopware-project-yml-schema.md
@@ -34,6 +34,9 @@ build:
     - path
   # change the browserslist of the storefront build, see https://browsersl.ist for the syntax as string (example: defaults, not dead)
   browserslist: ''
+  # exclude extensions to be built by shopware-cli, only their PHP code will be shipped without any css/js
+  exclude_extensions:
+    - name
 
 # used for mysql dump creation
 dump: