├── .github ├── pull_request_template.md └── workflows │ ├── canary.yml │ ├── lint.yml │ ├── release.yml │ └── test.yml ├── .gitignore ├── .husky ├── commit-msg └── pre-commit ├── .npmignore ├── .prettierignore ├── .prettierrc ├── LICENSE ├── README.md ├── commitlint.config.js ├── jest.config.js ├── package.json ├── src ├── main.ts ├── processor.ts ├── types.ts ├── utils.ts └── validator.ts ├── test ├── contracts │ ├── BasicSample.sol │ ├── InterfacedSample.sol │ ├── LatestVersion.sol │ ├── LibrarySample.sol │ ├── ParserTest.sol │ ├── ignored-data │ │ └── IgnoredContract.sol │ └── tests │ │ └── BasicTest.t.sol ├── parser.test.ts ├── processor.test.ts ├── utils.test.ts ├── utils │ ├── helpers.ts │ └── mocks.ts └── validator.test.ts ├── tsconfig.json └── yarn.lock /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | # 🤖 Linear 2 | 3 | Closes BES-XXX 4 | -------------------------------------------------------------------------------- /.github/workflows/canary.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/.github/workflows/canary.yml -------------------------------------------------------------------------------- /.github/workflows/lint.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/.github/workflows/lint.yml -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/.github/workflows/release.yml -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/.github/workflows/test.yml -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/.gitignore -------------------------------------------------------------------------------- /.husky/commit-msg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/.husky/commit-msg -------------------------------------------------------------------------------- /.husky/pre-commit: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | . "$(dirname -- "$0")/_/husky.sh" 3 | 4 | npx lint-staged 5 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | .github 2 | .husky 3 | test 4 | -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/.prettierignore -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/.prettierrc -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/LICENSE -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/README.md -------------------------------------------------------------------------------- /commitlint.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { extends: ['@commitlint/config-conventional'] }; 2 | -------------------------------------------------------------------------------- /jest.config.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/jest.config.js -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/package.json -------------------------------------------------------------------------------- /src/main.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/src/main.ts -------------------------------------------------------------------------------- /src/processor.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/src/processor.ts -------------------------------------------------------------------------------- /src/types.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/src/types.ts -------------------------------------------------------------------------------- /src/utils.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/src/utils.ts -------------------------------------------------------------------------------- /src/validator.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/src/validator.ts -------------------------------------------------------------------------------- /test/contracts/BasicSample.sol: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/test/contracts/BasicSample.sol -------------------------------------------------------------------------------- /test/contracts/InterfacedSample.sol: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/test/contracts/InterfacedSample.sol -------------------------------------------------------------------------------- /test/contracts/LatestVersion.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity =0.8.28; 3 | 4 | contract LatestVersion {} 5 | -------------------------------------------------------------------------------- /test/contracts/LibrarySample.sol: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/test/contracts/LibrarySample.sol -------------------------------------------------------------------------------- /test/contracts/ParserTest.sol: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/test/contracts/ParserTest.sol -------------------------------------------------------------------------------- /test/contracts/ignored-data/IgnoredContract.sol: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/test/contracts/ignored-data/IgnoredContract.sol -------------------------------------------------------------------------------- /test/contracts/tests/BasicTest.t.sol: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/test/contracts/tests/BasicTest.t.sol -------------------------------------------------------------------------------- /test/parser.test.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/test/parser.test.ts -------------------------------------------------------------------------------- /test/processor.test.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/test/processor.test.ts -------------------------------------------------------------------------------- /test/utils.test.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/test/utils.test.ts -------------------------------------------------------------------------------- /test/utils/helpers.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/test/utils/helpers.ts -------------------------------------------------------------------------------- /test/utils/mocks.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/test/utils/mocks.ts -------------------------------------------------------------------------------- /test/validator.test.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/test/validator.test.ts -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/tsconfig.json -------------------------------------------------------------------------------- /yarn.lock: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/defi-wonderland/natspec-smells/HEAD/yarn.lock --------------------------------------------------------------------------------