Skip to content

Commit

Permalink
fix: added final touches
Browse files Browse the repository at this point in the history
  • Loading branch information
0xGorilla committed Jan 13, 2024
1 parent 8904313 commit 55e85c1
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 14 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Want to quickly check if your natspec smells?
Just run:

```
npx @defi-wonderland/natspec-smells --include src --exclude test --exclude scripts
npx @defi-wonderland/natspec-smells --include solidity --exclude solidity/(test|scripts)/**/*.sol
```

## Recommended setup
Expand All @@ -40,8 +40,8 @@ npx @defi-wonderland/natspec-smells --include src --exclude test --exclude scrip

/** @type {import('@defi-wonderland/natspec-smells').Config} */
module.exports = {
include: "src",
exclude: ["tests", "scripts"],
include: "solidity",
exclude: ["solidity/(test|scripts)/**/*.sol"],
};
```

Expand Down Expand Up @@ -71,3 +71,4 @@ Natspec Smells was built with ❤️ by [Wonderland](https://defi.sucks).
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](https://defi.sucks), but Wonderland is here to make it better.
``
9 changes: 0 additions & 9 deletions example-natspec-smells.config.js

This file was deleted.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"license": "MIT",
"author": "Wonderland",
"main": "lib/main.js",
"types": "lib/types.d.ts",
"types": "lib/main.js",
"bin": "./lib/main.js",
"scripts": {
"build": "tsc",
Expand Down
1 change: 0 additions & 1 deletion src/index.d.ts

This file was deleted.

3 changes: 3 additions & 0 deletions src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ import { Processor } from './processor';
import { Config } from './types/config';
import { Validator } from './validator';

// export config for type reference
export { Config } from './types/config';

(async () => {
const config: Config = getArguments();

Expand Down

0 comments on commit 55e85c1

Please sign in to comment.