Skip to content

Latest commit

 

History

History

tools

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

ReScript Tools

Install

The rescript package provides the rescript-tools executable:

npm install --save-dev rescript

CLI Usage

rescript-tools --help

Generate documentation

Print JSON:

rescript-tools doc src/EntryPointLibFile.res

Write JSON:

rescript-tools doc src/EntryPointLibFile.res > doc.json

Reanalyze

rescript-tools reanalyze --help

Contributor documentation

Decode JSON

RescriptTools.Docgen in the standard library (@rescript/runtime) decodes the JSON that rescript-tools doc prints:

// Read JSON file and parse with `JSON.parseOrThrow`
json->RescriptTools.Docgen.decodeFromJson