Method GetComposerCreateAllowedPaths

pkg/ddevapp/apptypes.go:385–428

GetComposerCreateAllowedPaths gets all paths relative to the app root that are allowed to be present for a given apptype when running ddev composer create-project

()

// GetComposerCreateAllowedPaths gets all paths relative to the app root that are allowed to be present
// for a given apptype when running ddev composer create-project
func (app *DdevApp) GetComposerCreateAllowedPaths() ([]string, error) {
	var allowed []string

	// doc root
	allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(app.GetDocroot()))...)

	// composer root
	allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(app.GetComposerRoot(false, false)))...)

	// allow upload dirs
	// upload dirs are probably always relative and with slashes, but we run
	// it through GetRelativeDirectory() just in case.
	uploadDirs := app.getUploadDirsRelative()
	for _, uploadDir := range uploadDirs {
		allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(uploadDir))...)
	}

	// Settings files
	allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(app.SiteSettingsPath))...)
	allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(app.SiteDdevSettingsFile))...)

	// If we have a function to do the settings creation, allow .gitignore
	// see CreateSettingsFile
	if appFuncs, ok := appTypeMatrix[app.GetType()]; ok && appFuncs.settingsCreator != nil {
		// We don't create gitignore if it would be in top-level directory, where
		// there is almost certainly already a gitignore (like Backdrop)
		if path.Dir(app.SiteSettingsPath) != app.AppRoot {
			allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(filepath.Join(filepath.Dir(app.SiteSettingsPath), ".gitignore")))...)
		}
	}

	if appFuncs, ok := appTypeMatrix[app.Type]; ok && appFuncs.composerCreateAllowedPaths != nil {
		paths, err := appFuncs.composerCreateAllowedPaths(app)
		if err != nil {
			return []string{""}, err
		}
		for _, composerPath := range paths {
			allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(composerPath))...)
		}
	}
	allowed = util.SliceToUniqueSlice(&allowed)
	sort.Strings(allowed)
	return allowed, nil
}

// SetApptypeSettingsPaths chooses and sets the settings.php/settings.local.php
// and related paths for a given app.