TestMu Conference is Back! Future of Testing + AI LambdaTest G2 Announcement

How to use Toc class of Microsoft.Coyote.GenDoc package

Best Coyote code snippet using Microsoft.Coyote.GenDoc.Toc

Program.cs

Source:Program.cs

...55            command.SetHandler((string assembly, string output, string name) =>56            {57                var settings = new XmlDocMarkdownSettings()58                {59                    GenerateToc = true,60                    TocPrefix = "ref",61                    RootNamespace = name,62                    VisibilityLevel = XmlDocVisibilityLevel.Protected,63                    ShouldClean = true,64                    SkipUnbrowsable = true,65                    NamespacePages = true66                };67                XmlDocMarkdownGenerator.Generate(assembly, output, settings);68            }, pathArg, outputOption, namespaceOption);69            return command;70        }71        /// <summary>72        /// Creates the merge command.73        /// </summary>74        private static Command CreateMergeCommand()75        {76            var sourceTocArg = new Argument<string>("src", $"Path to the source mkdocs.yml file.")77            {78                HelpName = "SRC_TOC"79            };80            var destinationTocArg = new Argument<string>("dst", $"Path to the destination toc.yml file.")81            {82                HelpName = "DST_TOC"83            };84            // Add validators.85            sourceTocArg.AddValidator(result => ValidateArgumentValueIsExpectedFile(result, ".yml"));86            destinationTocArg.AddValidator(result => ValidateArgumentValueIsExpectedFile(result, ".yml"));87            // Build command.88            var command = new Command("merge", "Merges the ToC information into the mkdocs.yml nav section.");89            command.AddArgument(sourceTocArg);90            command.AddArgument(destinationTocArg);91            command.TreatUnmatchedTokensAsErrors = true;92            command.SetHandler((string src, string dst) =>93            {94                FixXmlDocs(Path.GetDirectoryName(dst));95                int result = MergeToc(src, dst);96                Environment.ExitCode = result;97            }, sourceTocArg, destinationTocArg);98            return command;99        }100        private static void FixXmlDocs(string dir)101        {102            // The xmldocmd.exe tool is putting ".md.md" on some links, this fixes that bug.103            foreach (var file in Directory.GetFiles(dir, "*.md"))104            {105                FixXmlDoc(file);106            }107            foreach (var child in Directory.GetDirectories(dir))108            {109                FixXmlDocs(child);110            }111        }112        private static void FixXmlDoc(string filename)113        {114            string text = File.ReadAllText(filename);115            string correct = text.Replace(".md.md", ".md");116            if (correct != text)117            {118                Console.WriteLine("Fixing " + filename);119                File.WriteAllText(filename, correct);120            }121        }122        private static int MergeToc(string mkdocsPath, string newTocPath)123        {124            var mkdocs = new YamlStream();125            using (var reader = new StreamReader(mkdocsPath))126            {127                mkdocs.Load(reader);128            }129            Toc toc = null;130            using (var reader = new StreamReader(newTocPath))131            {132                // Examine the new toc.133                var deserializer = new YamlDotNet.Serialization.DeserializerBuilder().Build();134                toc = deserializer.Deserialize<Toc>(reader);135            }136            // The mkdocs format is not amenable to object serialization.137            var root = (YamlMappingNode)mkdocs.Documents[0].RootNode;138            // Examine the stream.139            var items = (YamlSequenceNode)root.Children[new YamlScalarNode("nav")];140            var apitoc = items.Where(it => it is YamlMappingNode ym && ym.Children.Count > 0 &&141                                    ym.Children[0].Key is YamlScalarNode s && s.Value == "API documentation").FirstOrDefault() as YamlMappingNode;142            if (apitoc == null)143            {144                apitoc = new YamlMappingNode();145                items.Add(apitoc);146            }147            apitoc.Children.Clear();148            var s = new YamlSequenceNode();149            apitoc.Add(new YamlScalarNode("API documentation"), s);150            int count = AddLinks(s, toc.toc);151            // Save the updated mkdocs.152            using (var writer = new StreamWriter(mkdocsPath))153            {154                mkdocs.Save(writer, false);155            }156            Console.WriteLine("Added {0} api documentation links to the nav: section in {1}", count, mkdocsPath);157            return 0;158        }159        private static string GetHref(Link link)160        {161            var href = link.link;162            if (!href.EndsWith(".md"))163            {164                href += ".md";165            }166            return href;167        }168        private static int AddLinks(YamlSequenceNode parent, Link[] links)169        {170            int count = 0;171            foreach (var link in links)172            {173                if (link.subfolderitems == null || link.subfolderitems.Length == 0)174                {175                    var node = new YamlMappingNode();176                    node.Add(link.name, GetHref(link));177                    parent.Children.Add(node);178                    count++;179                }180                else181                {182                    var node = new YamlMappingNode();183                    var s = new YamlSequenceNode();184                    var href = GetHref(link);185                    node.Add(link.name, s);186                    parent.Children.Add(node);187                    var overview = new YamlMappingNode();188                    if (href.EndsWith("Assembly.md"))189                    {190                        overview.Add("Assembly Overview", href);191                    }192                    else if (href.EndsWith("Namespace.md"))193                    {194                        overview.Add("Namespace Overview", href);195                    }196                    else if (href.EndsWith("Type.md"))197                    {198                        overview.Add("Type Overview", href);199                    }200                    else201                    {202                        overview.Add("Overview", href);203                    }204                    s.Add(overview);205                    count += AddLinks(s, link.subfolderitems) + 1;206                }207            }208            return count;209        }210        /// <summary>211        /// Validates that the specified argument result is found and has an expected file extension.212        /// </summary>213        private static void ValidateArgumentValueIsExpectedFile(ArgumentResult result, params string[] extensions)214        {215            string fileName = result.GetValueOrDefault<string>();216            string foundExtension = Path.GetExtension(fileName);217            if (!extensions.Any(extension => extension == foundExtension))218            {219                if (extensions.Length is 1)220                {221                    result.ErrorMessage = $"File '{fileName}' does not have the expected '{extensions[0]}' extension.";222                }223                else224                {225                    result.ErrorMessage = $"File '{fileName}' does not have one of the expected extensions: " +226                        $"{string.Join(", ", extensions)}.";227                }228            }229            else if (!File.Exists(fileName))230            {231                result.ErrorMessage = $"File '{fileName}' does not exist.";232            }233        }234#pragma warning disable SA1300 // Element should begin with upper-case letter235        public class Toc236        {237            public Link[] toc { get; set; }238        }239        public class Link240        {241            public string name { get; set; }242            public string link { get; set; }243            public Link[] subfolderitems { get; set; }244        }245#pragma warning restore SA1300 // Element should begin with upper-case letter246    }247}...

Toc

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.Coyote.GenDoc;7{8    {9        static void Main(string[] args)10        {11            Toc toc = new Toc();12            toc.Add("1", "Chapter 1", "1.html");13            toc.Add("1.1", "Section 1.1", "1.1.html");14            toc.Add("1.2", "Section 1.2", "1.2.html");15            toc.Add("2", "Chapter 2", "2.html");16            toc.Add("2.1", "Section 2.1", "2.1.html");17            toc.Add("2.2", "Section 2.2", "2.2.html");18            toc.Add("2.2.1", "Section 2.2.1", "2.2.1.html");19            toc.Add("2.2.2", "Section 2.2.2", "2.2.2.html");20            toc.Add("

Toc

Using AI Code Generation

1using Microsoft.Coyote.GenDoc;2using System;3using System.Collections.Generic;4using System.Linq;5using System.Text;6using System.Threading.Tasks;7{8    {9        static void Main(string[] args)10        {11            Toc toc = new Toc();12            toc.Title = "Table of Content";13            toc.AddEntry("Introduction", "Introduction");14            toc.AddEntry("Requirements", "Requirements");15            toc.AddEntry("Design", "Design");16            toc.AddEntry("Implementation", "Implementation");17            toc.AddEntry("Testing", "Testing");18            toc.AddEntry("Conclusion", "Conclusion");19            Console.WriteLine(toc.ToString());20            Console.WriteLine("Press any key to exit");21            Console.ReadKey();22        }23    }24}

Toc

Using AI Code Generation

1using Microsoft.Coyote.GenDoc;2using System;3using System.Collections.Generic;4using System.Linq;5using System.Text;6using System.Threading.Tasks;7{8    {9        static void Main(string[] args)10        {11            Toc toc = new Toc();12            toc.Add("1.1", "Title 1.1");13            toc.Add("1.2", "Title 1.2");14            toc.Add("2.1", "Title 2.1");15            toc.Add("2.2", "Title 2.2");16            toc.Add("2.3", "Title 2.3");17            toc.Add("2.4", "Title 2.4");18            toc.Add("2.5", "Title 2.5");19            toc.Add("3.1", "Title 3.1");20            toc.Add("3.2", "Title 3.2");21            toc.Add("3.3", "Title 3.3");22            toc.Add("3.4", "Title 3.4");23            toc.Add("3.5", "Title 3.5");24            toc.Add("3.6", "Title 3.6");25            toc.Add("3.7", "Title 3.7");26            toc.Add("3.8", "Title 3.8");27            toc.Add("3.9", "Title 3.9");28            toc.Add("3.10", "Title 3.10");29            toc.Add("3.11", "Title 3.11");30            toc.Add("3.12", "Title 3.12");31            toc.Add("3.13", "Title 3.13");32            toc.Add("3.14", "Title 3.14");33            toc.Add("3.15", "Title 3.15");34            toc.Add("3.16", "Title 3.16");35            toc.Add("3.17", "Title 3.17");36            toc.Add("3.18", "Title 3.18");37            toc.Add("3.19", "Title 3.19");38            toc.Add("3.20", "Title 3.20");39            toc.Add("3.21", "Title 3.21");40            toc.Add("3.22", "Title 3.22");

Toc

Using AI Code Generation

1using Microsoft.Coyote.GenDoc;2{3    static void Main(string[] args)4    {5        Toc toc = new Toc();6        toc.Add("Introduction", "Introduction.md");7        toc.Add("Getting Started", "GettingStarted.md");8        toc.Add("Coyote Features", "CoyoteFeatures.md");9        toc.Add("Coyote Programming Model", "CoyoteProgrammingModel.md");10        toc.Add("Coyote Runtime", "CoyoteRuntime.md");11        toc.Add("Coyote Testing", "CoyoteTesting.md");12        toc.Add("Coyote Testing with ASP.NET Core", "CoyoteTestingAspNetCore.md");13        toc.Add("Coyote Testing with Azure Functions", "CoyoteTestingAzureFunctions.md");14        toc.Add("Coyote Testing with Azure Service Fabric", "CoyoteTestingAzureServiceFabric.md");15        toc.Add("Coyote Testing with Kubernetes", "CoyoteTestingKubernetes.md");16        toc.Add("Coyote Testing with Orleans", "CoyoteTestingOrleans.md");17        toc.Add("Coyote Testing with Python", "CoyoteTestingPython.md");18        toc.Add("Coyote Testing with RabbitMQ", "CoyoteTestingRabbitMQ.md");19        toc.Add("Coyote Testing with Service Fabric", "CoyoteTestingServiceFabric.md");20        toc.Add("Coyote Testing with SignalR", "CoyoteTestingSignalR.md");21        toc.Add("Coyote Testing with WCF", "CoyoteTestingWCF.md");22        toc.Add("Coyote Testing with WebSockets", "CoyoteTestingWebSockets.md");23        toc.Add("Coyote Testing with Windows Service", "CoyoteTestingWindowsService.md");24        toc.Add("Coyote Testing with Xamarin", "CoyoteTestingXamarin.md");25        toc.Add("Coyote Testing with the .NET Framework", "CoyoteTestingDotNetFramework.md");26        toc.Add("Coyote Testing with the .NET Framework and WCF", "CoyoteTestingDotNetFrameworkWCF.md");27        toc.Add("Coyote Testing with the .NET Framework and Windows Service", "CoyoteTestingDotNetFrameworkWindowsService.md");28        toc.Add("Coyote Testing with the .NET Framework and Xamarin", "CoyoteTestingDotNet

Toc

Using AI Code Generation

1using Microsoft.Coyote.GenDoc;2{3    {4        static void Main(string[] args)5        {6            Toc toc = new Toc();7            toc.Add("1", "Introduction");8            toc.Add("2", "Getting started");9            toc.Add("3", "Coyote features");10            toc.Add("4", "Coyote in action");11            toc.Add("5", "Coyote in the cloud");12            toc.Add("6", "Conclusion");13            toc.Add("7", "Appendix");14            toc.Add("8", "Glossary");15            toc.Add("9", "Index");16            toc.Save("toc.xml");17        }18    }19}20using Microsoft.Coyote.GenDoc;21{22    {23        static void Main(string[] args)24        {25            Toc toc = new Toc();26            toc.Add("1", "Introduction");27            toc.Add("2", "Getting started");28            toc.Add("3", "Coyote features");29            toc.Add("4", "Coyote in action");30            toc.Add("5", "Coyote in the cloud");31            toc.Add("6", "Conclusion");32            toc.Add("7",

Toc

Using AI Code Generation

1using Microsoft.Coyote.GenDoc;2{3    {4        static void Main(string[] args)5        {6            Toc toc = new Toc();7            toc.Add("1", "Title 1", "1.html");8            toc.Add("1.1", "Title 1.1", "1.1.html");9            toc.Add("1.2", "Title 1.2", "1.2.html");10            toc.Add("2", "Title 2", "2.html");11            toc.Add("2.1", "Title 2.1", "2.1.html");12            toc.Add("2.2", "Title 2.2", "2.2.html");13            toc.Add("2.2.1", "Title 2.2.1", "2.2.1.html");14            toc.Add("2.2.2", "Title 2.2.2", "2.2.2.html");15            toc.Add("3", "Title 3", "3.html");16            toc.Add("3.1", "Title 3.1", "3.1.html");17            toc.Add("3.2", "Title 3.2", "3.2.html");18            toc.Add("3.2.1", "Title 3.2.1", "3.2.1.html");19            toc.Add("3.2.2", "Title 3.2.2", "3.2.2.html");20            toc.Add("3.2.3", "Title 3.2.3", "3.2.3.html");21            toc.Add("3.2.4", "Title 3.2.4", "3.2.4.html");22            toc.Add("3.2.5", "Title 3.2.5", "3.2.5.html");23            toc.Add("3.2.6", "Title 3.2.6", "3.2.6.html");24            toc.Add("3.2.7", "Title 3.2.7", "3.2.7.html");25            toc.Add("3.2.8", "Title 3.2.8", "3.2.8.html");26            toc.Add("3.2.9",

Toc

Using AI Code Generation

1using System;2using Microsoft.Coyote.GenDoc;3{4    {5        static void Main(string[] args)6        {7            string fileName = "2.cs";8            string[] toc = Toc.GetToc(fileName);9            foreach (string item in toc)10            {11                Console.WriteLine(item);12            }13        }14    }15}16{17    {18        static void Main(string[] args)19        {20            string fileName = "2.cs";21            string[] toc = Toc.GetToc(fileName);22            foreach (string item in toc)23            {24                Console.WriteLine(item);25            }26        }27    }28}29{30    {31        static void Main(string[] args)32        {33            string fileName = "2.cs";34            string[] toc = Toc.GetToc(fileName);35            foreach (string item in toc)36            {37                Console.WriteLine(item);38            }39        }40    }41}42{43    {44        static void Main(string[] args)45        {46            string fileName = "2.cs";47            string[] toc = Toc.GetToc(fileName);48            foreach (string item in toc)49            {50                Console.WriteLine(item);51            }52        }53    }54}55{56    {57        static void Main(string[] args)58        {59            string fileName = "2.cs";60            string[] toc = Toc.GetToc(fileName);61            foreach (string item in toc)62            {63                Console.WriteLine(item);64            }65        }66    }67}68{69    {70        static void Main(string[] args)71        {72            string fileName = "2.cs";73            string[] toc = Toc.GetToc(fileName);74            foreach (string item in toc)75            {76                Console.WriteLine(item);77            }78        }79    }80}81{82    {83        static void Main(string[] args)84        {85            string fileName = "2.cs";86            string[] toc = Toc.GetToc(fileName);87            foreach (string item in toc)88            {89                Console.WriteLine(item);90            }91        }92    }93}94{95    {96        static void Main(string

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.