-
Notifications
You must be signed in to change notification settings - Fork 594
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto-generate devices listing (#337)
* Auto-generate devices listing * change namespace, do not throw NRE when outside of repo * handle root directory correctly
- Loading branch information
Showing
12 changed files
with
193 additions
and
43 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # BMx280 Sensors | ||
| # BMx280 - Digital Pressure Sensors BMP280/BME280 | ||
|
|
||
| ## Summary | ||
|
|
||
|
|
||
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
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 |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # DHTxx Sensors | ||
| # DHTxx - Digital-Output Relative Humidity & Temperature Sensor Module | ||
|
|
||
| ## Summary | ||
|
|
||
|
|
||
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
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 |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Pca9685 | ||
| # Pca9685 - I2C PWM Driver | ||
|
|
||
| ## Summary | ||
|
|
||
|
|
||
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 |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Device listing generator | ||
|
|
||
| Run `dotnet run` on this project to auto-generate description in `src/devices/README.md`. | ||
|
|
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 |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // 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; | ||
| using System.IO; | ||
| using System.Text; | ||
| using System.Threading; | ||
|
|
||
| namespace Iot.Tools.DeviceListing | ||
| { | ||
| class Program | ||
| { | ||
| static void Main(string[] args) | ||
| { | ||
| string repoRoot = FindRepoRoot(Environment.CurrentDirectory); | ||
|
|
||
| if (repoRoot == null) | ||
| { | ||
| Console.WriteLine("Error: not in a git repository"); | ||
| return; | ||
| } | ||
|
|
||
| string devices = Path.Combine(repoRoot, "src", "devices"); | ||
|
|
||
| var deviceListing = new StringBuilder(); | ||
|
|
||
| foreach (string directory in Directory.EnumerateDirectories(devices)) | ||
| { | ||
| if (IsIgnoredDevice(directory)) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| string readme = Path.Combine(directory, "README.md"); | ||
| if (File.Exists(readme)) | ||
| { | ||
| string title = GetTitle(readme); | ||
| if (title == null) | ||
| { | ||
| Console.WriteLine($"Directory `{directory}` contains readme file without title on the first line."); | ||
| continue; | ||
| } | ||
|
|
||
| deviceListing.AppendLine($"* [{title}]({GetRelativePathSimple(readme, devices)})"); | ||
| } | ||
| else | ||
| { | ||
| Console.WriteLine($"Directory `{directory}` does not have a README.md file."); | ||
| } | ||
| } | ||
|
|
||
| ReplacePlaceholder(Path.Combine(devices, "README.md"), "devices", deviceListing.ToString()); | ||
| } | ||
|
|
||
| private static string FindRepoRoot(string dir) | ||
| { | ||
| if (!string.IsNullOrEmpty(dir)) | ||
| { | ||
| if (Directory.Exists(Path.Combine(dir, ".git"))) | ||
| { | ||
| return dir; | ||
| } | ||
| else | ||
| { | ||
| DirectoryInfo parentDir = new DirectoryInfo(dir).Parent; | ||
| return parentDir == null ? null : FindRepoRoot(parentDir.FullName); | ||
| } | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| private static string GetTitle(string readmePath) | ||
| { | ||
| string[] lines = File.ReadAllLines(readmePath); | ||
| if (lines[0].StartsWith("# ")) | ||
| { | ||
| return lines[0].Substring(2); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| // simple means it won't try to use ".." | ||
| private static string GetRelativePathSimple(string path, string parentPath) | ||
| { | ||
| if (path.StartsWith(parentPath)) | ||
| { | ||
| int i = parentPath.Length; | ||
| if (path[i] == '/' || path[i] == '\\') | ||
| { | ||
| i++; | ||
| } | ||
|
|
||
| return path.Substring(i); | ||
| } | ||
| else | ||
| { | ||
| throw new Exception($"No common path between `{path}` and `{parentPath}`"); | ||
| } | ||
| } | ||
|
|
||
| private static bool IsIgnoredDevice(string path) | ||
| { | ||
| string dirName = new DirectoryInfo(path).Name; | ||
| return dirName == "Common" || dirName == "Units"; | ||
| } | ||
|
|
||
| private static void ReplacePlaceholder(string filePath, string placeholderName, string newContent) | ||
| { | ||
| string fileContent = File.ReadAllText(filePath); | ||
|
|
||
| string startTag = $"<{placeholderName}>"; | ||
| string endTag = $"</{placeholderName}>"; | ||
|
|
||
| int startIdx = fileContent.IndexOf(startTag); | ||
| int endIdx = fileContent.IndexOf(endTag); | ||
|
|
||
| if (startIdx == -1 || endIdx == -1) | ||
| { | ||
| throw new Exception($"`{startTag}` not found in `{filePath}`"); | ||
| } | ||
|
|
||
| startIdx += startTag.Length; | ||
|
|
||
| File.WriteAllText( | ||
| filePath, | ||
| fileContent.Substring(0, startIdx) + | ||
| Environment.NewLine + | ||
| newContent + | ||
| fileContent.Substring(endIdx)); | ||
| } | ||
| } | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <OutputType>Exe</OutputType> | ||
| <TargetFramework>netcoreapp2.1</TargetFramework> | ||
| </PropertyGroup> | ||
|
|
||
| </Project> |