{"id":28386980,"url":"https://github.com/0xcompose/sspec","last_synced_at":"2026-05-06T08:31:14.196Z","repository":{"id":269531864,"uuid":"907705821","full_name":"0xcompose/sspec","owner":"0xcompose","description":"Solidity Smart Contract specification generation tool based on Foundry tests and slang","archived":false,"fork":false,"pushed_at":"2025-04-14T10:05:25.000Z","size":219,"stargazers_count":0,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-16T11:50:52.146Z","etag":null,"topics":["ethereum","foundry","linter","slang","smart-contracts","solidity","specification","testing"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0xcompose.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-24T07:36:29.000Z","updated_at":"2025-04-14T10:05:28.000Z","dependencies_parsed_at":null,"dependency_job_id":"ef12ad81-75d6-4304-9f3b-35ca33fb7a5a","html_url":"https://github.com/0xcompose/sspec","commit_stats":null,"previous_names":["0xcompose/spec"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/0xcompose/sspec","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xcompose%2Fsspec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xcompose%2Fsspec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xcompose%2Fsspec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xcompose%2Fsspec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0xcompose","download_url":"https://codeload.github.com/0xcompose/sspec/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xcompose%2Fsspec/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32684586,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-06T02:33:58.958Z","status":"ssl_error","status_checked_at":"2026-05-06T02:33:39.611Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ethereum","foundry","linter","slang","smart-contracts","solidity","specification","testing"],"created_at":"2025-05-30T16:11:49.814Z","updated_at":"2026-05-06T08:31:14.181Z","avatar_url":"https://github.com/0xcompose.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sspec\n\nsspec 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.\n\nThis 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.\n\nThis functionality helps not only with understanding your own test suites, but also with reviewing other repositories.\n\nBuilt using [slang](https://github.com/NomicFoundation/slang).\n\n## Installation\n\nInstall via npm or yarn:\n\n```bash\nnpm i @0xcompose/sspec --save-dev\n```\n\n```bash\nyarn add @0xcompose/sspec --dev\n```\n\n## Foundry Test Naming Conventions\n\nThere are three valid naming conventions for unit testing (according to Foundry best practices):\n\n1. Testing whole contract:\n   - Test file: `SourceContractName.t.sol`\n   - Test contract: `SourceContractNameTest`\n\n2. Testing single function:\n   - Test file: `SourceContractName.sourceFunctionName.t.sol` \n   - Test contract: `SourceFunctionName` (in PascalCase)\n\n3. Testing features:\n   - Test file: `SourceContractName.FeatureName.t.sol`\n   - Test contract: `FeatureName`\n   - Note: Feature can be anything, including integration tests","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xcompose%2Fsspec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0xcompose%2Fsspec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xcompose%2Fsspec/lists"}