Generate source for .resx files on build. (dotnet#3607)

brettfo · web-flow · commit dc058f2fa20d · 2017-09-21T20:42:07.000-07:00
* add build task to generate *.fs from *.resx files

* generate source for embedded resources in tests

* generate source for embedded resources in FSharp.Editor

* generate source for embedded resources in FSharp.LanguageService

* generate source for embedded resources in FSharp.ProjectSystem.FSharp

* generate source for embedded resources in FSharp.VS.FSI

* don't generate non-string resources when &lt;=netstandard1.6

* update baseline error message for tests

The error output should be the exception message, not the exception type.

* perform up-to-date check before generating *.fs from *.resx

* remove non-idiomatic fold for an array comprehension

* correct newline replacement

* output more friendly error message

* throw if boolean value isn't explicitly `true` or `false`

* only generate object resource code on non `netstandard1.*` and `netcoreapp1.*` platforms

* ensure FSharp.Core specifies a target framework for resource generaton

* rename attributes to be non-ambiguous and properly include them
diff --git a/Classification/ClassificationDefinitions.fs b/Classification/ClassificationDefinitions.fs
@@ -140,7 +140,7 @@ module internal ClassificationDefinitions =
     type internal FSharpFunctionTypeFormat() as self =
         inherit ClassificationFormatDefinition()
 
-        do self.DisplayName <- SR.FSharpFunctionsOrMethodsClassificationType.Value
+        do self.DisplayName <- SR.FSharpFunctionsOrMethodsClassificationType()
 
     [<Export(typeof<EditorFormatDefinition>)>]
     [<ClassificationType(ClassificationTypeNames = FSharpClassificationTypes.MutableVar)>]
@@ -150,7 +150,7 @@ module internal ClassificationDefinitions =
     type internal FSharpMutableVarTypeFormat [<ImportingConstructor>](theme: ThemeColors) as self =
         inherit ClassificationFormatDefinition()
 
-        do self.DisplayName <- SR.FSharpMutableVarsClassificationType.Value
+        do self.DisplayName <- SR.FSharpMutableVarsClassificationType()
            self.ForegroundColor <- theme.GetColor FSharpClassificationTypes.MutableVar
 
     [<Export(typeof<EditorFormatDefinition>)>]
@@ -161,7 +161,7 @@ module internal ClassificationDefinitions =
     type internal FSharpPrintfTypeFormat [<ImportingConstructor>](theme: ThemeColors) as self =
         inherit ClassificationFormatDefinition()
 
-        do self.DisplayName <- SR.FSharpPrintfFormatClassificationType.Value
+        do self.DisplayName <- SR.FSharpPrintfFormatClassificationType()
            self.ForegroundColor <- theme.GetColor FSharpClassificationTypes.Printf
 
     [<Export(typeof<EditorFormatDefinition>)>]
@@ -172,7 +172,7 @@ module internal ClassificationDefinitions =
     type internal FSharpPropertyFormat() as self =
         inherit ClassificationFormatDefinition()
 
-        do self.DisplayName <- SR.FSharpPropertiesClassificationType.Value
+        do self.DisplayName <- SR.FSharpPropertiesClassificationType()
 
     [<Export(typeof<EditorFormatDefinition>)>]
     [<ClassificationType(ClassificationTypeNames = FSharpClassificationTypes.Disposable)>]
@@ -182,5 +182,5 @@ module internal ClassificationDefinitions =
     type internal FSharpDisposableFormat [<ImportingConstructor>](theme: ThemeColors) as self =
         inherit ClassificationFormatDefinition()
 
-        do self.DisplayName <- SR.FSharpDisposablesClassificationType.Value
+        do self.DisplayName <- SR.FSharpDisposablesClassificationType()
            self.ForegroundColor <- theme.GetColor FSharpClassificationTypes.Disposable
diff --git a/CodeFix/AddNewKeywordToDisposableConstructorInvocation.fs b/CodeFix/AddNewKeywordToDisposableConstructorInvocation.fs
@@ -19,7 +19,7 @@ type internal FSharpAddNewKeywordCodeFixProvider() =
 
     override this.RegisterCodeFixesAsync context : Task =
         async {
-            let title = SR.AddNewKeyword.Value
+            let title = SR.AddNewKeyword()
             context.RegisterCodeFix(
                 CodeAction.Create(
                     title,
diff --git a/CodeFix/ImplementInterfaceCodeFixProvider.fs b/CodeFix/ImplementInterfaceCodeFixProvider.fs
@@ -130,8 +130,8 @@ type internal FSharpImplementInterfaceCodeFixProvider
                             title)                
                     context.RegisterCodeFix(codeAction, diagnostics)
 
-                registerCodeFix SR.ImplementInterface.Value true
-                registerCodeFix SR.ImplementInterfaceWithoutTypeAnnotation.Value false
+                registerCodeFix (SR.ImplementInterface()) true
+                registerCodeFix (SR.ImplementInterfaceWithoutTypeAnnotation()) false
             else 
                 ()
             
diff --git a/CodeFix/MissingReferenceCodeFixProvider.fs b/CodeFix/MissingReferenceCodeFixProvider.fs
@@ -71,7 +71,7 @@ type internal MissingReferenceCodeFixProvider() =
                     | Some refProject ->
                         let codefix = 
                             createCodeFix(
-                                String.Format(SR.AddProjectReference.Value, refProject.Name),
+                                String.Format(SR.AddProjectReference(), refProject.Name),
                                 context,
                                 AddProjectRef (ProjectReference refProject.Id)
                                 )
@@ -90,7 +90,7 @@ type internal MissingReferenceCodeFixProvider() =
                         | Some metadataRef ->
                             let codefix = 
                                 createCodeFix(
-                                    String.Format(SR.AddAssemblyReference.Value, assemblyName),
+                                    String.Format(SR.AddAssemblyReference(), assemblyName),
                                     context,
                                     AddMetadataRef metadataRef
                                     )
diff --git a/CodeFix/RemoveUnusedOpens.fs b/CodeFix/RemoveUnusedOpens.fs
@@ -52,7 +52,7 @@ type internal FSharpRemoveUnusedOpensCodeFixProvider
     override __.RegisterCodeFixesAsync context : Task =
         async {
             let diagnostics = context.Diagnostics |> Seq.filter (fun x -> fixableDiagnosticIds |> List.contains x.Id) |> Seq.toImmutableArray
-            context.RegisterCodeFix(createCodeFix(SR.RemoveUnusedOpens.Value, context), diagnostics)
+            context.RegisterCodeFix(createCodeFix(SR.RemoveUnusedOpens(), context), diagnostics)
         } |> RoslynHelpers.StartAsyncUnitAsTask(context.CancellationToken)
 
     override __.GetFixAllProvider() = WellKnownFixAllProviders.BatchFixer
diff --git a/CodeFix/RenameUnusedValue.fs b/CodeFix/RenameUnusedValue.fs
@@ -65,12 +65,12 @@ type internal FSharpRenameUnusedValueCodeFixProvider
 
                 match symbolUse.Symbol with
                 | :? FSharpMemberOrFunctionOrValue as func ->
-                    createCodeFix(context, symbolName, SR.PrefixValueNameWithUnderscore.Value, TextChange(TextSpan(context.Span.Start, 0), "_"))
+                    createCodeFix(context, symbolName, SR.PrefixValueNameWithUnderscore(), TextChange(TextSpan(context.Span.Start, 0), "_"))
 
                     if func.IsMemberThisValue then
-                        createCodeFix(context, symbolName, SR.RenameValueToDoubleUnderscore.Value, TextChange(context.Span, "__"))
+                        createCodeFix(context, symbolName, SR.RenameValueToDoubleUnderscore(), TextChange(context.Span, "__"))
                     elif not func.IsMember then
-                        createCodeFix(context, symbolName, SR.RenameValueToUnderscore.Value, TextChange(context.Span, "_"))
+                        createCodeFix(context, symbolName, SR.RenameValueToUnderscore(), TextChange(context.Span, "_"))
                 | _ -> ()
         } 
         |> Async.Ignore
diff --git a/CodeFix/SimplifyName.fs b/CodeFix/SimplifyName.fs
@@ -24,8 +24,8 @@ type internal FSharpSimplifyNameCodeFixProvider() =
            for diagnostic in context.Diagnostics |> Seq.filter (fun x -> x.Id = fixableDiagnosticId) do
                let title =
                    match diagnostic.Properties.TryGetValue(SimplifyNameDiagnosticAnalyzer.LongIdentPropertyKey) with
-                   | true, longIdent -> sprintf "%s '%s'" SR.SimplifyName.Value longIdent
-                   | _ -> SR.SimplifyName.Value
+                   | true, longIdent -> sprintf "%s '%s'" (SR.SimplifyName()) longIdent
+                   | _ -> SR.SimplifyName()
 
                let codefix = createTextChangeCodeFix(title, context, (fun () -> asyncMaybe.Return [| TextChange(context.Span, "") |]))
 
diff --git a/Diagnostics/SimplifyNameDiagnosticAnalyzer.fs b/Diagnostics/SimplifyNameDiagnosticAnalyzer.fs
@@ -34,8 +34,8 @@ type internal SimplifyNameDiagnosticAnalyzer() =
     static let Descriptor = 
         DiagnosticDescriptor(
             id = IDEDiagnosticIds.SimplifyNamesDiagnosticId, 
-            title = SR.SimplifyName.Value, 
-            messageFormat = SR.NameCanBeSimplified.Value, 
+            title = SR.SimplifyName(),
+            messageFormat = SR.NameCanBeSimplified(),
             category = DiagnosticCategory.Style, 
             defaultSeverity = DiagnosticSeverity.Hidden, 
             isEnabledByDefault = true, 
diff --git a/Diagnostics/UnusedDeclarationsAnalyzer.fs b/Diagnostics/UnusedDeclarationsAnalyzer.fs
@@ -24,8 +24,8 @@ type internal UnusedDeclarationsAnalyzer() =
     let Descriptor = 
         DiagnosticDescriptor(
             id = DescriptorId,
-            title = SR.TheValueIsUnused.Value,
-            messageFormat = SR.TheValueIsUnused.Value,
+            title = SR.TheValueIsUnused(),
+            messageFormat = SR.TheValueIsUnused(),
             category = DiagnosticCategory.Style,
             defaultSeverity = DiagnosticSeverity.Hidden,
             isEnabledByDefault = true,
diff --git a/Diagnostics/UnusedOpensDiagnosticAnalyzer.fs b/Diagnostics/UnusedOpensDiagnosticAnalyzer.fs
@@ -150,8 +150,8 @@ type internal UnusedOpensDiagnosticAnalyzer() =
     static let Descriptor = 
         DiagnosticDescriptor(
             id = IDEDiagnosticIds.RemoveUnnecessaryImportsDiagnosticId, 
-            title = SR.RemoveUnusedOpens.Value, 
-            messageFormat = SR.UnusedOpens.Value, 
+            title = SR.RemoveUnusedOpens(),
+            messageFormat = SR.UnusedOpens(),
             category = DiagnosticCategory.Style, 
             defaultSeverity = DiagnosticSeverity.Hidden, 
             isEnabledByDefault = true, 
diff --git a/DocComments/XMLDocumentation.fs b/DocComments/XMLDocumentation.fs
@@ -198,7 +198,7 @@ module internal XmlDocumentation =
                     if not started then
                         started <- true
                         AppendHardLine collector
-                        AppendOnNewLine collector SR.ExceptionsLabel.Value
+                        AppendOnNewLine collector (SR.ExceptionsHeader())
                     EnsureHardLine collector
                     collector.Add(tagSpace "    ")
                     WriteTypeName collector exnType.Value
@@ -349,7 +349,7 @@ module internal XmlDocumentation =
         let ProcessGenericParameters (tps: Layout list) =
             if not tps.IsEmpty then
                 AppendHardLine typeParameterMapCollector
-                AppendOnNewLine typeParameterMapCollector SR.GenericParametersLabel.Value
+                AppendOnNewLine typeParameterMapCollector (SR.GenericParametersHeader())
                 for tp in tps do 
                     AppendHardLine typeParameterMapCollector
                     typeParameterMapCollector.Add(tagSpace "    ")
diff --git a/FSharp.Editor.Attributes.fs b/FSharp.Editor.Attributes.fs
@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft Corporation.  All Rights Reserved.  See License.txt in the project root for license information.
+
+namespace Microsoft.VisualStudio.FSharp.Editor
+
+//--------------------------------------------------------------------------------------
+// Attributes used to mark up editable properties 
+
+[<AttributeUsage(AttributeTargets.All)>]
+type internal SRDescriptionAttribute(description:string) =
+    inherit DescriptionAttribute(description)
+    let mutable replaced = false
+
+    override x.Description = 
+        if not (replaced) then 
+            replaced <- true
+            x.DescriptionValue <- SR.GetString(base.Description)
+        base.Description
+
+[<AttributeUsage(AttributeTargets.All)>]
+type internal SRCategoryAttribute(category:string) =
+    inherit CategoryAttribute(category)
+    override x.GetLocalizedString(value:string) = SR.GetString(value)
+
+[<AttributeUsage(AttributeTargets.Class ||| AttributeTargets.Property ||| AttributeTargets.Field, Inherited = false, AllowMultiple = false)>]
+type internal SRDisplayNameAttribute(name:string) =  
+    inherit DisplayNameAttribute()
+
+    override x.DisplayName = 
+      match SR.GetString(name) with 
+      | null -> 
+          Debug.Assert(false, "String resource '" + name + "' is missing")
+          name
+      | result -> result
diff --git a/FSharp.Editor.fsproj b/FSharp.Editor.fsproj
@@ -29,8 +29,9 @@
     <IncludePkgdefInVSIXContainer>true</IncludePkgdefInVSIXContainer>
   </PropertyGroup>
   <ItemGroup>
-    <EmbeddedResource Include="FSharp.Editor.resx" />
-    <Compile Include="srFSharp.Editor.fs" />
+    <EmbeddedResource Include="FSharp.Editor.resx" GenerateSource="true">
+      <GeneratedModuleName>Microsoft.VisualStudio.FSharp.Editor.SR</GeneratedModuleName>
+    </EmbeddedResource>
     <Compile Include="Common\AssemblyInfo.fs" />
     <Compile Include="Common\Pervasive.fs" />
     <Compile Include="Common\Extensions.fs" />
diff --git a/Navigation/GoToDefinitionService.fs b/Navigation/GoToDefinitionService.fs
@@ -252,7 +252,7 @@ type internal FSharpGoToDefinitionService
 
         match navigableItem with
         | Some navigableItem ->
-            statusBar.Message SR.NavigatingTo.Value
+            statusBar.Message (SR.NavigatingTo())
 
             let workspace = navigableItem.Document.Project.Solution.Workspace
             let navigationService = workspace.Services.GetService<IDocumentNavigationService>()
@@ -263,11 +263,11 @@ type internal FSharpGoToDefinitionService
             if result then 
                 statusBar.Clear()
             else 
-                statusBar.TempMessage SR.CannotNavigateUnknown.Value
+                statusBar.TempMessage (SR.CannotNavigateUnknown())
             
             result
         | None ->
-            statusBar.TempMessage SR.CannotDetermineSymbol.Value
+            statusBar.TempMessage (SR.CannotDetermineSymbol())
             true
 
     /// Navigate to the positon of the textSpan in the provided document
@@ -280,7 +280,7 @@ type internal FSharpGoToDefinitionService
         if navigationService.TryNavigateToSpan (workspace, navigableItem.Document.Id, navigableItem.SourceSpan, options) then 
             true 
         else
-            statusBar.TempMessage SR.CannotNavigateUnknown.Value
+            statusBar.TempMessage (SR.CannotNavigateUnknown())
             false
 
     /// find the declaration location (signature file/.fsi) of the target symbol if possible, fall back to definition 
@@ -405,7 +405,7 @@ type internal FSharpGoToDefinitionService
         member this.TryGoToDefinition(document: Document, position: int, cancellationToken: CancellationToken) =
             let definitionTask = this.FindDefinitionsTask (document, position, cancellationToken)
             
-            statusBar.Message SR.LocatingSymbol.Value
+            statusBar.Message (SR.LocatingSymbol())
             use __ = statusBar.Animate()
 
             // Wrap this in a try/with as if the user clicks "Cancel" on the thread dialog, we'll be cancelled
@@ -419,7 +419,7 @@ type internal FSharpGoToDefinitionService
             
             match completionError with
             | Some message ->
-                statusBar.TempMessage <| String.Format(SR.NavigateToFailed.Value, message)
+                statusBar.TempMessage <| String.Format(SR.NavigateToFailed(), message)
 
                 // Don't show the dialog box as it's most likely that the user cancelled.
                 // Don't make them click twice.
@@ -439,5 +439,5 @@ type internal FSharpGoToDefinitionService
                     //    presenter.DisplayResult(navigableItem.DisplayString, definitionTask.Result)
                     //true
                 else 
-                    statusBar.TempMessage SR.CannotDetermineSymbol.Value
+                    statusBar.TempMessage (SR.CannotDetermineSymbol())
                     false
diff --git a/srFSharp.Editor.fs b/srFSharp.Editor.fs
