Skip to content

Fix running init #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jandev wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix running init #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac82c77
.NET Core 3.1 update
Jandev Jun 19, 2020
ee171b3
Check if directory exists, otherwise create
Jandev Jun 19, 2020
3d296db
Unused usings and new language feature
Jandev Jun 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 26 additions & 24 deletions src/adr.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
VisualStudioVersion = 15.0.26124.0
# Visual Studio Version 16
VisualStudioVersion = 16.0.30204.135
MinimumVisualStudioVersion = 15.0.26124.0
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "adr-cli", "adr\adr-cli.csproj", "{A449BAF4-C963-4A14-970B-8912262D78C0}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "adr-cli", "adr\adr-cli.csproj", "{A449BAF4-C963-4A14-970B-8912262D78C0}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "tests", "adr.tests\tests.csproj", "{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "tests", "adr.tests\tests.csproj", "{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand All @@ -16,33 +15,36 @@ Global
Release|x64 = Release|x64
Release|x86 = Release|x86
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{A449BAF4-C963-4A14-970B-8912262D78C0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{A449BAF4-C963-4A14-970B-8912262D78C0}.Debug|Any CPU.Build.0 = Debug|Any CPU
{A449BAF4-C963-4A14-970B-8912262D78C0}.Debug|x64.ActiveCfg = Debug|x64
{A449BAF4-C963-4A14-970B-8912262D78C0}.Debug|x64.Build.0 = Debug|x64
{A449BAF4-C963-4A14-970B-8912262D78C0}.Debug|x86.ActiveCfg = Debug|x86
{A449BAF4-C963-4A14-970B-8912262D78C0}.Debug|x86.Build.0 = Debug|x86
{A449BAF4-C963-4A14-970B-8912262D78C0}.Debug|x64.ActiveCfg = Debug|Any CPU
{A449BAF4-C963-4A14-970B-8912262D78C0}.Debug|x64.Build.0 = Debug|Any CPU
{A449BAF4-C963-4A14-970B-8912262D78C0}.Debug|x86.ActiveCfg = Debug|Any CPU
{A449BAF4-C963-4A14-970B-8912262D78C0}.Debug|x86.Build.0 = Debug|Any CPU
{A449BAF4-C963-4A14-970B-8912262D78C0}.Release|Any CPU.ActiveCfg = Release|Any CPU
{A449BAF4-C963-4A14-970B-8912262D78C0}.Release|Any CPU.Build.0 = Release|Any CPU
{A449BAF4-C963-4A14-970B-8912262D78C0}.Release|x64.ActiveCfg = Release|x64
{A449BAF4-C963-4A14-970B-8912262D78C0}.Release|x64.Build.0 = Release|x64
{A449BAF4-C963-4A14-970B-8912262D78C0}.Release|x86.ActiveCfg = Release|x86
{A449BAF4-C963-4A14-970B-8912262D78C0}.Release|x86.Build.0 = Release|x86
{A449BAF4-C963-4A14-970B-8912262D78C0}.Release|x64.ActiveCfg = Release|Any CPU
{A449BAF4-C963-4A14-970B-8912262D78C0}.Release|x64.Build.0 = Release|Any CPU
{A449BAF4-C963-4A14-970B-8912262D78C0}.Release|x86.ActiveCfg = Release|Any CPU
{A449BAF4-C963-4A14-970B-8912262D78C0}.Release|x86.Build.0 = Release|Any CPU
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Debug|Any CPU.Build.0 = Debug|Any CPU
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Debug|x64.ActiveCfg = Debug|x64
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Debug|x64.Build.0 = Debug|x64
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Debug|x86.ActiveCfg = Debug|x86
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Debug|x86.Build.0 = Debug|x86
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Debug|x64.ActiveCfg = Debug|Any CPU
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Debug|x64.Build.0 = Debug|Any CPU
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Debug|x86.ActiveCfg = Debug|Any CPU
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Debug|x86.Build.0 = Debug|Any CPU
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Release|Any CPU.ActiveCfg = Release|Any CPU
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Release|Any CPU.Build.0 = Release|Any CPU
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Release|x64.ActiveCfg = Release|x64
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Release|x64.Build.0 = Release|x64
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Release|x86.ActiveCfg = Release|x86
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Release|x86.Build.0 = Release|x86
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Release|x64.ActiveCfg = Release|Any CPU
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Release|x64.Build.0 = Release|Any CPU
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Release|x86.ActiveCfg = Release|Any CPU
{D1BAB1E6-0927-4893-AD8E-0B328BF66E6E}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {13AB0FC3-F939-4E9B-AAC8-6B19AE349F32}
EndGlobalSection
EndGlobal
2 changes: 1 addition & 1 deletion src/adr.tests/tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>netcoreapp1.1</TargetFramework>
<TargetFramework>netcoreapp3.1</TargetFramework>
</PropertyGroup>

<ItemGroup>
Expand Down
61 changes: 43 additions & 18 deletions src/adr/AdrEntry.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

namespace adr
{
public class AdrEntry
internal class AdrEntry
{
private readonly string docFolder;

Expand Down Expand Up @@ -47,59 +47,84 @@ private void WriteNew()
fileName = Path.Combine(
docFolder,
$"{fileNumber.ToString().PadLeft(4, '0')}-{SanitizeFileName(this.Title)}.md");
using (var writer = File.CreateText(fileName))

CreateDocumentsFolderIfNotExists();

WriteAdrFile(fileNumber);
}

private void WriteAdr()
{
var fileNumber = Directory.Exists(this.docFolder)
? GetNextFileNumber(this.docFolder)
: 1;
fileName = Path.Combine(
this.docFolder,
$"{fileNumber.ToString().PadLeft(4, '0')}-{SanitizeFileName(this.Title)}.md");

CreateDocumentsFolderIfNotExists();

WriteInitialAdrFile(fileNumber);
}

private void WriteInitialAdrFile(int fileNumber)
{
using var writer = File.CreateText(this.fileName);
{
writer.WriteLine($"# {fileNumber}. {this.Title}");
writer.WriteLine();
writer.WriteLine(DateTime.Today.ToString("yyyy-MM-dd"));
writer.WriteLine();
writer.WriteLine("## Status");
writer.WriteLine();
writer.WriteLine("Proposed");
writer.WriteLine("Accepted");
writer.WriteLine();
writer.WriteLine("## Context");
writer.WriteLine();
writer.WriteLine("{context}");
writer.WriteLine("We need to record the architectural decisions made on this project.");
writer.WriteLine();
writer.WriteLine("## Decision");
writer.WriteLine();
writer.WriteLine("{decision}");
writer.WriteLine(
"We will use Architecture Decision Records, as described by Michael Nygard in this article: http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions");
writer.WriteLine();
writer.WriteLine("## Consequences");
writer.WriteLine();
writer.WriteLine("{consequences}");
writer.WriteLine("See Michael Nygard's article, linked above.");
}
}

private void WriteAdr()
private void WriteAdrFile(int fileNumber)
{
var fileNumber = Directory.Exists(this.docFolder)
? GetNextFileNumber(this.docFolder)
: 1;
fileName = Path.Combine(
docFolder,
$"{fileNumber.ToString().PadLeft(4, '0')}-{SanitizeFileName(this.Title)}.md");
using (var writer = File.CreateText(fileName))
using var writer = File.CreateText(fileName);
{
writer.WriteLine($"# {fileNumber}. {this.Title}");
writer.WriteLine();
writer.WriteLine(DateTime.Today.ToString("yyyy-MM-dd"));
writer.WriteLine();
writer.WriteLine("## Status");
writer.WriteLine();
writer.WriteLine("Accepted");
writer.WriteLine("Proposed");
writer.WriteLine();
writer.WriteLine("## Context");
writer.WriteLine();
writer.WriteLine("We need to record the architectural decisions made on this project.");
writer.WriteLine("{context}");
writer.WriteLine();
writer.WriteLine("## Decision");
writer.WriteLine();
writer.WriteLine("We will use Architecture Decision Records, as described by Michael Nygard in this article: http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions");
writer.WriteLine("{decision}");
writer.WriteLine();
writer.WriteLine("## Consequences");
writer.WriteLine();
writer.WriteLine("See Michael Nygard's article, linked above.");
writer.WriteLine("{consequences}");
}
}

private void CreateDocumentsFolderIfNotExists()
{
if (!Directory.Exists(this.docFolder))
{
Directory.CreateDirectory(this.docFolder);
}
}

Expand Down
18 changes: 3 additions & 15 deletions src/adr/AdrSettings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
using System;
using System.IO;
using Newtonsoft.Json;
using System.IO;

namespace adr
{
public class AdrSettings
internal class AdrSettings
{
private const string DefaultFileName = "adr.config.json";

Expand All @@ -14,18 +13,7 @@ private AdrSettings()
{
}

public static AdrSettings Current
{
get
{
if (instance == null)
{
instance = Read(new AdrSettings());
}

return instance;
}
}
public static AdrSettings Current => instance ??= Read(new AdrSettings());

public string DocFolder { get; set; }

Expand Down
4 changes: 1 addition & 3 deletions src/adr/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
using System;
using System.Reflection;
using Microsoft.Extensions.CommandLineUtils;
using Microsoft.Extensions.CommandLineUtils;

namespace adr
{
Expand Down
3 changes: 2 additions & 1 deletion src/adr/adr-cli.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>netcoreapp1.1</TargetFramework>
<TargetFramework>netcoreapp3.1</TargetFramework>
<RuntimeIdentifiers>win7-x64;ubuntu.16.04-x64</RuntimeIdentifiers>
<StartupObject>adr.Program</StartupObject>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.Extensions.CommandLineUtils" Version="1.1.1" />
Expand Down