/// <summary>
/// Set the <see cref="AsciiDoctorJRunnerSettings.Backend"/> to a builtin backend.
/// Possible values are <see cref="BuiltinBackend"/>.
/// For non-builtin backends (i.e. plugins) use <see cref="WithBackend(AsciiDoctorJRunnerSettings, string)"/>.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <param name="backend">The <see cref="BuiltinBackend"/> to set.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithBuiltinBackend(this AsciiDoctorJRunnerSettings @this, BuiltinBackend backend)
{
// ReSharper disable PossibleNullReferenceException
@this.Backend = Enum.GetName(typeof(BuiltinBackend), backend).ToLowerInvariant();
// ReSharper enable PossibleNullReferenceException
return(@this);
}
/// <summary>
/// Add a list of files to <see cref="AsciiDoctorJRunnerSettings.InputFiles"/>
/// </summary>
/// <param name="this"></param>
/// <param name="files"></param>
/// <returns></returns>
public static AsciiDoctorJRunnerSettings WithInputFiles(this AsciiDoctorJRunnerSettings @this, IEnumerable <FilePath> files)
{
foreach (var f in files)
{
@this.InputFiles.Add(f);
}
return(@this);
}
/// <summary>
/// Add one attribute to <see cref="AsciiDoctorJRunnerSettings.Attributes"/>
/// </summary>
/// <param name="this"></param>
/// <param name="attrs"></param>
/// <returns></returns>
public static AsciiDoctorJRunnerSettings WithAttributes(this AsciiDoctorJRunnerSettings @this, IEnumerable <KeyValuePair <string, string> > attrs)
{
foreach (var kvp in attrs)
{
@this.Attributes[kvp.Key] = kvp.Value;
}
return(@this);
}
/// <summary>
/// Add multiple paths to <see cref="AsciiDoctorJRunnerSettings.ClassPath"/>
/// </summary>
/// <param name="this"></param>
/// <param name="paths"></param>
/// <returns></returns>
public static AsciiDoctorJRunnerSettings WithClassPaths(this AsciiDoctorJRunnerSettings @this, IEnumerable <DirectoryPath> paths)
{
foreach (var p in paths)
{
@this.ClassPath.Add(p);
}
return(@this);
}
public static void AsciiDoctorJ(
this ICakeContext context,
AsciiDoctorJRunnerSettings settings)
{
if (context == null)
{
throw new ArgumentNullException(nameof(context));
}
if (settings == null)
{
throw new ArgumentNullException(nameof(settings));
}
var runner = new AsciiDoctorJRunner(context.FileSystem, context.Environment, context.ProcessRunner, context.Tools);
runner.Run(settings);
}
/// <summary>
/// Set the <see cref="AsciiDoctorJRunnerSettings.Output"/>.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <param name="output">the <see cref="FilePath"/> to set.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithOutputFile(this AsciiDoctorJRunnerSettings @this, FilePath output)
{
@this.Output = output;
return(@this);
}
/// <summary>
/// Set the <see cref="AsciiDoctorJRunnerSettings.Backend"/>
/// Use this only if you need a non-builtin backend (e.g. "pdf")
/// For builtin backends use <see cref="WithBuiltinBackend(AsciiDoctorJRunnerSettings, BuiltinBackend)"/>.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <param name="backend">The name of the backend to use.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithBackend(this AsciiDoctorJRunnerSettings @this, string backend)
{
@this.Backend = backend;
return(@this);
}
/// <summary>
/// Add one path to <see cref="AsciiDoctorJRunnerSettings.ClassPath"/>.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <param name="path">the directory to add to <see cref="AsciiDoctorJRunnerSettings.ClassPath"/>.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithClassPath(this AsciiDoctorJRunnerSettings @this, DirectoryPath path)
{
@this.ClassPath.Add(path);
return(@this);
}
/// <summary>
/// Sets <see cref="AsciiDoctorJRunnerSettings.Compact"/> to true.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithCompact(this AsciiDoctorJRunnerSettings @this)
{
@this.Compact = true;
return(@this);
}
/// <summary>
/// Sets the <see cref="AsciiDoctorJRunnerSettings.DestinationDir"/>.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <param name="dir">the <see cref="DirectoryPath"/> to set.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithDestinationDir(this AsciiDoctorJRunnerSettings @this, DirectoryPath dir)
{
@this.DestinationDir = dir;
return(@this);
}
/// <summary>
/// Set the <see cref="AsciiDoctorJRunnerSettings.TemplateEngine"/>.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <param name="engine">The name of the template-engine to use.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithTemplateEngine(this AsciiDoctorJRunnerSettings @this, string engine)
{
@this.TemplateEngine = engine;
return(@this);
}
/// <summary>
/// set <see cref="AsciiDoctorJRunnerSettings.Verbose"/> to true.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithVerbose(this AsciiDoctorJRunnerSettings @this)
{
@this.Verbose = true;
return(@this);
}
/// <summary>
/// Add multiple attributes to <see cref="AsciiDoctorJRunnerSettings.Attributes"/>.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <param name="key">The key of the attribute to set.</param>
/// <param name="value">The value of the attribute to set.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithAttribute(this AsciiDoctorJRunnerSettings @this, string key, string value)
{
@this.Attributes[key] = value;
return(@this);
}
/// <summary>
/// Set <see cref="AsciiDoctorJRunnerSettings.Quiet"/> to true.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithQuiet(this AsciiDoctorJRunnerSettings @this)
{
@this.Quiet = true;
return(@this);
}
/// <summary>
/// Set <see cref="AsciiDoctorJRunnerSettings.Require"/> to true.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithRequire(this AsciiDoctorJRunnerSettings @this)
{
@this.Require = true;
return(@this);
}
/// <summary>
/// Set <see cref="AsciiDoctorJRunnerSettings.SafeMode"/>
/// For possible values <see cref="SafeMode"/>.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <param name="mode">The <see cref="SafeMode"/> to set.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithSafeMode(this AsciiDoctorJRunnerSettings @this, SafeMode mode)
{
@this.SafeMode = mode;
return(@this);
}
/// <summary>
/// Set <see cref="AsciiDoctorJRunnerSettings.SectionNumbers"/> to true.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithSectionNumbers(this AsciiDoctorJRunnerSettings @this)
{
@this.SectionNumbers = true;
return(@this);
}
/// <summary>
/// Set the <see cref="AsciiDoctorJRunnerSettings.Backend"/> to a builtin backend.
/// Possible values <seealso cref="BuiltinBackend"/>
/// </summary>
/// <param name="this"></param>
/// <param name="backend"></param>
/// <returns></returns>
public static AsciiDoctorJRunnerSettings WithBuiltinBackend(this AsciiDoctorJRunnerSettings @this, BuiltinBackend backend)
{
@this.Backend = Enum.GetName(typeof(BuiltinBackend), backend).ToLower(CultureInfo.InvariantCulture);
return(@this);
}
/// <summary>
/// Add a single File to <see cref="AsciiDoctorJRunnerSettings.InputFiles"/>.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <param name="file">The file to add to <see cref="AsciiDoctorJRunnerSettings.InputFiles"/>.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithInputFile(this AsciiDoctorJRunnerSettings @this, FilePath file)
{
@this.InputFiles.Add(file);
return(@this);
}
/// <summary>
/// Set <see cref="AsciiDoctorJRunnerSettings.SuppressHeaderAndFooter"/> to true.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithSuppressHeaderAndFooter(this AsciiDoctorJRunnerSettings @this)
{
@this.SuppressHeaderAndFooter = true;
return(@this);
}
/// <summary>
/// set <see cref="AsciiDoctorJRunnerSettings.TimingsMode"/> to true.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithTimingsMode(this AsciiDoctorJRunnerSettings @this)
{
@this.TimingsMode = true;
return(@this);
}
/// <summary>
/// Sets <see cref="AsciiDoctorJRunnerSettings.ERuby"/>
/// Possible values <see cref="ERuby"/>.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <param name="eRuby">The <see cref="ERuby"/> to set.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithERuby(this AsciiDoctorJRunnerSettings @this, ERuby eRuby)
{
@this.ERuby = eRuby;
return(@this);
}
/// <summary>
/// Set the <see cref="AsciiDoctorJRunnerSettings.TemplateDir"/>.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <param name="dir">The directory to set.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithTemplateDir(this AsciiDoctorJRunnerSettings @this, DirectoryPath dir)
{
@this.TemplateDir = dir;
return(@this);
}
/// <summary>
/// Sets the <see cref="AsciiDoctorJRunnerSettings.DocType"/>
/// Possible Values <see cref="DocType"/>.
/// </summary>
/// <param name="this">The <see cref="AsciiDoctorJRunnerSettings"/> that extended by this.</param>
/// <param name="docType">The <see cref="DocType"/> to set.</param>
/// <returns>The reference to the <see cref="AsciiDoctorJRunnerSettings"/>.</returns>
public static AsciiDoctorJRunnerSettings WithDocType(this AsciiDoctorJRunnerSettings @this, DocType docType)
{
@this.DocType = docType;
return(@this);
}
