Registry module #1909
Registry module #1909
Conversation
| @@ -291,6 +291,7 @@ let dotnetAssemblyInfos = | |||
| "Fake.Testing.Common", "Common testing data types" | |||
| "Fake.Tracing.NAntXml", "NAntXml" | |||
| "Fake.Windows.Chocolatey", "Running and packaging with Chocolatey" | |||
| "Fake.Windows.Registry", "CRUD functionality for Windows registry" | |||
There was a problem hiding this comment.
Can we add it to help/templates/template.cshtml, ie to add it to the menu in the Windows modules submenu?
Just reference the API-Reference there (no need to add a new markdown documentation)
| @@ -0,0 +1,112 @@ | |||
| /// Contains functions which allow to read and write information from/to the registry. | |||
| module Fake.Windows.Registry | |||
There was a problem hiding this comment.
Can we add a sample to the reference documentation.
Similar to
https://github.com/fsharp/FAKE/blob/83f79896d303c081039fd887885ca5c74c95526b/src/app/Fake.Core.ReleaseNotes/ReleaseNotes.fs#L1-L39
We would also like to add RequireQualifiedAccess here.
Fake.sln
Outdated
| @@ -1,4 +1,5 @@ | |||
| Microsoft Visual Studio Solution File, Format Version 12.00 | |||
| | |||
| Microsoft Visual Studio Solution File, Format Version 12.00 | |||
There was a problem hiding this comment.
Yep, just autogenerated msvc stuff, didn't realize that was added in
There was a problem hiding this comment.
Oh actually, it looks like we need that. That's in the current master of fake.sln as well
|
I'll try to get those changes in before the weekend is over |
| /// | ||
| /// #### Create a subkey | ||
| /// let subkey = "Company/MyApp" | ||
| /// Registry.createRegistrySubKey Registry.HKEYCurrentUser subkey |
There was a problem hiding this comment.
If you indent it like
It will show as regular code.
There was a problem hiding this comment.
That's actually not working for me in vscode. The examples are still coming out in normal text, ReleaseNotes docs look the same way despite the indention as well. It comes out as code if I use the md ``` marks. Ill just tab it out and recommit though
help/templates/template.cshtml
Outdated
| @@ -186,6 +186,9 @@ | |||
| <ul> | |||
| <li><a href="/windows-chocolatey.html">Chocolatey</a></li> | |||
| </ul> | |||
| <ul> | |||
| <li><a href="/fake-windows-registry.html">Registry</a></li> | |||
There was a problem hiding this comment.
Note: I think you want /apidocs/v5/fake-windows-registry.html here as we don't have a specific markdown for fake-windows-registry.md. Feel free to generate the documentation locally (fake build target GenerateDocs and running it fake build target HostDocs )
There was a problem hiding this comment.
Yea you're right, just realized I did that wrong haha
|
So this is now ready? |
|
Yea I think this is good to go now |
| /// Registry.createRegistrySubKey Registry.HKEYCurrentUser subkey | ||
| /// | ||
| /// #### Write a key-value pair to a subkey | ||
| /// Registry.setRegistryValue Registry.HKEYCurrentUser subkey "AppType" "Premium" |
There was a problem hiding this comment.
Now I get it, I think an empty line is required above in order for it to be recognized as code. But I can fix that
|
Thanks for taking care of this. |
Ported Fakelib RegistryHelper to Fake5 Fake.Windows.Registry