public Task <ICreationEffects> GetCreationEffectsAsync(
IEngineEnvironmentSettings environmentSettings,
ITemplate templateData,
IParameterSet parameters,
string targetDirectory,
CancellationToken cancellationToken)
{
RunnableProjectConfig templateConfig = (RunnableProjectConfig)templateData;
if (templateData.TemplateSourceRoot is null)
{
throw new InvalidOperationException($"{nameof(templateData.TemplateSourceRoot)} cannot be null to continue.");
}
ProcessMacros(environmentSettings, templateConfig.OperationConfig, parameters);
IVariableCollection variables = SetupVariables(environmentSettings, parameters, templateConfig.OperationConfig.VariableSetup);
templateConfig.Evaluate(parameters, variables);
IOrchestrator basicOrchestrator = new Core.Util.Orchestrator(environmentSettings.Host.Logger, environmentSettings.Host.FileSystem);
RunnableProjectOrchestrator orchestrator = new RunnableProjectOrchestrator(basicOrchestrator);
GlobalRunSpec runSpec = new GlobalRunSpec(templateData.TemplateSourceRoot, environmentSettings.Components, parameters, variables, templateConfig.OperationConfig, templateConfig.SpecialOperationConfig, templateConfig.IgnoreFileNames);
List <IFileChange2> changes = new List <IFileChange2>();
foreach (FileSourceMatchInfo source in templateConfig.Sources)
{
runSpec.SetupFileSource(source);
string target = Path.Combine(targetDirectory, source.Target);
IReadOnlyList <IFileChange2> fileChanges = orchestrator.GetFileChanges(runSpec, templateData.TemplateSourceRoot.DirectoryInfo(source.Source), target);
//source and target paths in the file changes are returned relative to source passed
//GetCreationEffects method should return the source paths relative to template source root (location of .template.config folder) and target paths relative to output path and not relative to certain source
//add source and target used to file changes to be returned as the result
changes.AddRange(
fileChanges.Select(
fileChange => new FileChange(
Path.Combine(source.Source, fileChange.SourceRelativePath),
Path.Combine(source.Target, fileChange.TargetRelativePath),
fileChange.ChangeKind,
#pragma warning disable CS0618 // Type or member is obsolete
fileChange.Contents)));
#pragma warning restore CS0618 // Type or member is obsolete
}
return(Task.FromResult((ICreationEffects) new CreationEffects2(changes, GetCreationResult(environmentSettings.Host.Logger, templateConfig, variables))));
}
public bool TryGetTemplateFromConfigInfo(IFileSystemInfo templateFileConfig, out ITemplate?template, IFileSystemInfo?localeFileConfig = null, IFile?hostTemplateConfigFile = null, string?baselineName = null)
{
_ = templateFileConfig ?? throw new ArgumentNullException(nameof(templateFileConfig));
ILogger logger = templateFileConfig.MountPoint.EnvironmentSettings.Host.LoggerFactory.CreateLogger <RunnableProjectGenerator>();
try
{
IFile templateFile = templateFileConfig as IFile
?? throw new NotSupportedException(string.Format(LocalizableStrings.RunnableProjectGenerator_Exception_ConfigShouldBeFile, templateFileConfig.GetDisplayPath()));
IFile?localeFile = null;
if (localeFileConfig != null)
{
localeFile = localeFileConfig as IFile
?? throw new NotSupportedException(string.Format(LocalizableStrings.RunnableProjectGenerator_Exception_LocaleConfigShouldBeFile, localeFileConfig.GetDisplayPath()));
}
var templateConfiguration = new RunnableProjectConfig(templateFileConfig.MountPoint.EnvironmentSettings, this, templateFile, hostTemplateConfigFile, localeFile, baselineName);
template = templateConfiguration;
return(true);
}
catch (TemplateValidationException)
{
//do nothing
//template validation prints all required information
}
catch (NotSupportedException ex)
{
//do not print stack trace for this type.
logger.LogError(LocalizableStrings.Authoring_TemplateNotInstalled_Message, templateFileConfig.GetDisplayPath(), ex.Message);
}
catch (TemplateAuthoringException ex)
{
//do not print stack trace for this type.
logger.LogError(LocalizableStrings.Authoring_TemplateNotInstalled_Message, templateFileConfig.GetDisplayPath(), ex.Message);
}
catch (Exception ex)
{
//unexpected error - print details
logger.LogError(LocalizableStrings.Authoring_TemplateNotInstalled_Message, templateFileConfig.GetDisplayPath(), ex);
}
template = null;
return(false);
}
public Task <ICreationResult> CreateAsync(
IEngineEnvironmentSettings environmentSettings,
ITemplate templateData,
IParameterSet parameters,
string targetDirectory,
CancellationToken cancellationToken)
{
RunnableProjectConfig templateConfig = (RunnableProjectConfig)templateData;
if (templateData.TemplateSourceRoot is null)
{
throw new InvalidOperationException($"{nameof(templateData.TemplateSourceRoot)} cannot be null to continue.");
}
return(CreateAsync(
environmentSettings,
templateConfig,
templateData.TemplateSourceRoot,
parameters,
targetDirectory,
cancellationToken));
}
public IList <ITemplate> GetTemplatesAndLangpacksFromDir(IMountPoint source, out IList <ILocalizationLocator> localizations)
{
_ = source ?? throw new ArgumentNullException(nameof(source));
ILogger logger = source.EnvironmentSettings.Host.LoggerFactory.CreateLogger <RunnableProjectGenerator>();
IDirectory folder = source.Root;
IList <ITemplate> templateList = new List <ITemplate>();
localizations = new List <ILocalizationLocator>();
foreach (IFile file in folder.EnumerateFiles(TemplateConfigFileName, SearchOption.AllDirectories))
{
logger.LogDebug($"Found {TemplateConfigFileName} at {file.GetDisplayPath()}.");
try
{
IFile?hostConfigFile = FindBestHostTemplateConfigFile(source.EnvironmentSettings, file);
logger.LogDebug($"Found *{HostTemplateFileConfigBaseName} at {hostConfigFile?.GetDisplayPath()}.");
// issue here: we need to pass locale as parameter
// consider passing current locale file here if exists
// tracking issue: https://github.com/dotnet/templating/issues/3255
var templateConfiguration = new RunnableProjectConfig(source.EnvironmentSettings, this, file, hostConfigFile);
IDirectory?localizeFolder = file.Parent?.DirectoryInfo("localize");
if (localizeFolder != null && localizeFolder.Exists)
{
foreach (IFile locFile in localizeFolder.EnumerateFiles(LocalizationFilePrefix + "*" + LocalizationFileExtension, SearchOption.AllDirectories))
{
string locale = locFile.Name.Substring(LocalizationFilePrefix.Length, locFile.Name.Length - LocalizationFilePrefix.Length - LocalizationFileExtension.Length);
try
{
ILocalizationModel locModel = LocalizationModelDeserializer.Deserialize(locFile);
if (templateConfiguration.VerifyLocalizationModel(locModel, locFile))
{
localizations.Add(new LocalizationLocator(
locale,
locFile.FullPath,
templateConfiguration.Identity,
locModel.Author ?? string.Empty,
locModel.Name ?? string.Empty,
locModel.Description ?? string.Empty,
locModel.ParameterSymbols));
}
}
catch (Exception ex)
{
logger.LogWarning(LocalizableStrings.LocalizationModelDeserializer_Error_FailedToParse, locFile.GetDisplayPath());
logger.LogDebug("Details: {0}", ex);
}
}
}
templateList.Add(templateConfiguration);
}
catch (TemplateValidationException)
{
//do nothing
//template validation prints all required information
}
catch (NotSupportedException ex)
{
//do not print stack trace for this type.
logger.LogError(LocalizableStrings.Authoring_TemplateNotInstalled_Message, file.GetDisplayPath(), ex.Message);
}
catch (TemplateAuthoringException ex)
{
//do not print stack trace for this type.
logger.LogError(LocalizableStrings.Authoring_TemplateNotInstalled_Message, file.GetDisplayPath(), ex.Message);
}
catch (Exception ex)
{
//unexpected error - print details
logger.LogError(LocalizableStrings.Authoring_TemplateNotInstalled_Message, file.GetDisplayPath(), ex);
}
}
return(templateList);
}
public IParameterSet GetParametersForTemplate(IEngineEnvironmentSettings environmentSettings, ITemplate template)
{
RunnableProjectConfig templateConfig = (RunnableProjectConfig)template;
return(new ParameterSet(templateConfig));
}