add readonly option

readme.md

@@ -118,6 +118,17 @@ When scanning for snippets the following are ignored:
  * Any of the following directory names: `bin`, `obj`
 
 
+## Mark resulting files as read only
+
+To mark the resulting `.md` files as read only use `-r` or `--readonly`.
+
+This can be helpful in preventing incorrectly editing the `.md` file instead of the `.source.md` file.
+
+```ps
+mdsnippets -r
+```
+
+
 ## More Documentation
 
  * [.net API](/docs/api.md)

readme.source.md

@@ -112,6 +112,17 @@ When scanning for snippets the following are ignored:
  * Any of the following directory names: `bin`, `obj`
 
 
+## Mark resulting files as read only
+
+To mark the resulting `.md` files as read only use `-r` or `--readonly`.
+
+This can be helpful in preventing incorrectly editing the `.md` file instead of the `.source.md` file.
+
+```ps
+mdsnippets -r
+```
+
+
 ## More Documentation
 
  * [.net API](/docs/api.md)

src/Directory.Build.props

@@ -5,7 +5,7 @@
     <LangVersion>latest</LangVersion>
     <NoWarn>CS1591</NoWarn>
     <NoPackageAnalysis>true</NoPackageAnalysis>
-    <Version>10.3.0</Version>
+    <Version>11.0.0</Version>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <Copyright>Copyright $([System.DateTime]::UtcNow.ToString(yyyy)). All rights reserved</Copyright>
     <PackageIconUrl>https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/src/icon.png</PackageIconUrl>

src/MarkdownSnippets.MsBuild/DocoTask.cs

@@ -10,10 +10,15 @@ public class DocoTask :
         [Required]
         public string ProjectDirectory { get; set; }
 
+        public bool ReadOnly { get; set; }
+
         public override bool Execute()
         {
             var root = GitRepoDirectoryFinder.FindForDirectory(ProjectDirectory);
-            var processor = new DirectoryMarkdownProcessor(root, log: s => Log.LogMessage(s));
+            var processor = new DirectoryMarkdownProcessor(
+                root,
+                log: s => Log.LogMessage(s),
+                readOnly: ReadOnly);
             try
             {
                 processor.Run();

src/MarkdownSnippets.MsBuild/MarkdownSnippets.MsBuild.targets

@@ -3,6 +3,7 @@
     <MarkdownSnippetsAssembly>$(MSBuildThisFileDirectory)..\task\MarkdownSnippets.MsBuild.dll</MarkdownSnippetsAssembly>
     <MdTargetDir Condition="'$(SolutionDir)' != '' AND Exists('$(SolutionDir).git')">$(SolutionDir)</MdTargetDir>
     <MdTargetDir Condition="'$(SolutionDir)' != '' AND Exists('$(SolutionDir)..\.git')">$(SolutionDir)..\</MdTargetDir>
+    <MarkdownSnippetsReadOnly Condition="$(MarkdownSnippetsReadOnly) == ''">false</MarkdownSnippetsReadOnly>
   </PropertyGroup>
 
   <ItemGroup>
@@ -21,6 +22,8 @@
      <Error
         Text="No '.git' directory found. Define a `MdTargetDir`."
         Condition="'$(MdTargetDir)' == ''" />
-    <MarkdownSnippets.DocoTask ProjectDirectory="$(MSBuildProjectDirectory)" />
+    <MarkdownSnippets.DocoTask
+      ProjectDirectory="$(MSBuildProjectDirectory)"
+      ReadOnly="$(MarkdownSnippetsReadOnly)" />
   </Target>
 </Project>

src/MarkdownSnippets.Tool/CommandRunner.cs

@@ -14,7 +14,7 @@ public static void RunCommand(Invoke invoke, params string[] args)
             var firstArg = args[0];
             if (!firstArg.StartsWith('-'))
             {
-                invoke(firstArg, new List<string>());
+                invoke(firstArg, false, new List<string>());
                 return;
             }
         }
@@ -24,7 +24,7 @@ public static void RunCommand(Invoke invoke, params string[] args)
                 options =>
                 {
                     ApplyDefaults(options);
-                    invoke(options.TargetDirectory, options.Exclude.ToList());
+                    invoke(options.TargetDirectory, options.ReadOnly, options.Exclude.ToList());
                 });
     }
 

src/MarkdownSnippets.Tool/Invoke.cs

@@ -1,3 +1,3 @@
 using System.Collections.Generic;
 
-public delegate void Invoke(string targetDirectory, List<string> exclude);
+public delegate void Invoke(string targetDirectory, bool readOnly, List<string> exclude);

src/MarkdownSnippets.Tool/Options.cs

@@ -6,9 +6,12 @@ public class Options
     [Option('t', "target-directory", Required = false)]
     public string TargetDirectory { get; set; }
 
-    [Option('e', "exclude", 
+    [Option('e', "exclude",
         Separator = ':',
         Required = false,
         HelpText = "Directories to be excluded")]
     public IList<string> Exclude { get; set; }
+
+    [Option('r', "readonly", Required = false, HelpText = "Set output to verbose messages.")]
+    public bool ReadOnly { get; set; }
 }

src/MarkdownSnippets.Tool/Program.cs

@@ -11,7 +11,7 @@ static void Main(string[] args)
         CommandRunner.RunCommand(Inner, args);
     }
 
-    static void Inner(string targetDirectory, List<string> excludes)
+    static void Inner(string targetDirectory, bool readOnly, List<string> excludes)
     {
         Console.WriteLine($"TargetDirectory: {targetDirectory}");
         if (!Directory.Exists(targetDirectory))
@@ -31,9 +31,10 @@ static void Inner(string targetDirectory, List<string> excludes)
         try
         {
             var processor = new DirectoryMarkdownProcessor(
-                targetDirectory, 
+                targetDirectory,
                 log: Console.WriteLine,
-                directoryFilter: path => !excludes.Any(path.Contains));
+                directoryFilter: path => !excludes.Any(path.Contains),
+                readOnly: readOnly);
             processor.Run();
         }
         catch (SnippetReadingException exception)

src/MarkdownSnippets/FileEx.cs

@@ -18,4 +18,20 @@ public static string GetRelativePath(string file, string directory)
         var directoryUri = new Uri(directory);
         return Uri.UnescapeDataString(directoryUri.MakeRelativeUri(fileUri).ToString().Replace('/', Path.DirectorySeparatorChar));
     }
+
+    public static void ClearReadOnly(string path)
+    {
+        var fileInfo = new FileInfo(path)
+        {
+            IsReadOnly = false
+        };
+    }
+
+    public static void MakeReadOnly(string path)
+    {
+        var fileInfo = new FileInfo(path)
+        {
+            IsReadOnly = true
+        };
+    }
 }

src/MarkdownSnippets/Processing/DirectoryMarkdownProcessor.cs

@@ -11,6 +11,7 @@ public class DirectoryMarkdownProcessor
     {
         bool writeHeader;
         DirectoryFilter directoryFilter;
+        bool readOnly;
         Action<string> log;
         string targetDirectory;
         List<string> sourceMdFiles = new List<string>();
@@ -25,10 +26,12 @@ public class DirectoryMarkdownProcessor
             Action<string> log = null,
             AppendSnippetGroupToMarkdown appendSnippetGroup = null,
             bool writeHeader = true,
-            DirectoryFilter directoryFilter = null)
+            DirectoryFilter directoryFilter = null,
+            bool readOnly = true)
         {
             this.writeHeader = writeHeader;
             this.directoryFilter = directoryFilter;
+            this.readOnly = readOnly;
             if (appendSnippetGroup == null)
             {
                 this.appendSnippetGroup = new SnippetMarkdownHandling(targetDirectory).AppendGroup;
@@ -135,6 +138,7 @@ void ProcessFile(string sourceFile, MarkdownProcessor markdownProcessor)
         {
             log($"Processing {sourceFile}");
             var target = GetTargetFile(sourceFile, targetDirectory);
+            FileEx.ClearReadOnly(target);
             using (var reader = File.OpenText(sourceFile))
             using (var writer = File.CreateText(target))
             {
@@ -150,6 +154,11 @@ void ProcessFile(string sourceFile, MarkdownProcessor markdownProcessor)
                     throw new MissingSnippetsException(missing);
                 }
             }
+
+            if (readOnly)
+            {
+                FileEx.MakeReadOnly(target);
+            }
         }
 
         static string GetTargetFile(string sourceFile, string rootDirectory)

src/Tests/Console/CommandRunnerTests.cs

@@ -10,13 +10,15 @@ public class CommandRunnerTests :
 {
     string targetDirectory;
     List<string> exclude;
+    bool readOnly;
 
     [Fact]
     public void Empty()
     {
         CommandRunner.RunCommand(Capture);
         Assert.Equal(Environment.CurrentDirectory, targetDirectory);
         Assert.Empty(exclude);
+        Assert.False(readOnly);
     }
 
     [Fact]
@@ -25,34 +27,57 @@ public void SingleUnNamedArg()
         CommandRunner.RunCommand(Capture, "dir");
         Assert.Equal("dir", targetDirectory);
         Assert.Empty(exclude);
+        Assert.False(readOnly);
+    }
+
+    [Fact]
+    public void ReadOnlyShort()
+    {
+        CommandRunner.RunCommand(Capture, "-r");
+        Assert.Equal(Environment.CurrentDirectory, targetDirectory);
+        Assert.Empty(exclude);
+        Assert.True(readOnly);
+    }
+
+    [Fact]
+    public void ReadOnlyLong()
+    {
+        CommandRunner.RunCommand(Capture, "--readonly");
+        Assert.Equal(Environment.CurrentDirectory, targetDirectory);
+        Assert.Empty(exclude);
+        Assert.True(readOnly);
     }
 
     [Fact]
     public void TargetDirectoryShort()
     {
         CommandRunner.RunCommand(Capture, "-t", "dir");
         Assert.Equal(Path.GetFullPath("dir"), targetDirectory);
+        Assert.False(readOnly);
     }
 
     [Fact]
     public void TargetDirectoryLong()
     {
         CommandRunner.RunCommand(Capture, "--target-directory", "dir");
         Assert.Equal(Path.GetFullPath("dir"), targetDirectory);
+        Assert.False(readOnly);
     }
 
     [Fact]
     public void ExcludeShort()
     {
         CommandRunner.RunCommand(Capture, "-e", "dir");
         Assert.Equal("dir", exclude.Single());
+        Assert.False(readOnly);
     }
 
     [Fact]
     public void ExcludeMultiple()
     {
         CommandRunner.RunCommand(Capture, "-e", "dir1:dir2");
         Assert.Equal(new List<string> {"dir1", "dir2"}, exclude);
+        Assert.False(readOnly);
     }
 
     [Fact]
@@ -72,12 +97,14 @@ public void ExcludeLong()
     {
         CommandRunner.RunCommand(Capture, "--exclude", "dir");
         Assert.Equal("dir", exclude.Single());
+        Assert.False(readOnly);
     }
 
-    void Capture(string targetDirectory, List<string> exclude)
+    void Capture(string targetDirectory, bool readOnly, List<string> exclude)
     {
         this.targetDirectory = targetDirectory;
         this.exclude = exclude;
+        this.readOnly = readOnly;
     }
 
     public CommandRunnerTests(ITestOutputHelper output) :

src/Tests/DirectoryMarkdownProcessor/DirectoryMarkdownProcessorTests.cs

@@ -21,6 +21,20 @@ public void Run()
         processor.Run();
     }
 
+    [Fact]
+    public void ReadOnly()
+    {
+        var root = Path.GetFullPath("DirectoryMarkdownProcessor/Readonly");
+        var processor = new DirectoryMarkdownProcessor(root, scanForSnippets: false, writeHeader: false);
+        processor.IncludeSnippets(
+            SnippetBuild("snippet1"),
+            SnippetBuild("snippet2")
+        );
+        processor.Run();
+
+        Assert.True(new FileInfo(Path.Combine(root, "one.md")).IsReadOnly);
+    }
+
     [Fact]
     public void Convention()
     {

src/Tests/DirectoryMarkdownProcessor/ReadOnly/one.md

@@ -0,0 +1,7 @@
+<!--
+This file was generate by MarkdownSnippets.
+Source File: /src/Tests/GitHubMarkdownProcessor/Convention/one.source.md
+To change this file edit the source file and then re-run the generation using either the dotnet global tool (https://github.com/SimonCropp/MarkdownSnippets#markdownsnippetstool) or using the api (https://github.com/SimonCropp/MarkdownSnippets#running-as-a-unit-test).
+-->
+<!-- snippet: snippet1 -->
+** Could not find snippet 'snippet1' **

src/Tests/DirectoryMarkdownProcessor/ReadOnly/one.source.md

@@ -0,0 +1 @@
+snippet: snippet1