Enable metadata generation options.

Author: MIchaelMainer

src/Typewriter/DocAnnotationWriter.cs

@@ -20,7 +20,7 @@ internal class DocAnnotationWriter : ApiDoctor.Publishing.CSDL.CsdlWriter
 
         private readonly CsdlWriterOptions options;
 
-        internal DocAnnotationWriter(DocSet docSet, CsdlWriterOptions options, string csdl) : base(docSet, options)
+        internal DocAnnotationWriter(DocSet docSet, CsdlWriterOptions options) : base(docSet, options)
         {
             this.options = options; // Can change the base access modifier so we could use it. 
         }
@@ -77,21 +77,31 @@ internal static class AnnotationHelper
     {
         private static Logger Logger => LogManager.GetLogger("AnnotationHelper");
 
-        internal async static Task<string> ApplyAnnotationsToCsdl(string csdl, Options options)
+        /// <summary>
+        /// Applies annotations to CSDL file.
+        /// </summary>
+        /// <param name="options">The typewriter input options.</param>
+        /// <param name="pathToCleanMetadata">Optional. Contains the path to a clean metadata to use when applying annotations. Overrides Option.Metadata.</param>
+        /// <returns>An annotated metadata file.</returns>
+        internal async static Task<string> ApplyAnnotationsToCsdl(Options options, string pathToCleanMetadata = null)
         {
-            // Get DocSet
             DocSet docs = GetDocSet(options, new IssueLogger());
 
             var csdlWriterOptions = new CsdlWriterOptions()
             {
                 DocumentationSetPath = options.DocsRoot + "\\api-reference\\v1.0\\",
                 Annotations = AnnotationOptions.Properties,
-                SourceMetadataPath = options.Metadata,
                 SkipMetadataGeneration = true,
                 Formats = MetadataFormat.EdmxInput
             };
 
-            DocAnnotationWriter docWriter = new DocAnnotationWriter(docs, csdlWriterOptions, csdl);
+            // We only intend to ues the source metadata when we don't pass in a CSDL.
+            if (string.IsNullOrEmpty(pathToCleanMetadata))
+                csdlWriterOptions.SourceMetadataPath = options.Metadata;
+            else
+                csdlWriterOptions.SourceMetadataPath = pathToCleanMetadata;
+
+            DocAnnotationWriter docWriter = new DocAnnotationWriter(docs, csdlWriterOptions);
 
             return await docWriter.PublishToStringAsync(new IssueLogger()); 
         }

src/Typewriter/FileWriter.cs

@@ -17,6 +17,26 @@ internal static class FileWriter
         private static ConcurrentDictionary<string, Lazy<AsyncLock>> lockDictionary = new ConcurrentDictionary<string, Lazy<AsyncLock>>();
         internal static Logger Logger => LogManager.GetLogger("FileWriter");
 
+        /// <summary>
+        /// Writes a metadata file to disk.
+        /// </summary>
+        /// <param name="metadata">The metadata to write.</param>
+        /// <param name="outputDirectoryPath">Metadata write location.</param>
+        public static string WriteMetadata(string metadata, string fileName, string outputDirectoryPath = null)
+        {
+            if (!string.IsNullOrWhiteSpace(outputDirectoryPath) && !Directory.Exists(outputDirectoryPath))
+                Directory.CreateDirectory(outputDirectoryPath);
+            if (string.IsNullOrWhiteSpace(outputDirectoryPath))
+                outputDirectoryPath = Environment.CurrentDirectory;
+
+            var fullFileName = string.Concat(outputDirectoryPath, "\\", fileName);
+
+            File.WriteAllText(fullFileName, metadata);
+            Logger.Info($"Metadata written to {fullFileName}");
+
+            return fullFileName;
+        }
+
         /// <summary>
         /// Write all generated files to disk
         /// </summary>

src/Typewriter/Program.cs

@@ -34,8 +34,8 @@ private static void GenerateSDK(Options options)
             // Generate the files from the input metadata and do not preprocess.
             if (options.GenerateMode == GenerationMode.Files)
             {
-                var files = MetadataToClientSource(csdlContents, options.Language);
-                FileWriter.WriteAsync(files, options.Output);
+                var codeFiles = MetadataToClientSource(csdlContents, options.Language);
+                FileWriter.WriteAsync(codeFiles, options.Output);
 
                 stopwatch.Stop();
                 Logger.Info($"Generation time: {stopwatch.Elapsed } seconds.");
@@ -46,13 +46,16 @@ private static void GenerateSDK(Options options)
             // Clean up EDMX to work with the generators assumptions.
             string processedCsdlContents = MetadataPreprocessor.CleanMetadata(csdlContents);
 
-            // Inject documentation annotations into the CSDL using ApiDoctor.
-            string csdlWithDocAnnotations = AnnotationHelper.ApplyAnnotationsToCsdl(processedCsdlContents, options).Result;
+            // Create clean metadata and provide a path to it.
+            string pathToCleanMetadata = FileWriter.WriteMetadata(processedCsdlContents, "cleanMetadata.xml");
+
+            // Inject documentation annotations into the clean CSDL using ApiDoctor and get back the file as a string.
+            string csdlWithDocAnnotations = AnnotationHelper.ApplyAnnotationsToCsdl(options, pathToCleanMetadata).Result;
 
             // Output the clean and annotated metadata. 
             if (options.GenerateMode == GenerationMode.Metadata)
             {
-                // TODO: Write the metadata to the output directory using csdlWithDocAnnotations.
+                FileWriter.WriteMetadata(csdlWithDocAnnotations, "cleanMetadataWithDescriptions_v10.xml", options.Output);
 
                 stopwatch.Stop();
                 Logger.Info($"Generation time: {stopwatch.Elapsed } seconds.");
@@ -65,7 +68,7 @@ private static void GenerateSDK(Options options)
             var files = MetadataToClientSource(csdlWithDocAnnotations, options.Language);
             FileWriter.WriteAsync(files, options.Output);
 
-            stopwatch.Stop();
+            stopwatch.Stop();   
             Logger.Info($"Generation time: {stopwatch.Elapsed } seconds.");
         }