Project Maintenance: Reorganization and Documentation Improvement #625

excpt · 2025-07-20T16:07:02Z

To improve the future development of the project all the samples have been ported to the typed view-model-bindings.

The documentation and reference documents have been updated to reflect the changes.
The code has been reorganized.

The tests and benchmarks are moved to the tests folder.
The src folder holds the Elmish.WPF and Samples projects.
The solution files are now located in the project root and are now available as sln and slnx.
Default F# formatting is handled by fantomas

Replace legacy .sln format with modern .slnx format and relocate from src/ to project root

Restrict 2-space indentation to XML-based files (xml, slnx, fsproj, csproj, xaml) Install dotnet tool fantomas to handle F# formatting

Include .editorconfig, .gitignore, and LICENSE.md in solution folder

Format all F# source files in src/Elmish.WPF/ Format all F# test files in src/Elmish.WPF.Tests/ Format all F# sample project files Standardize code style and indentation

Improve code documentation comments of Elmish.WPF project.

Move all dynamic binding samples to src/Samples/Dynamic/ Move typed ViewModel samples to src/Samples/Typed/ Relocate test projects to tests/ folder Update .slnx file to reflect new project structure Add README explaining both binding approaches This reorganization makes it clearer for users to understand and choose between the dynamic bindings() approach and the typed ViewModelBase approach.

Update files reflecting the changes made in the project structure.

Create a new sln file. Update the workflow files to point to the sln file.

Copilot

Pull Request Overview

This is a comprehensive maintenance PR that adds new typed samples to the Elmish.WPF framework and reorganizes the existing sample structure. The PR introduces a "Typed" approach to data binding while preserving the existing "Dynamic" approach, creating a clear distinction between the two paradigms.

Key changes:

Reorganizes samples into Dynamic and Typed folders to distinguish binding approaches
Adds new typed sample applications that use strongly-typed ViewModels
Creates comprehensive documentation explaining both binding approaches

Reviewed Changes

Copilot reviewed 247 out of 405 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/Samples/README.md	Documents the two binding approaches and sample organization
src/Samples/Typed/*/Program.fs	New typed samples using ViewModelBase inheritance
src/Samples/Dynamic/*	Reorganized existing samples into Dynamic folder
src/Samples/Typed//.xaml.cs	Code-behind files for new typed samples
src/Samples/Typed//.csproj	Project files for new typed C# projects

Copilot · 2025-07-21T07:55:48Z

src/Samples/Dynamic/SubModelOpt/Form1.xaml

  <StackPanel Width="300">
    <TextBlock Text="Form 1" FontSize="18" FontWeight="Bold" HorizontalAlignment="Center" Margin="0,0,0,5" />
-    <TextBox Text="{Binding Text, UpdateSourceTrigger=PropertyChanged}" TextWrapping="Wrap" AcceptsReturn="True" Height="80" Margin="0,5,0,5" />
+    <TextBox Text="{Binding Text, UpdateSourceTrigger=PropertyChanged}" TextWrapping="Wrap" AcceptsReturn="True"


[nitpick] This line is being formatted but has inconsistent casing with 'UpdateSourceTrigger' using PascalCase while 'TextWrapping' and 'AcceptsReturn' use PascalCase consistently. This is correct XAML syntax.

Copilot · 2025-07-21T07:55:48Z

src/Samples/Typed/EventBindingsAndBehaviors/FocusWhenVisibleBehavior.cs

+
+    private void UIElement_IsVisibleChanged(object sender, DependencyPropertyChangedEventArgs e)
+    {
+        if (e.NewValue is bool b && b) _ = AssociatedObject.Focus();


[nitpick] Using pattern matching with a simple boolean comparison 'b && b' can be simplified to just check if the value is true: 'e.NewValue is true'

Suggested change

if (e.NewValue is bool b && b) _ = AssociatedObject.Focus();

if (e.NewValue is true) _ = AssociatedObject.Focus();

Copilot · 2025-07-21T07:55:49Z

src/Samples/Typed/FileDialogsCmdMsg.Core/FileDialogsCmdMsg.Core.fsproj

+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\Elmish.WPF\Elmish.WPF.fsproj"/>


The project reference path uses backslashes which may cause issues on non-Windows systems. Consider using forward slashes for cross-platform compatibility.

Suggested change

<ProjectReference Include="..\..\..\Elmish.WPF\Elmish.WPF.fsproj"/>

<ProjectReference Include="../../../Elmish.WPF/Elmish.WPF.fsproj"/>

Update README.md to emphasize both Dynamic and Typed ViewModel approaches Add comprehensive guidance on when to choose each binding approach Revise getting started section with dual-path examples for both approaches Add FAQ entries for approach selection and migration between Dynamic/Typed Significantly expand REFERENCE.md statically-typed ViewModels section Document proper TwoWay binding patterns for typed ViewModels (getter/setter) Add new "Choosing Your Binding Approach" section with comparison table Update all sample references to reflect new Dynamic/Typed folder organization Add comprehensive examples for typed bindings, validation, and sub-models This update ensures documentation accurately reflects the complete set of typed samples and the reorganized project structure, providing users with clear guidance on both binding approaches and migration paths. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

Add a sample how to create a simple module based navigation using typed view models. Fix solution file structure.

marner2 · 2025-07-23T19:54:39Z

Please update PR #591 to include fantomas.

Also please refrain from fully comprehensive PR's that touch 10000's of lines of code and do more than one thing. The reorganization should be separate from the added examples (and that separate from any feature changes) so we can reasonably review all of the changes by hand.

marner2

Please do not change 40,000 lines in a single pull request without being extremely clear about the single thing you are doing. This PR has multiple things going on, many of which can be split out into smaller, much more focused PRs. Additionally as stated earlier it contains changes that are currently pending in another PR.

LyndonGingerich · 2025-08-23T01:24:41Z

I move to close this PR. The requester can then make smaller, more atomic PRs if he so chooses.

excpt added 9 commits July 18, 2025 14:41

Migrate solution file to .slnx format

66ffb32

Replace legacy .sln format with modern .slnx format and relocate from src/ to project root

Configure EditorConfig for project file formatting

5fff0a1

Restrict 2-space indentation to XML-based files (xml, slnx, fsproj, csproj, xaml) Install dotnet tool fantomas to handle F# formatting

Add files to .slnx

ff8c253

Include .editorconfig, .gitignore, and LICENSE.md in solution folder

Apply Fantomas code formatting across entire codebase

929b851

Format all F# source files in src/Elmish.WPF/ Format all F# test files in src/Elmish.WPF.Tests/ Format all F# sample project files Standardize code style and indentation

Improve XML documentation in code

78bc7b1

Improve code documentation comments of Elmish.WPF project.

Remove .claude folder

2aa660e

Update github workflow files

aad29e8

Update files reflecting the changes made in the project structure.

Fix github workflow issues

e045d80

Create a new sln file. Update the workflow files to point to the sln file.

excpt requested a review from Copilot July 20, 2025 16:27

This comment was marked as outdated.

Sign in to view

excpt added 4 commits July 20, 2025 18:58

Add transposed typed samples

d4c2e85

Add transposed typed samples

7cc6eee

Fix Samples/Typed/Capabilities

5fdd7cc

Add missing typed samples

05cd252

excpt requested a review from Copilot July 21, 2025 07:55

Copilot AI reviewed Jul 21, 2025

View reviewed changes

excpt changed the title ~~WIP: Maintenance~~ Project Maintenance: Reorganization and Documentation Improvement Jul 21, 2025

excpt requested a review from marner2 July 21, 2025 09:06

excpt added 3 commits July 23, 2025 18:09

Add typed navigation sample

3d76eaa

Add a sample how to create a simple module based navigation using typed view models. Fix solution file structure.

Fix framework version

5b7c9c6

Add navigations sample for dynamic bindings

7e78e40

House keeping: Code formatting

aeeafec

marner2 requested changes Jul 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Project Maintenance: Reorganization and Documentation Improvement #625

Project Maintenance: Reorganization and Documentation Improvement #625

Uh oh!

excpt commented Jul 20, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 21, 2025

Uh oh!

Copilot AI Jul 21, 2025

Uh oh!

Copilot AI Jul 21, 2025

Uh oh!

marner2 commented Jul 23, 2025

Uh oh!

marner2 left a comment

Uh oh!

LyndonGingerich commented Aug 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	if (e.NewValue is bool b && b) _ = AssociatedObject.Focus();
	if (e.NewValue is true) _ = AssociatedObject.Focus();

	<ProjectReference Include="..\..\..\Elmish.WPF\Elmish.WPF.fsproj"/>
	<ProjectReference Include="../../../Elmish.WPF/Elmish.WPF.fsproj"/>

Uh oh!

Project Maintenance: Reorganization and Documentation Improvement #625

Are you sure you want to change the base?

Project Maintenance: Reorganization and Documentation Improvement #625

Uh oh!

Conversation

excpt commented Jul 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

marner2 commented Jul 23, 2025

Uh oh!

marner2 left a comment

Choose a reason for hiding this comment

Uh oh!

LyndonGingerich commented Aug 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

excpt commented Jul 20, 2025 •

edited

Loading