Just like code, documentation can smell too. Natspec Smells aims to help automatically identify missing or incomplete natspec.
What can it do?
@param
or @return
's.@inheritdoc
in public/external functions.Want to quickly check if your natspec smells?
Just run:
npx @defi-wonderland/natspec-smells --include src --exclude "src/**/*.sol" "(test|scripts)/**/*.sol"
[!NOTE] Remember to put quotes around the glob strings when using the
include
andexclude
options.
Install the package:
yarn add --dev @defi-wonderland/natspec-smells
Create a config file named natspec-smells.config.js
, you can use the following as an example:
/**
* List of supported options: https://github.com/defi-wonderland/natspec-smells?tab=readme-ov-file#options
*/
/** @type {import('@defi-wonderland/natspec-smells').Config} */
module.exports = {
include: 'src/**/*.sol',
exclude: '(test|scripts)/**/*.sol',
};
Run
yarn natspec-smells
Soon to come.
Option | Description | Required | Default |
---|---|---|---|
include |
Glob pattern of files to process. | Yes | |
exclude |
Glob pattern of files to exclude. | No | "" |
root |
Project root directory. | No | ./ |
enforceInheritdoc |
True if all external and public functions should have @inheritdoc. | No | true |
constructorNatspec |
True if the constructor should have natspec. | No | false |
Natspec Smells was built with ❤️ by Wonderland.
Wonderland the largest core development group in web3. Our commitment is to a financial future that's open, decentralized, and accessible to all.
DeFi sucks, but Wonderland is here to make it better.