feat(fmt): dprint for toml, json, md, dockerfile, ts, & yml (#10824)

* feat(fmt): dprint for toml, json, md, dockerfile, ts, & yml

* chore: fmt

Author: o-az

.gitattributes

@@ -4,3 +4,6 @@ testdata/cheats/Vm.sol linguist-generated
 # See <https://git-scm.com/docs/gitattributes#_defining_a_custom_hunk_header>
 *.rs diff=rust
 crates/lint/testdata/* text eol=lf
+
+dprint.json linguist-language=JSON-with-Comments
+.devcontainer/devcontainer.json linguist-language=JSON-with-Comments

.github/PULL_REQUEST_TEMPLATE.md

@@ -31,4 +31,4 @@ the code change.
 
 - [ ] Added Tests
 - [ ] Added Documentation
-- [ ] Breaking changes
+- [ ] Breaking changes

.github/workflows/dependencies.yml

@@ -7,7 +7,7 @@ on:
     # Run weekly
     - cron: "0 0 * * SUN"
   workflow_dispatch:
-    # Needed so we can run it manually
+# Needed so we can run it manually
 
 permissions:
   contents: write

.github/workflows/docker-publish.yml

@@ -40,17 +40,17 @@ jobs:
         if: github.event_name != 'pull_request'
         uses: docker/login-action@v2
         with:
-            registry: ${{ env.REGISTRY }}
-            username: ${{ github.actor }}
-            password: ${{ secrets.GITHUB_TOKEN }}
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
 
       # Extract metadata (tags, labels) for Docker
       # https://github.com/docker/metadata-action
       - name: Extract Docker metadata
         id: meta
         uses: docker/metadata-action@v4
         with:
-            images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
       # Creates an additional 'latest' or 'nightly' tag
       # If the job is triggered via cron schedule, tag nightly and nightly-{SHA}
@@ -59,22 +59,22 @@ jobs:
       - name: Finalize Docker Metadata
         id: docker_tagging
         run: |
-            if [[ "${{ github.event_name }}" == 'schedule' ]]; then
-              echo "cron trigger, assigning nightly tag"
-              echo "docker_tags=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:nightly,${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:nightly-${GITHUB_SHA}" >> $GITHUB_OUTPUT
-            elif [[ "${GITHUB_REF##*/}" == "main" ]] || [[ ${GITHUB_REF##*/} == "master" ]]; then
-              echo "manual trigger from master/main branch, assigning latest tag"
-              echo "docker_tags=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${GITHUB_REF##*/},${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest" >> $GITHUB_OUTPUT
-            else
-              echo "Neither scheduled nor manual release from main branch. Just tagging as branch name"
-              echo "docker_tags=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${GITHUB_REF##*/}" >> $GITHUB_OUTPUT
-            fi
+          if [[ "${{ github.event_name }}" == 'schedule' ]]; then
+            echo "cron trigger, assigning nightly tag"
+            echo "docker_tags=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:nightly,${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:nightly-${GITHUB_SHA}" >> $GITHUB_OUTPUT
+          elif [[ "${GITHUB_REF##*/}" == "main" ]] || [[ ${GITHUB_REF##*/} == "master" ]]; then
+            echo "manual trigger from master/main branch, assigning latest tag"
+            echo "docker_tags=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${GITHUB_REF##*/},${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest" >> $GITHUB_OUTPUT
+          else
+            echo "Neither scheduled nor manual release from main branch. Just tagging as branch name"
+            echo "docker_tags=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${GITHUB_REF##*/}" >> $GITHUB_OUTPUT
+          fi
 
       # Log docker metadata to explicitly know what is being pushed
       - name: Inspect Docker Metadata
         run: |
-            echo "TAGS -> ${{ steps.docker_tagging.outputs.docker_tags }}"
-            echo "LABELS -> ${{ steps.meta.outputs.labels }}"
+          echo "TAGS -> ${{ steps.docker_tagging.outputs.docker_tags }}"
+          echo "LABELS -> ${{ steps.meta.outputs.labels }}"
 
       - name: Build and push foundry image
         run: make DOCKER_IMAGE_NAME=${{ steps.docker_tagging.outputs.docker_tags }} CARGO_TAG_NAME=${{ inputs.tag_name }} PROFILE=maxperf docker-build-push

.github/workflows/nix.yml

@@ -5,7 +5,7 @@ on:
     # Run weekly
     - cron: "0 0 * * SUN"
   workflow_dispatch:
-    # Needed so we can run it manually
+# Needed so we can run it manually
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/release.yml

@@ -158,7 +158,7 @@ jobs:
         shell: bash
         run: |
           set -eo pipefail
-          flags=(--target $TARGET --profile $PROFILE --bins 
+          flags=(--target $TARGET --profile $PROFILE --bins
             --no-default-features --features aws-kms,gcp-kms,cli,asm-keccak)
 
           # `jemalloc` is not fully supported on MSVC or aarch64 Linux.

.gitignore

@@ -7,3 +7,8 @@ out.json
 .vscode
 .claude
 CLAUDE.md
+.env
+node_modules
+dist
+bin
+_

CONTRIBUTING.md

@@ -186,7 +186,7 @@ Be aware that _how_ you communicate requests and reviews in your feedback can ha
 
 ##### Abandoned or stale pull requests
 
-If a pull request appears to be abandoned or stalled, it is polite to first check with the contributor to see if they intend to continue the work before checking if they would mind if you took it over (especially if it just has nits left). When doing so, it is courteous to give the original contributor credit for the work they started, either by preserving their name and e-mail address in the commit log, or by using the `Author: ` or `Co-authored-by: ` metadata tag in the commits.
+If a pull request appears to be abandoned or stalled, it is polite to first check with the contributor to see if they intend to continue the work before checking if they would mind if you took it over (especially if it just has nits left). When doing so, it is courteous to give the original contributor credit for the work they started, either by preserving their name and e-mail address in the commit log, or by using the `Author:` or `Co-authored-by:` metadata tag in the commits.
 
 _Adapted from the [ethers-rs contributing guide](https://github.com/gakonst/ethers-rs/blob/master/CONTRIBUTING.md)_.
 

Dockerfile

@@ -1,6 +1,6 @@
 # syntax=docker/dockerfile:1.4
 
-FROM alpine:3.21 as build-environment
+FROM alpine:3.21 AS build-environment
 
 ARG TARGETARCH
 WORKDIR /opt
@@ -30,7 +30,7 @@ RUN --mount=type=cache,target=/root/.cargo/registry --mount=type=cache,target=/r
     && strip out/chisel \
     && strip out/anvil;
 
-FROM alpine:3.21 as foundry-client
+FROM alpine:3.21 AS foundry-client
 
 RUN apk add --no-cache linux-headers git gcompat libstdc++
 
@@ -43,7 +43,6 @@ RUN adduser -Du 1000 foundry
 
 ENTRYPOINT ["/bin/sh", "-c"]
 
-
 LABEL org.label-schema.build-date=$BUILD_DATE \
       org.label-schema.name="Foundry" \
       org.label-schema.description="Foundry" \

FUNDING.json

@@ -7,4 +7,4 @@
   "opRetro": {
     "projectId": "0x4562c0630907577f433cad78c7e2cc03349d918b6c14ef982f11a2678f5999ad"
   }
-}
+}

Makefile

@@ -133,4 +133,21 @@ deny: ## Perform a `cargo` deny check.
 pr: ## Run all checks and tests.
 	make deny && \
 	make lint && \
-	make test
+	make test
+
+# dprint formatting commands
+.PHONY: dprint-fmt
+dprint-fmt: ## Format code with dprint
+	@if ! command -v dprint > /dev/null; then \
+		echo "Installing dprint..."; \
+		cargo install dprint; \
+	fi
+	dprint fmt
+
+.PHONY: dprint-check
+dprint-check: ## Check formatting with dprint
+	@if ! command -v dprint > /dev/null; then \
+		echo "Installing dprint..."; \
+		cargo install dprint; \
+	fi
+	dprint check

README.md

@@ -115,7 +115,7 @@ _In the above benchmarks, compilation was always skipped_
     <img src=".github/assets/build_benchmark_solady_light.png" width="600px">
   </picture>
 
-  <picture>
+<picture>
     <source media="(prefers-color-scheme: dark)" srcset=".github/assets/build_benchmark_openzeppelin_dark.png" width="600px">
     <img src=".github/assets/build_benchmark_openzeppelin_light.png" width="600px">
   </picture>

crates/cheatcodes/README.md

@@ -26,6 +26,7 @@ The JSON interface is guaranteed to be stable, and can be used by third-party to
 the Foundry cheatcodes externally.
 
 For example, here are some tools that make use of the JSON interface:
+
 - Internally, this is used to generate [a simple Solidity interface](../../testdata/cheats/Vm.sol) for testing
 - Used by [`forge-std`](https://github.com/foundry-rs/forge-std) to generate [user-friendly Solidity interfaces](https://github.com/foundry-rs/forge-std/blob/master/src/Vm.sol)
 - (WIP) Used by [the Foundry book](https://github.com/foundry-rs/book) to generate [the cheatcodes reference](https://book.getfoundry.sh/cheatcodes)

crates/doc/README.md

@@ -14,14 +14,12 @@ In this phase, builder invokes 2 parsers: [solang parser](https://github.com/hyp
 
 Then, builder takes the output of the internal `Parser` and creates documents with additional information: the path of the original item, display identity, the target path where this document will be written.
 
-
 2. Preprocess
 
 The builder accepts an array of preprocessors which can be applied to documents produced in the `Parse` phase. The preprocessors can rearrange and/or change the array as well as modify the separate documents.
 
 At the end of this phase, the builder maintains a possibly modified collection of documents.
 
-
 3. Write
 
-At this point, builder has all necessary information to generate documentation for the source code. It takes every document, formats the source file contents and writes/copies additional files that are required for building documentation.
+At this point, builder has all necessary information to generate documentation for the source code. It takes every document, formats the source file contents and writes/copies additional files that are required for building documentation.

crates/fmt/README.md

@@ -115,7 +115,7 @@ event Greet(string indexed name);
 The formatter supports multiple configuration options defined in `FormatterConfig`.
 
 | Option                       | Default          | Description                                                                                                                                                 |
-|------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ---------------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | line_length                  | 120              | Maximum line length where formatter will try to wrap the line                                                                                               |
 | tab_width                    | 4                | Number of spaces per indentation level                                                                                                                      |
 | bracket_spacing              | false            | Print spaces between brackets                                                                                                                               |
@@ -177,7 +177,7 @@ following process:
 
 1. Preparse comments with config values
 2. Parse and compare the AST for source & expected files.
-    - The `AstEq` trait defines the comparison rules for the AST nodes
+   - The `AstEq` trait defines the comparison rules for the AST nodes
 3. Format the source file and assert the equality of the output with the expected file.
 4. Format the expected files and assert the idempotency of the formatting operation.
 
@@ -190,17 +190,17 @@ Guidelines for contributing to `forge fmt`:
 ### Opening an issue
 
 1. Create a short concise title describing an issue.
-    - Bad Title Examples
-        ```text
-        Forge fmt does not work
-        Forge fmt breaks
-        Forge fmt unexpected behavior
-        ```
-    - Good Title Examples
-        ```text
-        Forge fmt postfix comment misplaced
-        Forge fmt does not inline short yul blocks
-        ```
+   - Bad Title Examples
+     ```text
+     Forge fmt does not work
+     Forge fmt breaks
+     Forge fmt unexpected behavior
+     ```
+   - Good Title Examples
+     ```text
+     Forge fmt postfix comment misplaced
+     Forge fmt does not inline short yul blocks
+     ```
 2. Fill in the issue template fields that include foundry version, platform & component info.
 3. Provide the code snippets showing the current & expected behaviors.
 4. If it's a feature request, specify why this feature is needed.
@@ -217,6 +217,6 @@ Guidelines for contributing to `forge fmt`:
 1. Specify an issue that is being addressed in the PR description.
 2. Add a note on the solution in the PR description.
 3. Provide the test coverage for the new feature. These should include:
-    - Adding malformatted & expected solidity code under `fmt/testdata/$dir/`
-    - Testing the behavior of pre and postfix comments
-    - If it's a new config value, tests covering **all** available options
+   - Adding malformatted & expected solidity code under `fmt/testdata/$dir/`
+   - Testing the behavior of pre and postfix comments
+   - If it's a new config value, tests covering **all** available options

crates/forge/assets/README.md

@@ -4,10 +4,10 @@
 
 Foundry consists of:
 
--   **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
--   **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
--   **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
--   **Chisel**: Fast, utilitarian, and verbose solidity REPL.
+- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
+- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
+- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
+- **Chisel**: Fast, utilitarian, and verbose solidity REPL.
 
 ## Documentation
 

crates/lint/README.md

@@ -7,25 +7,25 @@ It helps enforce best practices and improve code quality within Foundry projects
 
 `forge-lint` includes rules across several categories:
 
-*   **High Severity:**
-    *   `incorrect-shift`: Warns against shift operations where operands might be in the wrong order.
-*   **Medium Severity:**
-    *   `divide-before-multiply`: Warns against performing division before multiplication in the same expression, which can cause precision loss.
-*   **Informational / Style Guide:**
-    *   `pascal-case-struct`: Flags for struct names not adhering to `PascalCase`.
-    *   `mixed-case-function`: Flags for function names not adhering to `mixedCase`.
-    *   `mixed-case-variable`: Flags for mutable variable names not adhering to `mixedCase`.
-    *   `screaming-snake-case-const`: Flags for `constant` variable names not adhering to `SCREAMING_SNAKE_CASE`.
-    *   `screaming-snake-case-immutable`: Flags for `immutable` variable names not adhering to `SCREAMING_SNAKE_CASE`.
-*   **Gas Optimizations:**
-    *   `asm-keccak256`: Recommends using inline assembly for `keccak256` for potential gas savings.
+- **High Severity:**
+  - `incorrect-shift`: Warns against shift operations where operands might be in the wrong order.
+- **Medium Severity:**
+  - `divide-before-multiply`: Warns against performing division before multiplication in the same expression, which can cause precision loss.
+- **Informational / Style Guide:**
+  - `pascal-case-struct`: Flags for struct names not adhering to `PascalCase`.
+  - `mixed-case-function`: Flags for function names not adhering to `mixedCase`.
+  - `mixed-case-variable`: Flags for mutable variable names not adhering to `mixedCase`.
+  - `screaming-snake-case-const`: Flags for `constant` variable names not adhering to `SCREAMING_SNAKE_CASE`.
+  - `screaming-snake-case-immutable`: Flags for `immutable` variable names not adhering to `SCREAMING_SNAKE_CASE`.
+- **Gas Optimizations:**
+  - `asm-keccak256`: Recommends using inline assembly for `keccak256` for potential gas savings.
 
 ## Configuration
 
 The behavior of the `SolidityLinter` can be customized with the following options:
 
 | Option              | Default | Description                                                                                                |
-|---------------------|---------|------------------------------------------------------------------------------------------------------------|
+| ------------------- | ------- | ---------------------------------------------------------------------------------------------------------- |
 | `with_severity`     | `None`  | Filters active lints by their severity (`High`, `Med`, `Low`, `Info`, `Gas`). `None` means all severities. |
 | `with_lints`        | `None`  | Specifies a list of `SolLint` instances to include. Overrides severity filter if a lint matches.           |
 | `without_lints`     | `None`  | Specifies a list of `SolLint` instances to exclude, even if they match other criteria.                     |
@@ -41,16 +41,16 @@ Guidelines for contributing to `forge lint`:
 ### Opening an issue
 
 1. Create a short concise title describing an issue.
-    - Bad Title Examples
-        ```text
-        Forge lint does not work
-        Forge lint breaks
-        Forge lint unexpected behavior
-        ```
-    - Good Title Examples
-        ```text
-        Forge lint does not flag incorrect shift operations
-        ```
+   - Bad Title Examples
+     ```text
+     Forge lint does not work
+     Forge lint breaks
+     Forge lint unexpected behavior
+     ```
+   - Good Title Examples
+     ```text
+     Forge lint does not flag incorrect shift operations
+     ```
 2. Fill in the issue template fields that include foundry version, platform & component info.
 3. Provide the code snippets showing the current & expected behaviors.
 4. If it's a feature request, specify why this feature is needed.

deny.toml

@@ -71,7 +71,7 @@ exceptions = [
     { allow = ["CC0-1.0"], name = "dunce" },
     { allow = ["CC0-1.0"], name = "aurora-engine-modexp" },
 ]
-#copyleft = "deny"
+# copyleft = "deny"
 
 # See note in unicode-ident's readme!
 [[licenses.clarify]]