add basic files

Author: tusharmath

.rustfmt.toml

@@ -0,0 +1,6 @@
+unstable_features = true
+struct_lit_width = 60
+imports_granularity = "Module"
+group_imports = "StdExternalCrate"
+wrap_comments = true
+comment_width = 80

Cargo.lock

@@ -14,3 +14,4 @@ tokio = { version = "1.40.0", features = ["full"] }
 
 [dev-dependencies]
 insta = "1.40.0"
+pretty_assertions = "1.4.1"

workspace/gh-workflow-rs/Cargo.toml

@@ -0,0 +1,18 @@
+name: GitHub Actions Demo
+run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
+on: [push]
+jobs:
+  Explore-GitHub-Actions:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
+      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
+      - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
+      - run: echo "🖥️ The workflow is now ready to test your code on the runner."
+      - name: List files in the repository
+        run: |
+          ls ${{ github.workspace }}
+      - run: echo "🍏 This job's status is ${{ job.status }}."

workspace/gh-workflow-rs/src/extensions.rs

@@ -1,7 +1,4 @@
 pub mod error;
-mod extensions;
-mod runtime;
-pub(crate) mod schema;
 mod toolchain;
-mod worker;
-pub use schema::*;
+pub(crate) mod workflow;
+pub use workflow::*;

workspace/gh-workflow-rs/src/fixtures/ci.yml

@@ -0,0 +1,27 @@
+---
+source: workspace/gh-workflow-rs/src/toolchain.rs
+expression: yml
+---
+name: CI
+on:
+- event: push
+  branches:
+  - main
+- event: pull-request
+  branches:
+  - main
+jobs:
+  build:
+    name: Setup Rust Toolchain
+    runs-on:
+    - linux
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        components: rustfmt, clippy
+        override: 'true'
+    - uses: actions-rs/toolchain@v1
+      with:
+        command: check

workspace/gh-workflow-rs/src/schema.json renamed to workspace/gh-workflow-rs/src/fixtures/schema.json

@@ -0,0 +1,26 @@
+---
+source: workspace/gh-workflow-rs/src/toolchain.rs
+assertion_line: 74
+expression: yml
+---
+name: CI
+run-name: null
+on:
+- event: push
+  branches:
+  - main
+jobs:
+  build:
+    name: Setup Rust Toolchain
+    runs-on:
+    - linux
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions-rs/toolchain@v1
+      with:
+        override: 'true'
+        toolchain: stable
+        components: rustfmt, clippy
+    - uses: actions-rs/toolchain@v1
+      with:
+        command: check

workspace/gh-workflow-rs/src/lib.rs

@@ -0,0 +1,17 @@
+---
+source: workspace/gh-workflow-rs/src/worker.rs
+assertion_line: 106
+expression: generated
+---
+name: Test Workflow
+run-name: null
+on:
+- event: push
+  branches:
+  - main
+jobs:
+  build:
+    runs-on:
+    - windows
+    steps:
+    - run: echo Hello World

workspace/gh-workflow-rs/src/runtime.rs

@@ -0,0 +1,17 @@
+---
+source: workspace/gh-workflow-rs/src/worker.rs
+assertion_line: 98
+expression: generated
+---
+name: Test Workflow
+run-name: null
+on:
+- event: push
+  branches:
+  - main
+jobs:
+  build:
+    runs-on:
+    - windows
+    steps:
+    - run: echo Hello World

workspace/gh-workflow-rs/src/snapshots/gh_workflow_rs__toolchain__tests__to_job.snap

@@ -2,9 +2,14 @@ use std::collections::HashMap;
 
 use derive_setters::Setters;
 
-use crate::schema::*;
+use crate::workflow::*;
 
+///
+/// A type-safe representation of the Rust toolchain.
+/// Instead of writing the github action for Rust by hand, we can use this struct to generate the github action.
+#[derive(Default)]
 pub enum Version {
+    #[default]
     Stable,
     Beta,
     Nightly,
@@ -19,11 +24,11 @@ impl Version {
     }
 }
 
-#[derive(Setters)]
+#[derive(Setters, Default)]
 pub struct RustToolchain {
     version: Version,
-    rust_fmt: bool,
-    rust_clippy: bool,
+    fmt: bool,
+    clippy: bool,
     // TODO: add more rust tool chain components
 }
 
@@ -38,7 +43,10 @@ impl RustToolchain {
                     .uses("actions-rs/toolchain@v1".to_string())
                     .with(HashMap::from([
                         ("toolchain".into(), self.version.to_string()),
-                        ("components".into(), "rustfmt".into()),
+                        (
+                            "components".into(),
+                            vec!["rustfmt", "clippy"].join(", ").into(),
+                        ),
                         ("override".into(), "true".into()),
                     ])),
                 Step::default()
@@ -52,3 +60,20 @@ impl RustToolchain {
         }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use insta::assert_snapshot;
+
+    #[test]
+    fn test_to_job() {
+        let toolchain = RustToolchain::default();
+        let job = toolchain.to_job();
+        let workflow = Workflow::default()
+            .add_job("build".to_string(), job)
+            .unwrap();
+        let yml = serde_yaml::to_string(&workflow).unwrap();
+        assert_snapshot!(yml);
+    }
+}