1.1.5 • Published 11 months ago

@defi-wonderland/natspec-smells v1.1.5

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

Version License: MIT

Natspec Smells

Just like code, documentation can smell too. Natspec Smells aims to help automatically identify missing or incomplete natspec.

What can it do?

  • Verifies natspec for: constructors, variables, functions, structs, errors, events, modifiers
  • Finds misspelled or missing @param or @return's.
  • Lets you enforce the need for @inheritdoc in public/external functions.
  • Can integrate on your daily workflow, or just as a final check.

No setup usage

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 and exclude options.

Recommended setup

  1. Install the package:

    yarn add --dev @defi-wonderland/natspec-smells
  2. 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',
    };
  3. Run

    yarn natspec-smells

Verify your natspec in CI

Soon to come.

Options

OptionDescriptionRequiredDefault
includeGlob pattern of files to process.Yes
excludeGlob pattern of files to exclude.No""
rootProject root directory.No./
enforceInheritdocTrue if all external and public functions should have @inheritdoc.Notrue
constructorNatspecTrue if the constructor should have natspec.Nofalse

Contributors

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.

1.1.5

11 months ago

1.1.4

12 months ago

1.1.3

1 year ago

1.1.2

1 year ago

1.1.1

1 year ago

1.1.0

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

2 years ago

1.0.0

2 years ago

0.0.0-55e85c10

2 years ago

0.0.0-ffe56082

2 years ago

0.0.0-89043136

2 years ago

0.0.0-5127341

2 years ago

0.0.0-48fe40c9

2 years ago

0.0.0-3ce36657

2 years ago

0.0.0-1b0c8831

2 years ago

0.0.0-dee4f26e

2 years ago

0.0.0-99f83751

2 years ago

0.0.0-da2b9d6a

2 years ago