primitive-dodoc icon indicating copy to clipboard operation
primitive-dodoc copied to clipboard

Unnecessary doc generation for similarly named contract

Open sebastiantf opened this issue 2 years ago • 0 comments

 // Checks if the documentation has to be generated for this contract
    const includesPath = config.include.some((str) => filePath.includes(str));

The above check in index.ts#L40, seems to be causing a slightly unwanted issue.

If there are two contracts that have the same substring in the contract name, docs are being generated for both contracts, even if I've only included one of them in hre.config.dodoc.include

Eg. contract/ContractName.sol, contracts/test/TestContractName.sol

Docs will be generated for both contracts, even if hre.config.dodoc.include = ['ContractName']

sebastiantf avatar Jun 29 '22 06:06 sebastiantf