Tracking PR for v0.5.0 release

.github/workflows/ci.yml

@@ -26,41 +26,3 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: test
-
-  clippy:
-    name: Clippy
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@main
-      - name: Install minimal stable with clippy
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          components: clippy
-          override: true
-
-      - name: Clippy
-        uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-          args: --all -- -D clippy::all -D warnings
-
-  rustfmt:
-    name: rustfmt
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@main
-      - name: Install minimal stable with rustfmt
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          components: rustfmt
-          override: true
-
-      - name: rustfmt
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check

.github/workflows/lint.yml

@@ -0,0 +1,62 @@
+# Runs linting related jobs.
+
+name: lint
+
+# Limits workflow concurrency to only the latest commit in the PR.
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: [main, next]
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  clippy:
+    name: clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@main
+      - uses: Swatinem/rust-cache@v2
+        with:
+          # Only update the cache on push onto the next branch. This strikes a nice balance between
+          # cache hits and cache evictions (github has a 10GB cache limit). 
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
+      - name: Clippy
+        run: |
+          rustup update --no-self-update
+          rustup component add clippy
+          make clippy
+
+  rustfmt:
+    name: rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@main
+      - uses: Swatinem/rust-cache@v2
+        with:
+          # Only update the cache on push onto the next branch. This strikes a nice balance between
+          # cache hits and cache evictions (github has a 10GB cache limit). 
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
+      - name: Rustfmt
+        run: |
+          rustup update --no-self-update nightly
+          rustup +nightly component add rustfmt
+          make format-check
+
+  doc:
+    name: doc
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@main
+      - uses: Swatinem/rust-cache@v2
+        with:
+          # Only update the cache on push onto the next branch. This strikes a nice balance between
+          # cache hits and cache evictions (github has a 10GB cache limit). 
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
+      - name: Build docs
+        run: |
+          rustup update --no-self-update
+          make doc

Makefile

@@ -32,3 +32,14 @@ format-check: ## Run Format using nightly toolchain but only in check mode
 
 .PHONY: lint
 lint: format fix clippy ## Run all linting tasks at once (Clippy, fixing, formatting)
+
+# --- docs ----------------------------------------------------------------------------------------
+
+.PHONY: doc
+doc: ## Generates & checks documentation
+	cargo doc --keep-going --release
+
+
+.PHONY: book
+book: ## Builds the book & serves documentation site
+	mdbook serve --open docs

air-script/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "air-script"
-version = "0.4.0"
+version = "0.5.0"
 description = "AirScript language compiler"
 authors.workspace = true
 readme = "README.md"
@@ -17,15 +17,15 @@ name = "airc"
 path = "src/main.rs"
 
 [dependencies]
-air-codegen-winter = { package = "air-codegen-winter", path = "../codegen/winterfell", version = "0.4" }
-air-ir = { package = "air-ir", path = "../air", version = "0.4" }
-air-parser = { package = "air-parser", path = "../parser", version = "0.4" }
-air-pass = { package = "air-pass", path = "../pass", version = "0.4" }
-clap = { version = "4.2", features = ["derive"] }
+air-codegen-winter = { package = "air-codegen-winter", path = "../codegen/winterfell", version = "0.5" }
+air-ir = { package = "air-ir", path = "../air", version = "0.5" }
+air-parser = { package = "air-parser", path = "../parser", version = "0.5" }
+air-pass = { package = "air-pass", path = "../pass", version = "0.5" }
+clap = { version = "4.5", features = ["derive"] }
 env_logger = "0.11"
 log = { version = "0.4", default-features = false }
 miden-diagnostics = { workspace = true }
-mir = { package = "air-mir", path = "../mir", version = "0.4" }
+mir = { package = "air-mir", path = "../mir", version = "0.5" }
 
 [dev-dependencies]
 expect-test = "1.4"

air-script/src/cli/transpile.rs

@@ -2,7 +2,6 @@ use std::{fs, path::PathBuf, sync::Arc};
 
 use air_ir::{CodeGenerator, CompileError};
 use air_pass::Pass;
-
 use clap::{Args, ValueEnum};
 use miden_diagnostics::{
     CodeMap, DefaultEmitter, DiagnosticsHandler, term::termcolor::ColorChoice,
@@ -37,11 +36,7 @@ pub struct Transpile {
     )]
     output: Option<PathBuf>,
 
-    #[arg(
-        short,
-        long,
-        help = "Defines the target language, defaults to Winterfell"
-    )]
+    #[arg(short, long, help = "Defines the target language, defaults to Winterfell")]
     target: Option<Target>,
 
     #[arg(
@@ -79,7 +74,7 @@ impl Transpile {
                                 .chain(air_ir::passes::BusOpExpand::new(&diagnostics));
                         pipeline.run(ast)
                     })
-            }
+            },
             Pipeline::WithoutMIR => {
                 println!("Transpiling without Mir pipeline...");
                 air_parser::parse_file(&diagnostics, codemap, input_path)
@@ -91,7 +86,7 @@ impl Transpile {
                                 .chain(air_ir::passes::AstToAir::new(&diagnostics));
                         pipeline.run(ast)
                     })
-            }
+            },
         };
 
         match air {
@@ -109,7 +104,7 @@ impl Transpile {
                         let mut path = input_path.clone();
                         path.set_extension(target.extension());
                         path
-                    }
+                    },
                 };
                 let code = backend.generate(&air).expect("code generation failed");
                 if let Err(err) = fs::write(&output_path, code) {
@@ -120,11 +115,11 @@ impl Transpile {
                 println!("============================================================");
 
                 Ok(())
-            }
+            },
             Err(err) => {
                 diagnostics.emit(err);
                 Err("compilation failed".into())
-            }
+            },
         }
     }
 }

air-script/src/main.rs

@@ -1,6 +1,7 @@
-use clap::{Parser, Subcommand};
 use std::io::Write;
 
+use clap::{Parser, Subcommand};
+
 mod cli;
 
 #[derive(Parser)]

air-script/tests/buses/test_air.rs

@@ -51,10 +51,7 @@ impl AirTester for BusesAirTester {
         aux_trace.update_row(length - 2, &[Felt::new(1), Felt::new(0)]);
         let aux_rand_elements = AuxRandElements::new(vec![Felt::new(0); num_rand_values]);
 
-        let aux_trace_with_meta = AuxTraceWithMetadata {
-            aux_trace,
-            aux_rand_elements,
-        };
+        let aux_trace_with_meta = AuxTraceWithMetadata { aux_trace, aux_rand_elements };
         Some(aux_trace_with_meta)
     }
 }

air-script/tests/codegen/winterfell_with_mir.rs

@@ -1,6 +1,7 @@
-use super::helpers::{Pipeline, Target, Test};
 use expect_test::expect_file;
 
+use super::helpers::{Pipeline, Target, Test};
+
 // tests_wo_mir
 // ================================================================================================
 

air-script/tests/codegen/winterfell_wo_mir.rs

@@ -1,6 +1,7 @@
-use super::helpers::{Pipeline, Target, Test};
 use expect_test::expect_file;
 
+use super::helpers::{Pipeline, Target, Test};
+
 // tests_wo_mir
 // ================================================================================================
 

air-script/tests/functions/test_air.rs

@@ -58,9 +58,10 @@ impl AirTester for FunctionsAirTester {
             16, // blowup factor
             0,  // grinding factor
             FieldExtension::None,
-            8,                      // FRI folding factor
-            31,                     // FRI max remainder polynomial degree
-            BatchingMethod::Linear, // method of batching used in computing constraint composition polynomial
+            8,  // FRI folding factor
+            31, // FRI max remainder polynomial degree
+            BatchingMethod::Linear, /* method of batching used in computing constraint
+                 * composition polynomial */
             BatchingMethod::Linear, // method of batching used in computing DEEP polynomial
         )
     }

air-script/tests/helpers/mod.rs

@@ -2,8 +2,9 @@ use winter_air::{BatchingMethod, EvaluationFrame, FieldExtension, ProofOptions,
 use winter_math::fields::f64::BaseElement as Felt;
 use winterfell::{AuxTraceWithMetadata, Trace, TraceTable, matrix::ColMatrix};
 
-/// We need to encapsulate the trace table in a struct to manually implement the `aux_trace_width` method of the `Table` trait.
-/// Otherwise, using only a TraceTable<Felt> will return an `aux_trace_width` of 0 even if we provide a non-empty aux trace in `Trace::validate`,
+/// We need to encapsulate the trace table in a struct to manually implement the `aux_trace_width`
+/// method of the `Table` trait. Otherwise, using only a TraceTable<Felt> will return an
+/// `aux_trace_width` of 0 even if we provide a non-empty aux trace in `Trace::validate`,
 /// and it fails the tests.
 pub struct MyTraceTable {
     pub trace: TraceTable<Felt>,
@@ -62,9 +63,10 @@ pub trait AirTester {
             8,  // blowup factor
             0,  // grinding factor
             FieldExtension::None,
-            8,                      // FRI folding factor
-            31,                     // FRI max remainder polynomial degree
-            BatchingMethod::Linear, // method of batching used in computing constraint composition polynomial
+            8,  // FRI folding factor
+            31, // FRI max remainder polynomial degree
+            BatchingMethod::Linear, /* method of batching used in computing constraint
+                 * composition polynomial */
             BatchingMethod::Linear, // method of batching used in computing DEEP polynomial
         )
     }

air/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "air-ir"
-version = "0.4.0"
+version = "0.5.0"
 description = "Intermediate representation for the AirScript language"
 authors.workspace = true
 readme = "README.md"
@@ -12,9 +12,9 @@ rust-version.workspace = true
 edition.workspace = true
 
 [dependencies]
-air-parser = { package = "air-parser", path = "../parser", version = "0.4" }
-air-pass = { package = "air-pass", path = "../pass", version = "0.4" }
+air-parser = { package = "air-parser", path = "../parser", version = "0.5" }
+air-pass = { package = "air-pass", path = "../pass", version = "0.5" }
 anyhow = { workspace = true }
 miden-diagnostics = { workspace = true }
-mir = { package = "air-mir", path = "../mir", version = "0.4" }
+mir = { package = "air-mir", path = "../mir", version = "0.5" }
 thiserror = { workspace = true }

air/src/graph/mod.rs

@@ -112,14 +112,14 @@ impl AlgebraicGraph {
                     );
                     // the default domain for [IntegrityConstraints] is `EveryRow`
                     Ok((DEFAULT_SEGMENT, ConstraintDomain::EveryRow))
-                }
+                },
                 Value::PublicInput(_) => {
                     assert!(
                         !default_domain.is_integrity(),
                         "unexpected access to public input in integrity constraint"
                     );
                     Ok((DEFAULT_SEGMENT, default_domain))
-                }
+                },
                 Value::TraceAccess(trace_access) => {
                     let domain = if default_domain.is_boundary() {
                         assert_eq!(
@@ -132,7 +132,7 @@ impl AlgebraicGraph {
                     };
 
                     Ok((trace_access.segment, domain))
-                }
+                },
             },
             Operation::Add(lhs, rhs) | Operation::Sub(lhs, rhs) | Operation::Mul(lhs, rhs) => {
                 let (lhs_segment, lhs_domain) = self.node_details(lhs, default_domain)?;
@@ -142,7 +142,7 @@ impl AlgebraicGraph {
                 let domain = lhs_domain.merge(rhs_domain)?;
 
                 Ok((trace_segment, domain))
-            }
+            },
         }
     }
 
@@ -177,23 +177,23 @@ impl AlgebraicGraph {
                 Value::PeriodicColumn(pc) => {
                     cycles.insert(pc.name, pc.cycle);
                     0
-                }
+                },
             },
             Operation::Add(lhs, rhs) => {
                 let lhs_base = self.accumulate_degree(cycles, lhs);
                 let rhs_base = self.accumulate_degree(cycles, rhs);
                 lhs_base.max(rhs_base)
-            }
+            },
             Operation::Sub(lhs, rhs) => {
                 let lhs_base = self.accumulate_degree(cycles, lhs);
                 let rhs_base = self.accumulate_degree(cycles, rhs);
                 lhs_base.max(rhs_base)
-            }
+            },
             Operation::Mul(lhs, rhs) => {
                 let lhs_base = self.accumulate_degree(cycles, lhs);
                 let rhs_base = self.accumulate_degree(cycles, rhs);
                 lhs_base + rhs_base
-            }
+            },
         }
     }
 }