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

Refactor mix lvn.install reference #1423

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

dbii
Copy link
Contributor

@dbii dbii commented Aug 29, 2024

The references to mix lvn.install are changed. Brooklyn wondered if these sections should be deleted now.

@@ -89,7 +89,7 @@ Follow the [LiveView Native Form Installation Guide](https://github.com/liveview

## Creating a Basic Form

The LiveView Native `mix lvn.install` task generates a [core_components.swiftui.ex](https://github.com/liveview-native/liveview-client-swiftui/blob/main/priv/templates/lvn.swiftui.gen/core_components.ex) file for native SwiftUI function components similar to the [core_components.ex](https://github.com/phoenixframework/phoenix/blob/main/priv/templates/phx.gen.live/core_components.ex) file generated in a traditional phoenix application for web function components.
The LiveView Native `mix lvn.setup.gen` task generates a [core_components.swiftui.ex](https://github.com/liveview-native/liveview-client-swiftui/blob/main/priv/templates/lvn.swiftui.gen/core_components.ex) file for native SwiftUI function components similar to the [core_components.ex](https://github.com/phoenixframework/phoenix/blob/main/priv/templates/phx.gen.live/core_components.ex) file generated in a traditional phoenix application for web function components.
Copy link
Collaborator

Choose a reason for hiding this comment

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

technically lvn.setup.gen will run all disoverable LVN setup generators. In otherwords, it could run

  • lvn.stylesheet.setup.gren
  • lvn.jetpack.setup.gen
  • lvn.swiftui.setup.gen

If the intent on this paragraph is to re-run just the SwiftUI one then lvn.swiftui.setup.gen would be better. Otherwise it may need to be noted that lvn.setup.gen will also run other setup generators.

/cc @BrooklinJazz ☝️ ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

@dbii checking back on this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

They need to change or be deleted. If we are keeping them, then I can change it to lvn.swiftui.setup.gen, or I can delete them. @BrooklinJazz should have a better feel for keeping or not based on his knowledge of all the help docs.

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