Skip to content

Refactor mix lvn.install reference #1423

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.

Sign up for GitHub

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

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

Refactor mix lvn.install reference #1423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e8f100a
Updated to use hex.pm for live_view_native and live_view_native_swift…
dbii Jun 26, 2023
5425c52
Merge pull request #1 from liveview-native/main
dbii Jul 18, 2023
9deb6a9
Merge branch 'liveview-native:main' into main
dbii Aug 17, 2023
2f5c85b
Merge branch 'liveview-native:main' into main
dbii Aug 23, 2024
c13f1a4
Merge remote-tracking branch 'refs/remotes/origin/main'
dbii Aug 28, 2024
00e69bd
Merge remote-tracking branch 'refs/remotes/origin/main'
dbii Aug 29, 2024
e4942c4
Change references to mix lvn.install
dbii Aug 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion livebooks/create-a-swiftui-application.livemd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Mix.install(

This guide will teach you how to set up a SwiftUI Application for LiveView Native.

Typically, we recommend using the `mix lvn.install` task as described in [Getting Started](https://hexdocs.pm/live_view_native/readme.html#getting-started) to add LiveView Native to a Phoenix project. However, we will walk through the steps of manually setting up an Xcode iOS project to learn how the iOS side of a LiveView Native application works.
Typically, we recommend using the `mix lvn.setup` task as described in [Getting Started](https://hexdocs.pm/live_view_native/readme.html#getting-started) to add LiveView Native to a Phoenix project. However, we will walk through the steps of manually setting up an Xcode iOS project to learn how the iOS side of a LiveView Native application works.

In future lessons, you'll use this iOS application to view iOS examples in the Xcode simulator (or a physical device if you prefer.)

Expand Down
2 changes: 1 addition & 1 deletion livebooks/forms-and-validation.livemd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


See Phoenix's [Components and HEEx](https://hexdocs.pm/phoenix/components.html) HexDoc documentation if you need a primer on function components.

Expand Down
2 changes: 1 addition & 1 deletion livebooks/markdown/create-a-swiftui-application.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

This guide will teach you how to set up a SwiftUI Application for LiveView Native.

Typically, we recommend using the `mix lvn.install` task as described in [Getting Started](https://hexdocs.pm/live_view_native/readme.html#getting-started) to add LiveView Native to a Phoenix project. However, we will walk through the steps of manually setting up an Xcode iOS project to learn how the iOS side of a LiveView Native application works.
Typically, we recommend using the `mix lvn.setup` task as described in [Getting Started](https://hexdocs.pm/live_view_native/readme.html#getting-started) to add LiveView Native to a Phoenix project. However, we will walk through the steps of manually setting up an Xcode iOS project to learn how the iOS side of a LiveView Native application works.

In future lessons, you'll use this iOS application to view iOS examples in the Xcode simulator (or a physical device if you prefer.)

Expand Down
2 changes: 1 addition & 1 deletion livebooks/markdown/forms-and-validation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,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.

See Phoenix's [Components and HEEx](https://hexdocs.pm/phoenix/components.html) HexDoc documentation if you need a primer on function components.

Expand Down