Feature Request: support solidity comment removal

[stevennevins]

Repomix supports removing comments from a range of languages but solidity isn't a support language currently

I found the query for solidity's tree sitter definitions

https://github.com/Aider-AI/aider/blob/main/aider/queries/tree-sitter-language-pack/solidity-tags.scm

[yamadashy]

@stevennevins
Thank you for the suggestion and sharing the Solidity query!

Currently, we actually handle comment removal with our own custom logic rather than relying on tree-sitter.

I’ll work on supporting both comment removal and compression for Solidity.

[yamadashy]

@stevennevins
This has been released in v0.3.1!
https://github.com/yamadashy/repomix/releases/tag/v0.3.1

Feel free to share any questions or feedback you might have.

[stevennevins]

thanks! I tested the latest version. When removing natspec comments, I noticed that it leaves whitespace (not sure if that's intentional). I'll probably use with the --remove-empty-lines option anyway, so nbd if you think the behavior is sufficient as is

here is an example:

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.13;

/**
 * @title A simple counter contract
 * @author The Author
 * @notice This contract implements a basic counter with increment and set functionality
 * @dev This is a demonstration of NatSpec documentation
 */
contract Counter {
    /**
     * @notice The current counter value
     * @dev Stored as uint256 to handle large numbers
     */
    uint256 public number;

     // @notice Sets the counter to a new value
     // @dev Updates the number state variable directly
     // @param newNumber The new value to set the counter to
    function setNumber(uint256 newNumber) public {
        number = newNumber;
    }

     /// @notice Increments the counter by 1
     /// @dev Uses the increment operator
    function increment() public {
        number++;
    }
}

Expected output:

pragma solidity ^0.8.13;

contract Counter {
    uint256 public number;

    function setNumber(uint256 newNumber) public {
        number = newNumber;
    }

    function increment() public {
        number++;
    }
}

[stevennevins]

This was the output

pragma solidity ^0.8.13;







contract Counter {




    uint256 public number;




    function setNumber(uint256 newNumber) public {
        number = newNumber;
    }



    function increment() public {
        number++;
    }
}

[yamadashy]

@stevennevins
Thank you for testing and providing detailed feedback!

You're right about the current behavior.
I should be able to fix this by adjusting the parameters in strip-comments.
I'll make some adjustments to improve this.