chore(vdev): better formatting with nightly features (#23734)

* chore(vdev): better formatting with nightly features

* pass all and add to contributing guide

* currently we only want imports_granularity

* contributing

* PR template improvements

* license building updates

* Update .github/PULL_REQUEST_TEMPLATE.md

Co-authored-by: Thomas <[email protected]>

---------

Co-authored-by: Thomas <[email protected]>

Author: pront

.github/PULL_REQUEST_TEMPLATE.md

@@ -37,14 +37,14 @@ This should help the reviewers give feedback faster and with higher quality. -->
 - Some CI checks run only after we manually approve them.
   - We recommend adding a `pre-push` hook, please see [this template](https://github.com/vectordotdev/vector/blob/master/CONTRIBUTING.md#Pre-push).
   - Alternatively, we recommend running the following locally before pushing to the remote branch:
-    - `cargo fmt --all`
-    - `cargo clippy --workspace --all-targets -- -D warnings`
-    - `cargo nextest run --workspace` (alternatively, you can run `cargo test --all`)
+    - `make fmt`
+    - `make check-clippy` (if there are failures it's possible some of them can be fixed with `make clippy-fix`)
+    - `make test`
 - After a review is requested, please avoid force pushes to help us review incrementally.
   - Feel free to push as many commits as you want. They will be squashed into one before merging.
   - For example, you can run `git merge origin master` and `git push`.
 - If this PR introduces changes Vector dependencies (modifies `Cargo.lock`), please
-  run `cargo vdev build licenses` to regenerate the [license inventory](https://github.com/vectordotdev/vrl/blob/main/LICENSE-3rdparty.csv) and commit the changes (if any). More details [here](https://crates.io/crates/dd-rust-license-tool).
+  run `make build-licenses` to regenerate the [license inventory](https://github.com/vectordotdev/vrl/blob/main/LICENSE-3rdparty.csv) and commit the changes (if any). More details [here](https://crates.io/crates/dd-rust-license-tool).
 
 
 <!--

.rustfmt.toml

@@ -3,7 +3,13 @@ newline_style = "unix"
 reorder_imports = true
 
 # Nightly only features
-# unstable_features = true
-# imports_granularity = "Crate"
+unstable_features = true
+
+# See https://github.com/rust-lang/rustfmt/issues/4991
+imports_granularity = "Crate"
+
+# See https://github.com/rust-lang/rustfmt/issues/5083
 # group_imports = "StdExternalCrate"
+
+# See https://github.com/rust-lang/rustfmt/issues/3346
 # indent_style = "Block"

CONTRIBUTING.md

@@ -130,6 +130,11 @@ You can use the following as a starting point:
 ```shell
 #!/bin/sh
 set -e
+
+echo "Format code"
+
+make fmt
+
 echo "Running pre-push checks..."
 
 # We recommend always running all the following checks.
@@ -298,8 +303,8 @@ cd rust-doc && make docs
 
 ```sh
 cargo install dd-rust-license-tool --locked
-dd-rust-license-tool write
-git commit -am "dd-rust-license-tool write"
+make build-licenses
+git commit -am "updated LICENSE-3rdparty.csv"
 git push
 ```
 
@@ -312,7 +317,7 @@ When deprecating functionality in Vector, see [DEPRECATION.md](docs/DEPRECATION.
 When adding, modifying, or removing a dependency in Vector you may find that you need to update the
 inventory of third-party licenses maintained in `LICENSE-3rdparty.csv`. This file is generated using
 [dd-rust-license-tool](https://github.com/DataDog/rust-license-tool.git) and can be updated using
-`cargo vdev build licenses`.
+`make build-licenses`.
 
 ## Next steps
 

Makefile

@@ -670,10 +670,6 @@ compile-vrl-wasm: ## Compile VRL crates to WASM target
 clean: environment-clean ## Clean everything
 	cargo clean
 
-.PHONY: fmt
-fmt: ## Format code
-	${MAYBE_ENVIRONMENT_EXEC} cargo fmt
-
 .PHONY: generate-kubernetes-manifests
 generate-kubernetes-manifests: ## Generate Kubernetes manifests from latest Helm chart
 	cargo vdev build manifests
@@ -709,3 +705,11 @@ ci-generate-publish-metadata: ## Generates the necessary metadata required for b
 .PHONY: clippy-fix
 clippy-fix:
 	${MAYBE_ENVIRONMENT_EXEC} cargo vdev check rust --fix
+
+.PHONY: fmt
+fmt:
+	${MAYBE_ENVIRONMENT_EXEC} cargo vdev fmt
+
+.PHONY: build-licenses
+build-licenses:
+	${MAYBE_ENVIRONMENT_EXEC} cargo vdev build licenses

docs/DEVELOPING.md

@@ -125,7 +125,7 @@ Loosely, you'll need the following:
 - **To run `make test`:** Install [`cargo-nextest`](https://nexte.st/)
 - **To run integration tests:** Have `docker` available, or a real live version of that service. (Use `AUTOSPAWN=false`)
 - **To run `make check-component-features`:** Have `remarshal` installed.
-- **To run `make check-licenses` or `cargo vdev build licenses`:** Have `dd-rust-license-tool` [installed](https://github.com/DataDog/rust-license-tool).
+- **To run `make check-licenses` or `make build-licenses`:** Have `dd-rust-license-tool` [installed](https://github.com/DataDog/rust-license-tool).
 - **To run `make generate-component-docs`:** Have `cue` [installed](https://cuelang.org/docs/install/).
 
 If you find yourself needing to run something inside the Docker environment described above, that's totally fine, they won't collide or hurt each other. In this case, you'd just run `make environment-generate`.

vdev/src/commands/check/fmt.rs

@@ -10,6 +10,6 @@ pub struct Cli {}
 impl Cli {
     pub fn exec(self) -> Result<()> {
         app::exec::<&str>("scripts/check-style.sh", [], true)?;
-        app::exec("cargo", ["fmt", "--", "--check"], true)
+        app::exec("cargo", ["fmt", "--", "-q", "--check"], true)
     }
 }

vdev/src/commands/fmt.rs

@@ -10,6 +10,7 @@ pub struct Cli {}
 impl Cli {
     pub fn exec(self) -> Result<()> {
         app::exec("scripts/check-style.sh", ["--fix"], true)?;
-        app::exec("cargo", ["fmt"], true)
+        // We are using nightly features in `.rustfmt.toml
+        app::exec("cargo", ["+nightly", "fmt", "--all"], true)
     }
 }