Skip to content
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.

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

Registry module #1909

Merged
merged 7 commits into from
May 9, 2018
Merged

Registry module #1909

merged 7 commits into from
May 9, 2018

Conversation

vanceism7
Copy link
Contributor

Ported Fakelib RegistryHelper to Fake5 Fake.Windows.Registry

Copy link
Member

@matthid matthid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very good, only some very minor things!

@@ -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"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you need help with this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry you already added it.

@@ -0,0 +1,112 @@
/// Contains functions which allow to read and write information from/to the registry.
module Fake.Windows.Registry
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we remove this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, just autogenerated msvc stuff, didn't realize that was added in

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh actually, it looks like we need that. That's in the current master of fake.sln as well

@vanceism7
Copy link
Contributor Author

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

@vanceism7 vanceism7 May 6, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@@ -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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 )

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea you're right, just realized I did that wrong haha

@matthid matthid changed the base branch from master to rc_12 May 6, 2018 14:58
@matthid
Copy link
Member

matthid commented May 6, 2018

So this is now ready?

@vanceism7
Copy link
Contributor Author

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"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@matthid
Copy link
Member

matthid commented May 9, 2018

Thanks for taking care of this.

@matthid matthid merged commit d7b430b into fsprojects:rc_12 May 9, 2018
@vanceism7 vanceism7 deleted the RegistryModule branch May 11, 2018 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants