fix: compile contracts before generating docs

[kamuik16]

Motivation

While solving the issue #7331, I tested the forge doc on a sample contract.

Example to reproduce the issue:

// SPDX-License-Identifier: MIT
pragma solidity 0.8.24;

interface IERC20 {
    /**
    * @notice Mints `amount` token to `recipient`.
    * @param  recipient The address of the account receiving minted token.
    * @param  amount    The amount of token to mint.
    */
    function mint(address recipient, uint256 amount) external;
}

contract Test is IERC20 {
    /// @inheritdoc IERC20
    function mint(someType recipient, someType amount) external onlyOwner {}
}

Here you can some issues like someType is not a valid variable type and also onlyOwner isn't defined. But if we run forge doc here, it runs successfully without giving any errors and gives an output like this.

**Parameters**

|Name|Type|Description|
|----|----|-----------|
|`recipient`|`someType`|The address of the account receiving minted token.|
|`amount`|`someType`|   The amount of token to mint.|

You can see in the type someType comes which is not a valid solidity type.

Solution

compile contracts before running forge doc.

If we now run the forge doc, it will give an error of something like this:

[⠒] Compiling...
[⠢] Compiling 1 files with 0.8.24
[⠆] Solc 0.8.24 finished in 25.80ms
Error:
Compiler run failed:
Error (7920): Identifier not found or not unique.
  --> src/Test.sol:15:19:
   |
15 |     function mint(someType recipient, someType amount) external onlyOwner {}
   |                   ^^^^^^^^

[onbjerg]

lgtm

[kamuik16]

lgtm

Hey @onbjerg! I have made this changes, just letting you know.
let compiler = ProjectCompiler::new(); --> let compiler = ProjectCompiler::new().quiet(true); to run the forge compile silently.

[onbjerg]

sgtm

[mattsse]

that makes sense, ty

[MOZGIII]

This broke ignore option as it is not respected when the contract is compiled