Class AbstractSimpleBundler

Namespace

Kentico.Content.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Manages contents of a bundle. The containing directories are listed in the IncludedWebRootDirectories property.

public abstract class AbstractSimpleBundler

Inheritance

object

AbstractSimpleBundler

Derived

SimpleScriptsBundler

SimpleStylesBundler

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Remarks

The class does not perform the actual bundling. It is up to the build infrastructure to create a bundle comprising all the files within IncludedWebRootDirectories. The class' purpose is to list the individual bundle files in scenarios where the actual bundle is not being used (e.g. debugging).

Properties

FilePattern

Gets pattern for locating bundle files in IncludedWebRootDirectories. The default value is RegularExtension prefixed by an asterisk (e.g. '.css', '.js').

protected virtual string FilePattern { get; }

Property Value

string

IncludedWebRootDirectories

Gets a list of directories within wwwroot to be included in the bundle.

public List<string> IncludedWebRootDirectories { get; }

Property Value

List<string>

MinifiedExtension

Gets extension of minified files to be included in the bundle (e.g. '.min.css', '.min.js').

protected abstract string MinifiedExtension { get; }

Property Value

string

RegularExtension

Gets extension of files to be included in the bundle (e.g. '.css', '.js').

protected abstract string RegularExtension { get; }

Property Value

string

Methods

EnumerateFiles(IFileProvider, string)

Enumerates all files to be bundled from IncludedWebRootDirectories and their subdirectories. The web root path is determined from the webRootFileProvider and webRootSubPath.

public IEnumerable<string> EnumerateFiles(IFileProvider webRootFileProvider, string webRootSubPath)

Parameters

webRootFileProvider IFileProvider

webRootSubPath string

Returns

IEnumerable<string>

Returns an enumeration of bundle files.

Remarks

If a file is present in both its regular and minified version, only the regular version is enumerated.

EnumerateFiles(string)

Enumerates all files to be bundled from IncludedWebRootDirectories and their subdirectories.

public IEnumerable<string> EnumerateFiles(string webRootPath)

Parameters

webRootPath string

Returns

IEnumerable<string>

Returns an enumeration of bundle files.

Remarks

If a file is present in both its regular and minified version, only the regular version is enumerated.

PreferNonMinifiedFiles(HashSet<string>)

Picks non minified files from files set when a file has both its regular and minified version (e.g. component.css and component.min.css).

protected virtual IEnumerable<string> PreferNonMinifiedFiles(HashSet<string> files)

Parameters

files HashSet<string>

Returns

IEnumerable<string>

UseForwardSlashes(IEnumerable<string>)

Replaces backslashes by forward slashes.

protected virtual IEnumerable<string> UseForwardSlashes(IEnumerable<string> paths)

Parameters

paths IEnumerable<string>

Returns

IEnumerable<string>