Use cargo-generate for hello-world tutorial (#709)

Direct link:
https://jm-hello-template.ratatui.pages.dev/tutorials/hello-ratatui/

astro.config.mjs

@@ -91,8 +91,8 @@ export default defineConfig({
               link: "/tutorials/",
             },
             {
-              label: "Hello World",
-              link: "/tutorials/hello-world/",
+              label: "Hello Ratatui",
+              link: "/tutorials/hello-ratatui/",
             },
             {
               label: "Counter App",

code/tutorials/hello-world/hello.tape → code/tutorials/hello-ratatui.tape

@@ -1,12 +1,12 @@
 # A VHS tape. See https://github.com/charmbracelet/vhs
-Output hello.gif
+Output hello-ratatui.gif
 Set Theme "Aardvark Blue"
-Set Width 800
+Set Width 1200
 Set Height 450
-Type "cargo run"
+Type "cargo run -p hello-ratatui"
 Enter
 Sleep 7s
-Screenshot hello.png
+Screenshot hello-ratatui.png
 Sleep 1s
 Type q
 Sleep 2s

code/tutorials/hello-ratatui/.github/dependabot.yml

@@ -0,0 +1,17 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # Maintain dependencies for Cargo
+  - package-ecosystem: "cargo"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly

code/tutorials/hello-ratatui/.github/workflows/ci.yml

@@ -0,0 +1,89 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - master
+      - develop
+
+env:
+  CARGO_TERM_COLOR: always
+
+# ensure that the workflow is only triggered once per PR, subsequent pushes to the PR will cancel
+# and restart the workflow. See https://docs.github.com/en/actions/using-jobs/using-concurrency
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  fmt:
+    name: fmt
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Rust stable
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+      - name: check formatting
+        run: cargo fmt -- --check
+      - name: Cache Cargo dependencies
+        uses: Swatinem/rust-cache@v2
+  clippy:
+    name: clippy
+    runs-on: ubuntu-latest
+    permissions:
+      checks: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Rust stable
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
+      - name: Run clippy action
+        uses: clechasseur/rs-clippy-check@v3
+      - name: Cache Cargo dependencies
+        uses: Swatinem/rust-cache@v2
+  doc:
+    # run docs generation on nightly rather than stable. This enables features like
+    # https://doc.rust-lang.org/beta/unstable-book/language-features/doc-cfg.html which allows an
+    # API be documented as only available in some specific platforms.
+    name: doc
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Rust nightly
+        uses: dtolnay/rust-toolchain@nightly
+      - name: Run cargo doc
+        run: cargo doc --no-deps --all-features
+        env:
+          RUSTDOCFLAGS: --cfg docsrs
+  test:
+    runs-on: ${{ matrix.os }}
+    name: test ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, windows-latest]
+    steps:
+      # if your project needs OpenSSL, uncomment this to fix Windows builds.
+      # it's commented out by default as the install command takes 5-10m.
+      # - run: echo "VCPKG_ROOT=$env:VCPKG_INSTALLATION_ROOT" | Out-File -FilePath $env:GITHUB_ENV -Append
+      #   if: runner.os == 'Windows'
+      # - run: vcpkg install openssl:x64-windows-static-md
+      #   if: runner.os == 'Windows'
+      - uses: actions/checkout@v4
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+      # enable this ci template to run regardless of whether the lockfile is checked in or not
+      - name: cargo generate-lockfile
+        if: hashFiles('Cargo.lock') == ''
+        run: cargo generate-lockfile
+      - name: cargo test --locked
+        run: cargo test --locked --all-features --all-targets
+      - name: Cache Cargo dependencies
+        uses: Swatinem/rust-cache@v2

code/tutorials/hello-ratatui/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "hello-ratatui"
+version = "0.1.0"
+authors = ["Josh McKinney <[email protected]>"]
+license = "MIT"
+edition = "2021"
+
+[dependencies]
+color-eyre = "0.6.3"
+crossterm = "0.28.1"
+ratatui = "0.29.0"

code/tutorials/hello-ratatui/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Josh McKinney <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

code/tutorials/hello-ratatui/README.md

@@ -0,0 +1,14 @@
+# hello-ratatui
+
+This is a [Ratatui] app generated by the [Hello World template].
+
+[Ratatui]: https://ratatui.rs
+[Hello World Template]: https://github.com/ratatui/templates/tree/main/hello-world
+
+## License
+
+Copyright (c) Josh McKinney <[email protected]>
+
+This project is licensed under the MIT license ([LICENSE] or <http://opensource.org/licenses/MIT>)
+
+[LICENSE]: ./LICENSE

code/tutorials/hello-ratatui/src/main.rs

@@ -0,0 +1,24 @@
+use color_eyre::Result;
+use crossterm::event::{self, Event};
+use ratatui::{DefaultTerminal, Frame};
+
+fn main() -> Result<()> {
+    color_eyre::install()?;
+    let terminal = ratatui::init();
+    let result = run(terminal);
+    ratatui::restore();
+    result
+}
+
+fn run(mut terminal: DefaultTerminal) -> Result<()> {
+    loop {
+        terminal.draw(render)?;
+        if matches!(event::read()?, Event::Key(_)) {
+            break Ok(());
+        }
+    }
+}
+
+fn render(frame: &mut Frame) {
+    frame.render_widget("hello world", frame.area());
+}

src/content/docs/developer-guide/website.mdx

@@ -86,14 +86,14 @@ Use the `remark-include-code` plugin to include code from a test file:
 
 ````markdown include=ignore
 ```rust
-{{#include @code/tutorials/hello-world/src/main.rs:imports}}
+{{#include @code/tutorials/hello-ratatui/src/main.rs}}
 ```
 ````
 
 This renders as:
 
 ```rust
-{{#include @code/tutorials/hello-world/src/main.rs:imports}}
+{{#include @code/tutorials/hello-ratatui/src/main.rs}}
 ```
 
 ### svgbob

src/content/docs/index.mdx

@@ -9,8 +9,8 @@ hero:
     dark: ../../assets/hero-dark.png
     light: ../../assets/hero-light.png
   actions:
-    - text: Hello World Tutorial
-      link: /tutorials/hello-world
+    - text: Hello Ratatui Tutorial
+      link: /tutorials/hello-ratatui
       icon: right-arrow
       variant: primary
     - text: cargo add ratatui
@@ -59,10 +59,10 @@ import { Card, CardGrid } from "@astrojs/starlight/components";
     <h3>Next Steps</h3>
     <p>
       Get started with Ratatui by following the [installation guide]. If you're already set up, you
-      can jump straight into the [Hello World tutorial].
+      can jump straight into the [Hello Ratatui tutorial].
 
       [installation guide]: installation/
-      [Hello World tutorial]: tutorials/hello-world/
+      [Hello Ratatui tutorial]: tutorials/hello-ratatui/
     </p>
 
   </div>

src/content/docs/tutorials/counter-app/index.md

@@ -4,7 +4,7 @@ sidebar:
   order: 0
 ---
 
-The previous [hello world] tutorial introduced how to create a simple TUI that displayed some text
+The previous [Hello Ratatui] tutorial introduced how to create a simple TUI that displayed some text
 and waited for the user to press a key. This tutorial will cover how to handle state and some more
 complex interactions. You will build a counter application that allows the user to increment and
 decrement a value on the screen.
@@ -16,5 +16,5 @@ When you're finished the application will look like the following:
 The application will render the counter in a [`Paragraph`] widget. When the user presses the left
 and right arrow keys, the application will increment and decrement the value of the counter.
 
-[hello world]: /tutorials/hello-world
+[Hello Ratatui]: /tutorials/hello-ratatui
 [`Paragraph`]: https://docs.rs/ratatui/latest/ratatui/widgets/struct.Paragraph.html