Merge branch 'main' into feat/new-config

defi-wonderland · Mar 4, 2024 · f87aca4 · f87aca4
2 parents 406735d + a3b3ede
commit f87aca4
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ Want to quickly check if your natspec smells?
 Just run:
 
 ```
-npx @defi-wonderland/natspec-smells --include src --exclude "src/**/*.sol" "(test|scripts)/**/*.sol"
+npx @defi-wonderland/natspec-smells --include "src/**/*.sol" --exclude "(test|scripts)/**/*.sol"
 ```
 
 > [!NOTE]

diff --git a/src/validator.ts b/src/validator.ts
@@ -46,7 +46,7 @@ export class Validator {
 
     // Validate natspec for the constructor only if configured
     if (matchesFunctionKind(node, 'constructor')) {
-      return this.config.constructorNatspec ? this.validateParameters(node as FunctionDefinition, natspecParams) : [];
+      return this.config.functions?.constructor ? this.validateParameters(node as FunctionDefinition, natspecParams) : [];
     }
 
     // Inheritdoc is not enforced nor present, and there is no other documentation, returning error

diff --git a/test/utils/helpers.ts b/test/utils/helpers.ts
@@ -1,5 +1,4 @@
 import { ASTKind, ASTReader, SourceUnit, compileSol } from 'solc-typed-ast';
-import path from 'path';
 import { Functions, NodeToProcess } from '../../src/types';
 
 export async function getFileCompiledSource(filePath: string): Promise<SourceUnit> {

diff --git a/test/validator.test.ts b/test/validator.test.ts
@@ -377,7 +377,7 @@ describe('Validator', () => {
 
   describe('with disabled constructor natspec', () => {
     beforeAll(async () => {
-      validator = new Validator(mockConfig({ constructorNatspec: false }));
+      validator = new Validator(mockConfig({ constructorNatspec: true }));
     });
 
     it('should ignore missing constructor natspec', () => {