PkgFoundry
Catalog npm
PACKAGE EXPLORERView in registry

@0xcompose/sspec

npm

Solidity Smart Contract specification generation tool based on Foundry tests and slang

contractsfoundryslangsmartsolidityspecificationtesting
Versions collected10
Direct dependencies11From release 1.0.9
Last observed20 Oct, 23:03 UTC

README

Current package documentation

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 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.

Installation

Install via npm or yarn:

npm i @0xcompose/sspec --save-dev

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

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 10

Collected releases
VersionPublishedDirect dependenciesOpen version
1.0.9Registry latest14 Apr 202511
1.0.814 Jan 202511
1.0.714 Jan 202511
1.0.68 Jan 202510
1.0.56 Jan 202510
1.0.46 Jan 202510
1.0.36 Jan 202510
1.0.26 Jan 202510
1.0.16 Jan 202510
1.0.06 Jan 202510
Sorted by available source dates · UTC

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 23:03 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:4c0902c101317c9f3a846f6520be6ad6e44479498bc3c1b4b2b83d07c59665f2