stack

Home > @infiniteobjects/heft-shopify-rig

heft-shopify-rig package

Heft rig for Shopify themes

Classes

Class	Description
ShopifySettingsManagerPlugin	Webpack plugin that will inject the correct settings for the target store

Enumerations

Enumeration	Description
ShopifyEnvironment	Known Environments

Functions

Function	Description
compileSettingsForTheme({ environment, sourcePath, destinationPath, useLocal, devMode, log, })	Creates settings for the target theme environment and copies them to the destination
createGlobForFolder(sourceFolder, targetFolder)	creates a glob for for a given folder
getEnvironmentFromStore(store)	Gets the environment for a given store
getSourcePaths(sourceFolder, targetFolder)	Get source paths
getThemePaths(themeSource)	Generates an array of files to map the theme source to the shopify theme structure.
mergeDeep(target, source)	Merges two objects deeply
reconstructTheme(options)	Takes a path to a Shopify theme and a Source theme, It copies the files from the Shopify theme to the Source theme respecting the Source theme structure.
runAsync(options)	Update the theme version in the theme schema.

Interfaces

Interface	Description
IBuildSettingsOptions	Configuration Options for building the settings
IReconstructThemeOptions	Reconstruct theme options
IShopifySettingsPluginOptions	Configuration Options for the ShopifyConfigManagerPlugin
IShopifyThemeFolderConfiguration	Shopify theme folder configuration.
IShopifyThemePaths	Structure of the theme paths.
IUpdateThemeVersionOptions	Options for the update-theme-version script.

Variables

Variable	Description
ShopifyStores	Infinite Objects Known Shopify stores.
THEME_FILES	Shopify theme folders known settings files.
THEME_STRUCTURE	Shopify theme structure.

Type Aliases

Type Alias	Description
IHeftScriptOptions	Options for scripts that are run by Heft.
ShopifyEnvironmentName	Environment names
ShopifyFolder	Shopify theme folders.