https://github.com/0xcompose/sspec
Solidity Smart Contract specification generation tool based on Foundry tests and slang
https://github.com/0xcompose/sspec
ethereum foundry linter slang smart-contracts solidity specification testing
Last synced: 2 months ago
JSON representation
Solidity Smart Contract specification generation tool based on Foundry tests and slang
- Host: GitHub
- URL: https://github.com/0xcompose/sspec
- Owner: 0xcompose
- Created: 2024-12-24T07:36:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-14T10:05:25.000Z (about 1 year ago)
- Last Synced: 2025-07-16T11:50:52.146Z (12 months ago)
- Topics: ethereum, foundry, linter, slang, smart-contracts, solidity, specification, testing
- Language: TypeScript
- Homepage:
- Size: 214 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sspec
sspec comes from `Solidity SPECification`. Smart contract repositories often lack detailed or even general descriptions of what the repo and its smart contracts do. Only AIs can understand what's going on (not always). This tool was created to improve development and review simplicity.
This is a reimagining of [`scopelint`'s](https://github.com/ScopeLift/scopelint) `spec` command, which generates specifications for source smart contracts based on test files and test names.
This functionality helps not only with understanding your own test suites, but also with reviewing other repositories.
Built using [slang](https://github.com/NomicFoundation/slang).
## Installation
Install via npm or yarn:
```bash
npm i @0xcompose/sspec --save-dev
```
```bash
yarn add @0xcompose/sspec --dev
```
## Foundry Test Naming Conventions
There are three valid naming conventions for unit testing (according to Foundry best practices):
1. Testing whole contract:
- Test file: `SourceContractName.t.sol`
- Test contract: `SourceContractNameTest`
2. Testing single function:
- Test file: `SourceContractName.sourceFunctionName.t.sol`
- Test contract: `SourceFunctionName` (in PascalCase)
3. Testing features:
- Test file: `SourceContractName.FeatureName.t.sol`
- Test contract: `FeatureName`
- Note: Feature can be anything, including integration tests