Support for FSAC updates

The current implementation assumes that only the file being edited is Analyzed.
However, the Analyzer's behavior has changed so that every time one source code is edited, the project's files are analyzed.
This has caused a bug.

FuncUiAnalyzer server is not active

Moved from Avalonia.FuncUI issues.

I tried to use LiveView with my https://github.com/JordanMarr/FSharp.ChordParser project, but I have not yet been able to get it to work.

Steps

Since I do not use Paket, I used nuget to install the analyzer to packages/analyzers:

nuget install SilkyFowl.Avalonia.FuncUI.LiveView.Analyzer -Version 0.0.1-alpha2 -OutputDirectory packages/analyzers

I installed LiveView to my UI project:

<PackageReference Include="SilkyFowl.Avalonia.FuncUI.LiveView" Version="0.0.1-alpha2" />

I debugged using the correct launch profile:

My Program.fs is setup the same as your readme.
I added the [<LivePreview>] to my render function:

Results

But the LivePreview window says "the FuncUiAnalyzer server is not active":

My changes here in the LivePreview branch:
https://github.com/JordanMarr/FSharp.ChordParser/tree/LivePreview

Commit:
JordanMarr/FSharp.ChordParser@48254bb

Improve LivePreview

Rethink the protocol between Analyzer, Previewer

参考

https://github.com/AvaloniaUI/Avalonia/blob/268e5ee549879e3fdc279119de05f6742ee68e2c/tests/Avalonia.DesignerSupport.Tests/RemoteProtocolTests.cs#L31

eval button causes an exception,

Exception has occurred: CLR/System.TypeInitializationException
An unhandled exception of type 'System.TypeInitializationException' occurred in Avalonia.FuncUI.LiveView.dll: 'The type initializer for '<StartupCode$Avalonia-FuncUI-LiveView>.$LiveView' threw an exception.'
Inner exceptions found, see $exception in variables window for more details.
Innermost exception System.Exception : Error creating evaluation session: StopProcessingExn
at Microsoft.FSharp.Core.PrintfModule.PrintFormatToStringThenFail@1448.Invoke(String message)
at FSharp.Compiler.Interactive.Shell.FsiEvaluationSession..ctor(FsiEvaluationSessionHostConfig fsi, String[] argv, TextReader inReader, TextWriter outWriter, TextWriter errorWriter, Boolean fsiCollectible, FSharpOption1 legacyReferenceResolver) at FSharp.Compiler.Interactive.Shell.FsiEvaluationSession.Create(FsiEvaluationSessionHostConfig fsiConfig, String[] argv, TextReader inReader, TextWriter outWriter, TextWriter errorWriter, FSharpOption1 collectible, FSharpOption`1 legacyReferenceResolver)
at Avalonia.FuncUI.LiveView.FsiSession.create()
at <StartupCode$Avalonia-FuncUI-LiveView>.$LiveView..cctor()

Introduce GitHub Actions

Update to new Avalonia.FuncUI NuGet package

Greetings!

Recently, FuncUI has been officially added to the Avalonia family, which has allowed us to change the NuGet package name from JaggerJo.Avalonia.FuncUI to Avalonia.FuncUI.

Would it be possible to release a new version of LiveView that works with the latest Avalonia.FuncUI package?

Error occured when unchecking "Show EvalText"

Avalonia.FuncUI.LiveView v0.0.1 release

To support #17, v0.0.1-alpha4 is released as v0.0.1.
After v0.0.2-alpha1, it will support the new Avalonia.FuncUI package.

Add description of LivePreview #7

#7

Separate LiveViewWindow from SilkyFowl.Avalonia.FuncUI.LiveView.

SilkyFowl.Avalonia.FuncUI.LiveView contains a LiveViewWindow that previews a function with a LivePreviewAttribute. Because of this, a dependency of LiveViewWindow, which is not necessary, is mixed into the project that wants to be previewed.
Since LivePreviewAttribute itself has no dependency, it can be solved by separating LiveViewWindow into a separate library.

Add dotnet tool to control LivePreview Analyzer

seems like a version conflict is giving a bug

Hey, I was trying to get this to work, and it seems like it doesn't like a change that's happened in avalonia funcui version 1


Unhandled exception. System.TypeLoadException: Could not load type 'Avalonia.FuncUI.Builder.ViewBuilder' from assembly 'Avalonia.FuncUI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null'.
   at Avalonia.FuncUI.LiveView.StateStoreModule.init()
   at Avalonia.FuncUI.LiveView.LiveViewWindow..ctor()

how would you recommend working around this?

Consider future policy.

As soon as the contents are finalized, they will be included in README.md.

Plan

Aim to PR in Avalonia.FuncUI.

context:

fsprojects/Avalonia.FuncUI#115 (comment)

Things to do in this repository before creating a PR

bug fix

#3
#5
#6

required

Add test code.
Package size optimization
- The analyzer is 50 MB, which is too large. Build scripts need to be improved to incorporate only the necessary libraries.

Write Doc

Explanation of the LIVEPREVIEW directive
- Considering that LivePreview is not needed for debugging purposes, should it be managed separately from the DEBUG directive?
Example of use outside VScode
In theory, it should also work with vim, etc.

Organize network communication process

If you want to achieve PR, you need to do something about the current situation where IP address and Port are fixed.

Consider how to set IP address and Port
- Environment variable is good?

Performance

Identify cases where updates are slow. (Add samples)
- Perhaps Previewing a View that contains complex logic may be slow.
- Let's verify with Elmish's sample.

Add features

Make it possible to complete only with Fsi.
- Is it appropriate to add Cli? Should we refer to XAML Studio for that?

vNext

Support for Appnium
- It would be good if we can do the StoryBook thing.
- Avalonia repository has sample code.
  - https://github.com/AvaloniaUI/Avalonia/tree/master/tests/Avalonia.IntegrationTests.Appium
Make sure that updated code stops at breakpoints.
- This is a little out of the goal of checking the look and feel generated by the code.
- Therefore, we will start after the update of Fsharp's Analyzer API is completed.

If there is a DU in the file that consists entirely of valued case labels, it cannot be previewed

LivePreview cannot be performed if an fsharp code contains a "DU with values in all Cases" such as the following:

type Bar =
    | Hoge of int
    | Fuga of string

// A single valued DU can also cause problems.
type Foo= Foo of id:int

However, if there is more than one Case with no value, there is no problem.

type Foo = Foo

type Bar =
    | Hoge
    | Fuga of string

type Bar<'t> =
    | Hoge
    | Fuga of string
    | A of {|a:int; b:string; c: bool * string|}
    | B of ('t -> unit)

workaround

Make it a DU that includes one or more cases with no value

Avalonia.FuncUI.LiveView/src/Sample/ElmishSample.fs

Lines 1 to 60 in dc88338

    
           /// 参考：https://github.com/fsprojects/Avalonia.FuncUI/blob/master/src/Avalonia.FuncUI.ControlCatalog/Views/Tabs/TextBoxDemo.fs 
        
           module Sample.ElmishSample.DefineDUInFile 
        
           open Avalonia.Controls 
        
           open Avalonia.Layout 
        
           open Avalonia.FuncUI 
        
           open Avalonia.FuncUI.DSL 
        
           open Avalonia.FuncUI.Elmish 
        
           open Avalonia.FuncUI.Builder 
        
           open Avalonia.FuncUI.LiveView.Core.Types 
        
           type State = { watermark: string } 
        
           let init = { watermark = "" } 
        
           /// LivePreviewを行いたいコードで判別共用体を定義する際は、値のないケースラベルを1つ以上含めないといけない。 
        
           /// 全てのケースラベルに値が設定されているとAnalyzerが失敗する。 
        
           type Msg = 
        
               | SetWatermark of string 
        
               | UnSetWatermark 
        
           let update msg state = 
        
               match msg with 
        
               | SetWatermark test -> { state with watermark = test } 
        
               | UnSetWatermark -> { state with watermark = "" } 
        
           let view state dispatch = 
        
               StackPanel.create [ 
        
                   StackPanel.spacing 10.0 
        
                   StackPanel.children [ 
        
                       TextBox.create [ 
        
                           TextBox.watermark state.watermark 
        
                           TextBox.horizontalAlignment HorizontalAlignment.Stretch 
        
                       ] 
        
                       Button.create [ 
        
                           Button.content "Set Watermark" 
        
                           Button.background "DarkBlue" 
        
                           Button.onClick (fun _ -> dispatch (SetWatermark "test")) 
        
                           Button.horizontalAlignment HorizontalAlignment.Stretch 
        
                       ] 
        
                       Button.create [ 
        
                           Button.content "Unset Watermark" 
        
                           Button.onClick (fun _ -> dispatch (UnSetWatermark)) 
        
                           Button.horizontalAlignment HorizontalAlignment.Stretch 
        
                       ] 
        
                   ] 
        
               ] 
        
           type Host() as this = 
        
               inherit Hosts.HostControl() 
        
               do 
        
                   Elmish.Program.mkSimple (fun () -> init) update view 
        
                   |> Program.withHost this 
        
                   |> Elmish.Program.run 
        
           [<LivePreview>] 
        
           let preview () = ViewBuilder.Create<Host> []

DU are defined in a separate file

Avalonia.FuncUI.LiveView/src/Sample/Types.fs

Lines 13 to 22 in dc88338

    
           module ElmishModule = 
        
               type State = { watermark: string } 
        
               let init = { watermark = "" } 
        
               type Msg = 
        
                   | SetWatermark of string 
        
               let update msg state = 
        
                   match msg with 
        
                   | SetWatermark test -> { state with watermark = test }

Avalonia.FuncUI.LiveView/src/Sample/ElmishDefineDUInAnotherFileSample.fs

Lines 1 to 47 in dc88338

    
           module Sample.ElmishSample.DefineDUInAnotherFile 
        
           open Avalonia.Controls 
        
           open Avalonia.Layout 
        
           open Avalonia.FuncUI 
        
           open Avalonia.FuncUI.DSL 
        
           open Avalonia.FuncUI.Elmish 
        
           open Avalonia.FuncUI.Builder 
        
           open Avalonia.FuncUI.LiveView.Core.Types 
        
           open Sample.ElmishModule 
        
           let view (state:State) dispatch = 
        
               StackPanel.create [ 
        
                   StackPanel.spacing 10.0 
        
                   StackPanel.children [ 
        
                       TextBox.create [ 
        
                           TextBox.watermark state.watermark 
        
                           TextBox.horizontalAlignment HorizontalAlignment.Stretch 
        
                       ] 
        
                       Button.create [ 
        
                           Button.background "DarkBlue" 
        
                           Button.content "Set Watermark" 
        
                           Button.onClick (fun _ -> SetWatermark "test" |> dispatch) 
        
                           Button.horizontalAlignment HorizontalAlignment.Stretch 
        
                       ] 
        
                       Button.create [ 
        
                           Button.content "Unset Watermark" 
        
                           Button.onClick (fun _ -> SetWatermark "" |> dispatch) 
        
                           Button.horizontalAlignment HorizontalAlignment.Stretch 
        
                       ] 
        
                   ] 
        
               ] 
        
           type Host() as this = 
        
               inherit Hosts.HostControl() 
        
               do 
        
                   Elmish.Program.mkSimple (fun () -> init) update view 
        
                   |> Program.withHost this 
        
                   |> Elmish.Program.run 
        
           [<LivePreview>] 
        
           let preview () = ViewBuilder.Create<Host> []

context:

Avalonia.FuncUI.LiveView uses FSharp.Compiler.Service to perform TypedAST pattern matching to determine if Preview is performed.
However, if a DU with values in all cases is included in some fsharp code, the following error occurs.

FSharp.Compiler.Service cannot yet return this kind of pattern match

Originally posted by @SilkyFowl in #1 (comment)

Add Sample

release:v0.0.4

TODO

When DU is not at at the end of the code, FSharpChecker.ParseAndCheckProject failed.

Work

// Some code...

type AnyDuHasNoValueLabelCase =
    | Foo
    | Bar of int

Not Work(Error Message: typecheck error Duplicate definition of type, exception or module 'Counter)

// Some code...
// So far, I can analyze it correctly.

type AnyDuHasNoValueLabelCase =
    | Foo
    | Bar of int

// Other some code...
// Not work

Test Code is here.

Avalonia.FuncUI.LiveView/tests/Avalonia.FuncUI.LiveView.Core.Tests/FuncUIAnalysisTests.fs

Lines 231 to 360 in f991cb3

    
               let module_with_some_value_after_DU = 
        
                   let baseCode = 
        
                           sprintf """ 
        
           open System 
        
           open Avalonia.FuncUI 
        
           open Avalonia.FuncUI.DSL 
        
           open Avalonia.Controls 
        
           open Avalonia.FuncUI.LiveView.Core.Types 
        
           %s 
        
           module Counter = 
        
               open Avalonia.FuncUI 
        
               open Avalonia.Controls 
        
               open Avalonia.Media 
        
               open Avalonia.FuncUI.DSL 
        
               open Avalonia.Layout 
        
               let view = 
        
                   Component.create ( 
        
                       "Counter", 
        
                       fun ctx -> 
        
                           let state = ctx.useState 0 
        
                           Grid.create [ 
        
                               Grid.rowDefinitions "test,Auto" 
        
                               Grid.children [ 
        
                                   TextBlock.create [ 
        
                                       TextBlock.text "Foo!!" 
        
                                   ] 
        
                               ] 
        
                           ] 
        
                   ) 
        
               [<LivePreview>] 
        
               let preview () = 
        
                   view 
        
               [<LivePreview>] 
        
               let preview2 = 
        
                   let n = 1 
        
                   view 
        
               """ 
        
                   anyNoValueCaseDUs 
        
                   |> List.map ( fun du -> 
        
                       [| (baseCode >> box) du |] 
        
                   ) 
        
               let nestedAnyNoValueCaseDUs = 
        
                           [ 
        
                               """ 
        
               type Foo = Foo 
        
                               """ 
        
                               """ 
        
               type Bar = 
        
                   | Hoge 
        
                   | Fuga of string 
        
                               """ 
        
                               """ 
        
               type Bar<'t> = 
        
                   | Hoge 
        
                   | Fuga of string 
        
                   | A of {|a:int; b:string; c: bool * string|} 
        
                   | B of ('t -> unit) 
        
                               """ 
        
                           ] 
        
               let module_after_DU_contain_module = 
        
                   let baseCode = 
        
                           sprintf """ 
        
           open System 
        
           open Avalonia.FuncUI 
        
           open Avalonia.FuncUI.DSL 
        
           open Avalonia.Controls 
        
           open Avalonia.FuncUI.LiveView.Core.Types 
        
           module DUs = 
        
           %s 
        
           module Counter = 
        
               open Avalonia.FuncUI 
        
               open Avalonia.Controls 
        
               open Avalonia.Media 
        
               open Avalonia.FuncUI.DSL 
        
               open Avalonia.Layout 
        
               let view = 
        
                   Component.create ( 
        
                       "Counter", 
        
                       fun ctx -> 
        
                           let state = ctx.useState 0 
        
                           Grid.create [ 
        
                               Grid.rowDefinitions "test,Auto" 
        
                               Grid.children [ 
        
                                   TextBlock.create [ 
        
                                       TextBlock.text "Foo!!" 
        
                                   ] 
        
                               ] 
        
                           ] 
        
                   ) 
        
               [<LivePreview>] 
        
               let preview () = 
        
                   view 
        
               [<LivePreview>] 
        
               let preview2 = 
        
                   let n = 1 
        
                   view 
        
               """ 
        
                   nestedAnyNoValueCaseDUs 
        
                   |> List.map ( fun du -> 
        
                       [| (baseCode >> box) du |] 
        
                   ) 
        
               [<Theory>] 
        
               [<MemberData(nameof module_with_some_value_after_DU)>] 
        
               [<MemberData(nameof module_after_DU_contain_module)>] 
        
               let ``wont work If module with some value after DU`` code = 
        
                   let ex = 
        
                       Assert.Throws<Sdk.EmptyException>(fun _ -> 
        
                       createTestCode code 
        
                       |> Helper.runFuncUIAnalysis 
        
                       |> ignore 
        
                       ) 
        
                   ex.Message |> shouldContainText "typecheck error Duplicate definition of type, exception or module 'Counter'"

Originally posted by @SilkyFowl in #1 (comment)

	/// 参考：https://github.com/fsprojects/Avalonia.FuncUI/blob/master/src/Avalonia.FuncUI.ControlCatalog/Views/Tabs/TextBoxDemo.fs
	module Sample.ElmishSample.DefineDUInFile

	open Avalonia.Controls
	open Avalonia.Layout
	open Avalonia.FuncUI
	open Avalonia.FuncUI.DSL
	open Avalonia.FuncUI.Elmish
	open Avalonia.FuncUI.Builder
	open Avalonia.FuncUI.LiveView.Core.Types

	type State = { watermark: string }

	let init = { watermark = "" }

	/// LivePreviewを行いたいコードで判別共用体を定義する際は、値のないケースラベルを1つ以上含めないといけない。
	/// 全てのケースラベルに値が設定されているとAnalyzerが失敗する。
	type Msg =
	\| SetWatermark of string
	\| UnSetWatermark


	let update msg state =
	match msg with
	\| SetWatermark test -> { state with watermark = test }
	\| UnSetWatermark -> { state with watermark = "" }

	let view state dispatch =
	StackPanel.create [
	StackPanel.spacing 10.0
	StackPanel.children [
	TextBox.create [
	TextBox.watermark state.watermark
	TextBox.horizontalAlignment HorizontalAlignment.Stretch
	]
	Button.create [
	Button.content "Set Watermark"
	Button.background "DarkBlue"
	Button.onClick (fun _ -> dispatch (SetWatermark "test"))
	Button.horizontalAlignment HorizontalAlignment.Stretch
	]

	Button.create [
	Button.content "Unset Watermark"
	Button.onClick (fun _ -> dispatch (UnSetWatermark))
	Button.horizontalAlignment HorizontalAlignment.Stretch
	]
	]
	]

	type Host() as this =
	inherit Hosts.HostControl()

	do
	Elmish.Program.mkSimple (fun () -> init) update view
	\|> Program.withHost this
	\|> Elmish.Program.run

	[<LivePreview>]
	let preview () = ViewBuilder.Create<Host> []

	module ElmishModule =
	type State = { watermark: string }
	let init = { watermark = "" }

	type Msg =
	\| SetWatermark of string

	let update msg state =
	match msg with
	\| SetWatermark test -> { state with watermark = test }

	module Sample.ElmishSample.DefineDUInAnotherFile

	open Avalonia.Controls
	open Avalonia.Layout
	open Avalonia.FuncUI
	open Avalonia.FuncUI.DSL
	open Avalonia.FuncUI.Elmish
	open Avalonia.FuncUI.Builder
	open Avalonia.FuncUI.LiveView.Core.Types
	open Sample.ElmishModule

	let view (state:State) dispatch =

	StackPanel.create [
	StackPanel.spacing 10.0
	StackPanel.children [
	TextBox.create [
	TextBox.watermark state.watermark
	TextBox.horizontalAlignment HorizontalAlignment.Stretch
	]
	Button.create [
	Button.background "DarkBlue"
	Button.content "Set Watermark"
	Button.onClick (fun _ -> SetWatermark "test" \|> dispatch)
	Button.horizontalAlignment HorizontalAlignment.Stretch
	]


	Button.create [
	Button.content "Unset Watermark"
	Button.onClick (fun _ -> SetWatermark "" \|> dispatch)
	Button.horizontalAlignment HorizontalAlignment.Stretch
	]
	]
	]


	type Host() as this =
	inherit Hosts.HostControl()

	do
	Elmish.Program.mkSimple (fun () -> init) update view
	\|> Program.withHost this
	\|> Elmish.Program.run

	[<LivePreview>]
	let preview () = ViewBuilder.Create<Host> []

	let module_with_some_value_after_DU =
	let baseCode =
	sprintf """
	open System
	open Avalonia.FuncUI
	open Avalonia.FuncUI.DSL
	open Avalonia.Controls
	open Avalonia.FuncUI.LiveView.Core.Types

	%s

	module Counter =
	open Avalonia.FuncUI
	open Avalonia.Controls
	open Avalonia.Media
	open Avalonia.FuncUI.DSL
	open Avalonia.Layout

	let view =
	Component.create (
	"Counter",
	fun ctx ->
	let state = ctx.useState 0

	Grid.create [
	Grid.rowDefinitions "test,Auto"
	Grid.children [
	TextBlock.create [
	TextBlock.text "Foo!!"
	]
	]
	]
	)

	[<LivePreview>]
	let preview () =
	view

	[<LivePreview>]
	let preview2 =
	let n = 1
	view

	"""
	anyNoValueCaseDUs
	\|> List.map ( fun du ->
	[\| (baseCode >> box) du \|]
	)

	let nestedAnyNoValueCaseDUs =
	[
	"""
	type Foo = Foo
	"""
	"""
	type Bar =
	\| Hoge
	\| Fuga of string
	"""
	"""
	type Bar<'t> =
	\| Hoge
	\| Fuga of string
	\| A of {\|a:int; b:string; c: bool * string\|}
	\| B of ('t -> unit)
	"""
	]

	let module_after_DU_contain_module =
	let baseCode =
	sprintf """
	open System
	open Avalonia.FuncUI
	open Avalonia.FuncUI.DSL
	open Avalonia.Controls
	open Avalonia.FuncUI.LiveView.Core.Types


	module DUs =
	%s

	module Counter =
	open Avalonia.FuncUI
	open Avalonia.Controls
	open Avalonia.Media
	open Avalonia.FuncUI.DSL
	open Avalonia.Layout

	let view =
	Component.create (
	"Counter",
	fun ctx ->
	let state = ctx.useState 0

	Grid.create [
	Grid.rowDefinitions "test,Auto"
	Grid.children [
	TextBlock.create [
	TextBlock.text "Foo!!"
	]
	]
	]
	)

	[<LivePreview>]
	let preview () =
	view

	[<LivePreview>]
	let preview2 =
	let n = 1
	view

	"""
	nestedAnyNoValueCaseDUs
	\|> List.map ( fun du ->
	[\| (baseCode >> box) du \|]
	)

	[<Theory>]
	[<MemberData(nameof module_with_some_value_after_DU)>]
	[<MemberData(nameof module_after_DU_contain_module)>]
	let ``wont work If module with some value after DU`` code =
	let ex =
	Assert.Throws<Sdk.EmptyException>(fun _ ->
	createTestCode code
	\|> Helper.runFuncUIAnalysis
	\|> ignore
	)
	ex.Message \|> shouldContainText "typecheck error Duplicate definition of type, exception or module 'Counter'"

silkyfowl / avalonia.funcui.liveview Goto Github PK

avalonia.funcui.liveview's People

Contributors

Stargazers

Watchers

Forkers

avalonia.funcui.liveview's Issues

Steps

Results

Plan

bug fix

required

Write Doc

Organize network communication process

Performance

Add features

vNext

workaround

Make it a DU that includes one or more cases with no value

DU are defined in a separate file

context:

TODO

Recommend Projects

Recommend Topics

Recommend Org