separate user specific project settings from stuff you want in git

[jessfraz]

we should split units setting out of project.toml and because you want to commit your units to git but you don’t wanna commit your theme etc. so we need two files. Settings for stuff that you want in git and user specific shit

And you can presume for assemblies we’d want dependencies in the same file as units

[lf94]

What should we call this new file? environment.toml or?...

[jessfraz]

whatever you think, kurt mentioned vscode uses .vscode for user specific stuff i think making a dot file helps

[jessfraz]

and the one commited to git would not be a dot file

[lf94]

Oh shit I like that. zma.toml, kcl.toml. Yes yes yes...

[franknoirot]

Okay I've been taking a look at the settings as understood by both Rust and TS sides, here are my notes:

Notes

Settings according to TS

• app
  • theme
  • themeColor
  • enableSSAO
  • streamIdleMode
  • onboardingStatus
  • dismissWebBanner
  • projectDirectory
• modeling
  • defaultUnit
  • mouseControls
  • cameraProjection
  • highlightEdges
  • showScaleGrid
  • showDebugPanel
• textEditor
  • textWrapping
  • blinkingCursor
• projects
  • defaultProjectName
• commandBar
  • includeSettings

    Settings according to Rust

• app
  • appearance
  • theme
  • color
  • onboarding_status
  • project_directory
  • theme
  • theme_color
  • enable_ssao
  • dismiss_web_banner
  • stream_idle_mode
• modeling
  • base_unit
  • camera_projection
  • mouse_controls
  • highlight_edges
  • show_debug_panel
  • enable_ssao
  • show_scale_grid
• text_editor
  • text_wrapping
  • blinking_cursor
• project
  • directory
  • default_project_name
• command_bar
  • include_settings

Settings that need to be in version control

• Units
  • Length
  • Angle (we don't have this but we should in future)

Settings that don't need to be in version control, but should be able to be per-project

• Theme color (but really not critical)

Settings that are useful to the CLI

Basically anything that affects the stream appearance, which in turn impacts the configuration for the zoo kcl snapshot command:

• app.appearance.theme
• app.enable_ssao
• app.project_directory (project.directory)
• modeling.camera_projection
• modeling.base_unit
• modeling.show_scale_grid
• modeling.highlight_edges

Recommendations

1. use the term "preferences" for non-critical, and therefore not-tracked-by-default, settings
2. rename the user preferences file to user.toml, since it would now contain settings and preferences
3. for user level, move all preferences into a different namespace in user.toml, under preferences
4. for project-level, split the current project.toml into settings.toml and .preferences.toml
   • Since the only project-level preference I see is themeColor, I think we could forego this if we want
5. update TS side to use structure defined in Rust side, such as app.appearance preference category
6. consider grouping CLI-necessary preferences
7. add backwards compatibility to read from the way things are, but never write to it

There are a lot of UI implications to this, which I think is working through in its own issue.