public void Save(Stream stream, MarkdownFormat format = null)
{
using (MarkdownWriter mw = MarkdownWriter.Create(stream, MarkdownWriterSettings.From(format)))
{
Save(mw);
}
}
public void Save(TextWriter writer, MarkdownFormat format = null)
{
using (MarkdownWriter mw = MarkdownWriter.Create(writer, MarkdownWriterSettings.From(format)))
{
Save(mw);
}
}
private static List <TableColumnInfo> Analyze(
IEnumerator <MElement> en,
MarkdownWriterSettings settings,
MarkdownStringWriter writer)
{
MElement header = null;
var columns = new List <TableColumnInfo>();
header = en.Current;
if (header is MContainer container)
{
WriteHeaderCells(container, settings, writer, columns);
}
else
{
writer.Write(header);
columns.Add(TableColumnInfo.Create(header, writer));
}
if (settings.Format.FormatTableContent)
{
int index = writer.Length;
while (en.MoveNext())
{
int columnCount = columns.Count;
MElement row = en.Current;
if (row is MContainer rowContainer)
{
int i = 0;
foreach (MElement cell in rowContainer.Elements())
{
writer.Write(cell);
columns[i] = columns[i].UpdateWidthIfGreater(writer.Length - index);
index = writer.Length;
i++;
if (i == columnCount)
{
break;
}
}
}
else
{
writer.Write(row);
columns[0] = columns[0].UpdateWidthIfGreater(writer.Length - index);
index = writer.Length;
}
}
}
return(columns);
}
public string ToString(MarkdownWriterSettings settings)
{
StringBuilder sb = StringBuilderCache.GetInstance();
using (var writer = new MarkdownStringWriter(sb, settings))
{
WriteTo(writer);
return(StringBuilderCache.GetStringAndFree(writer.GetStringBuilder()));
}
}
private static void WriteHeaderCells(
MContainer header,
MarkdownWriterSettings settings,
MarkdownStringWriter writer,
List <TableColumnInfo> columns)
{
int index = 0;
bool isFirst = true;
bool isLast = false;
int i = 0;
using (IEnumerator <MElement> en = header.Elements().GetEnumerator())
{
if (en.MoveNext())
{
MElement curr = en.Current;
isLast = !en.MoveNext();
WriteHeaderCell(curr);
if (!isLast)
{
isFirst = false;
do
{
curr = en.Current;
isLast = !en.MoveNext();
i++;
WriteHeaderCell(curr);
}while (!isLast);
}
}
}
void WriteHeaderCell(MElement cellContent)
{
if (isFirst ||
isLast ||
settings.Format.FormatTableHeader)
{
writer.Write(cellContent);
}
columns.Add(TableColumnInfo.Create(cellContent, writer, index));
index = writer.Length;
}
}
public static List <TableColumnInfo> Analyze(IEnumerable <MElement> rows, MarkdownWriterSettings settings, IFormatProvider formatProvider)
{
using (IEnumerator <MElement> en = rows.GetEnumerator())
{
if (!en.MoveNext())
{
return(null);
}
using (var writer = new MarkdownStringWriter(formatProvider: formatProvider, settings: settings))
return(Analyze(en, settings, writer));
}
}
public string ParseHTML(string html)
{
var sb = new StringBuilder();
sb.EnsureCapacity(html.Length);
var settings = new MarkdownWriterSettings()
{
NewLineChars = "\n"
};
using (var sw = new StringWriter(sb))
using (var reader = new HtmlReader(html, false))
using (var writer = new TextileWriter(sw, settings))
{
reader.ToHtml(writer);
sw.Flush();
return(sb.ToString());
}
}
public static MarkdownWriter CreateBuilder(StringBuilder sb, MarkdownFormat format = null)
{
return(MarkdownWriter.Create(sb, settings: MarkdownWriterSettings.From(format)));
}
private static void Main(params string[] args)
{
IEnumerable <Command> commands = CommandLoader.LoadCommands(typeof(CommandLoader).Assembly)
.Select(c => c.WithOptions(c.Options.OrderBy(f => f, CommandOptionComparer.Name)))
.OrderBy(c => c.Name, StringComparer.InvariantCulture);
var application = new CommandLineApplication(
"orang",
"Search, replace, rename and delete files and its content using the power of .NET regular expressions.",
commands.OrderBy(f => f.Name, StringComparer.InvariantCulture));
string?destinationDirectoryPath = null;
string?dataDirectoryPath = null;
if (Debugger.IsAttached)
{
destinationDirectoryPath = (args.Length > 0) ? args[0] : @"..\..\..\..\..\docs\cli";
dataDirectoryPath = @"..\..\..\data";
}
else
{
destinationDirectoryPath = args[0];
dataDirectoryPath = @"..\src\DocumentationGenerator\data";
}
string readmeFilePath = Path.GetFullPath(Path.Combine(destinationDirectoryPath, "README.md"));
var settings = new MarkdownWriterSettings(
MarkdownFormat.Default.WithTableOptions(
MarkdownFormat.Default.TableOptions | TableOptions.FormatHeaderAndContent));
using (var sw = new StreamWriter(readmeFilePath, append: false, Encoding.UTF8))
using (MarkdownWriter mw = MarkdownWriter.Create(sw, settings))
{
mw.WriteStartHeading(1);
mw.WriteString("Orang Command-Line Interface");
mw.WriteRaw(" <img align=\"left\" src=\"../../images/icon48.png\">");
mw.WriteEndHeading();
mw.WriteString(application.Description);
mw.WriteLine();
mw.WriteHeading2("Commands");
Table(
TableRow("Command", "Description"),
application
.Commands
.Select(f => TableRow(Link(f.Name, f.Name + "-command.md"), f.Description)))
.WriteTo(mw);
mw.WriteLine();
string readmeLinksFilePath = Path.Combine(dataDirectoryPath, "readme_bottom.md");
if (File.Exists(readmeLinksFilePath))
{
mw.WriteRaw(File.ReadAllText(readmeLinksFilePath));
}
WriteFootNote(mw);
Console.WriteLine(readmeFilePath);
}
string valuesFilePath = Path.GetFullPath(Path.Combine(destinationDirectoryPath, "OptionValues.md"));
ImmutableArray <OptionValueProvider> providers = OptionValueProvider.GetProviders(
commands.SelectMany(f => f.Options),
OptionValueProviders.ProvidersByName.Select(f => f.Value))
.ToImmutableArray();
MDocument document = Document(
Heading1("List of Option Values"),
BulletList(providers.Select(f => Link(
f.Name,
MarkdownHelpers.CreateGitHubHeadingLink(f.Name)))),
providers.Select(provider =>
{
return(new MObject[]
{
Heading2(provider.Name),
Table(
TableRow("Value", " ", "Description"),
provider.Values.Select(f => CreateTableRow(f, providers)))
});
}));
document.Add(
Heading2("Expression Syntax"),
Table(
TableRow("Expression", "Description"),
HelpProvider.GetExpressionItems(includeDate: true)
.Select(f => TableRow(InlineCode(f.expression), f.description))));
AddFootnote(document);
var markdownFormat = new MarkdownFormat(
tableOptions: MarkdownFormat.Default.TableOptions | TableOptions.FormatContent);
File.WriteAllText(valuesFilePath, document.ToString(markdownFormat));
foreach (Command command in application.Commands)
{
readmeFilePath = Path.GetFullPath(Path.Combine(destinationDirectoryPath, $"{command.Name}-command.md"));
using (var sw = new StreamWriter(readmeFilePath, append: false, Encoding.UTF8))
using (MarkdownWriter mw = MarkdownWriter.Create(sw))
{
var writer = new DocumentationWriter(mw);
writer.WriteCommandHeading(command, application);
writer.WriteCommandDescription(command);
mw.WriteLink("Home", "README.md#readme");
foreach (string section in new[] { "Synopsis", "Arguments", "Options", "Samples" })
{
mw.WriteString(" ");
mw.WriteCharEntity((char)0x2022);
mw.WriteString(" ");
mw.WriteLink(section, "#" + section);
}
mw.WriteLine();
writer.WriteCommandSynopsis(command, application);
writer.WriteArguments(command.Arguments);
writer.WriteOptions(command.Options);
string samplesFilePath = Path.Combine(dataDirectoryPath, command.Name + "_bottom.md");
if (File.Exists(samplesFilePath))
{
string content = File.ReadAllText(samplesFilePath);
mw.WriteRaw(content);
}
WriteFootNote(mw);
Console.WriteLine(readmeFilePath);
}
}
Console.WriteLine("Done");
if (Debugger.IsAttached)
{
Console.ReadKey();
}
}
public string ToString(MarkdownFormat format)
{
return(ToString(MarkdownWriterSettings.From(format)));
}
public static MarkdownWriter Create(TextWriter output, MarkdownWriterSettings settings = null);
public static MarkdownWriter Create(StringBuilder output, MarkdownWriterSettings settings = null);
public static MarkdownWriter Create(StringBuilder output, IFormatProvider formatProvider, MarkdownWriterSettings settings = null);
public static MarkdownWriter Create(Stream stream, MarkdownWriterSettings settings = null);
protected MarkdownWriter(MarkdownWriterSettings settings = null);
