This repository has been archived by the owner on Nov 20, 2023. It is now read-only.
Support json as config as well as yaml #355
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ | |
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System.Linq; | ||
| using YamlDotNet.Serialization; | ||
| using YamlDotNet.Serialization.NamingConventions; | ||
|
|
||
|
|
@@ -17,5 +18,23 @@ public static ISerializer CreateSerializer() | |
| .WithEmissionPhaseObjectGraphVisitor(args => new OmitDefaultAndEmptyArrayObjectGraphVisitor(args.InnerVisitor)) | ||
| .Build(); | ||
| } | ||
|
|
||
| public static string ConvertToJson(string yamlContent) | ||
| { | ||
| var schema = "\"$schema\" : \"https://raw.githubusercontent.com/dotnet/tye/master/src/schema/tye-schema.json\","; | ||
| var deserializer = new DeserializerBuilder().Build(); | ||
| var yamlObject = deserializer.Deserialize<string>(yamlContent); | ||
|
|
||
| var serializer = new SerializerBuilder() | ||
| .JsonCompatible() | ||
| .Build(); | ||
|
|
||
| var json = serializer.Serialize(yamlObject); | ||
|
|
||
| if (string.IsNullOrEmpty(json)) | ||
| json = json.Insert(json.IndexOf("{") + 1, schema); | ||
|
|
||
| return json; | ||
|
There was a problem hiding this comment. It would be really nice if this could also inject |
||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,21 +6,30 @@ namespace Microsoft.Tye | |
| { | ||
| public static class InitHost | ||
| { | ||
| public static string CreateTyeFile(FileInfo? path, bool force, bool json = false) | ||
| { | ||
| var (content, outputFilePath) = CreateTyeFileContent(path, force, json); | ||
|
|
||
| if (json) | ||
| { | ||
| var jsonContent = YamlSerializer.ConvertToJson(content); | ||
| File.WriteAllText(outputFilePath, jsonContent); | ||
| } | ||
| else | ||
| { | ||
| File.WriteAllText(outputFilePath, content); | ||
| } | ||
|
|
||
| return outputFilePath; | ||
| } | ||
|
|
||
| public static (string, string) CreateTyeFileContent(FileInfo? path, bool force, bool json = false) | ||
| { | ||
| if (path is FileInfo && path.Exists && !force) | ||
| { | ||
| ThrowIfTyeFilePresent(path, "tye.yml"); | ||
| ThrowIfTyeFilePresent(path, "tye.yaml"); | ||
| ThrowIfTyeFilePresent(path, "tye.json"); | ||
| } | ||
|
|
||
| var template = @" | ||
|
|
@@ -50,7 +59,7 @@ public static (string, string) CreateTyeFileContent(FileInfo? path, bool force) | |
|
|
||
| // Output in the current directory unless an input file was provided, then | ||
| // output next to the input file. | ||
| var outputFilePath = json ? "tye.json" : "tye.yaml"; | ||
|
|
||
| if (path is FileInfo && path.Exists) | ||
| { | ||
|
|
@@ -77,7 +86,7 @@ public static (string, string) CreateTyeFileContent(FileInfo? path, bool force) | |
| } | ||
|
|
||
| // If the input file is a sln/project then place the config next to it | ||
| outputFilePath = Path.Combine(directory.FullName, outputFilePath); | ||
|
There was a problem hiding this comment. What does this do with our comments? https://github.com/dotnet/tye/pull/355/files#diff-03e018baedc83b3a7dd33c431001ccfdR48 when you do JSON? There was a problem hiding this comment. Comments are not supported in JSON. Also consider the following note from http://www.yaml.org/spec/1.2/spec.html section 3.2.3.3. Comments
|
||
| } | ||
| else | ||
| { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this step even needed? (would YamlParser just parse the JSON document since JSON is YAML).
I'm thinking about things like line-numbers matching up if we do a conversion step. We just did a bunch of work in the yaml parser/validator to get better error messages with line numbers.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good question, would have to test. First though is no. Yaml is format (space) specific where JSON can be one line no spaces and still be valid.