/ramda-json-docs-generator

Primary LanguageLiveScript

ramda-docs-json-generator

Parse Ramda source (dist/ramda.js) with JSDoc into JSON.

[
  {
    "description": "Adds two numbers (or strings). Equivalent to `a + b` but curried.",
    "name": "add",
    "sig": "Number -> Number -> Number",
    "category": "Math"
  },
  ...
]

See also: ramda-json-docs, alfred-ramda-workflow

usage

# install deps
npm install -g LiveScript
npm install
./ramda-src-to-json.ls path/to/dist/ramda.js
DEBUG=* GITHUB_TOKEN=deadbeef \
  ./fetch-github-tags.ls 2 outdir

notes

  • Crashes for some reason with node v4, needs 0.12.x.