Like JSDoc, but for bots.
Shigure acts as a pipeline with Readers taking filename as input and outputs a Command. The command can be transformed before passing to a Writer.
npm i -D @shigure/core @shigure/cli
npm i -D @shigure/reader-jsdoc @shigure/writer-json # optional, install if needed// config.js
const { JsdocReader } = require('@shigure/reader-jsdoc')
const { JsonWriter } = require('@shigure/writer-json')
module.exports = {
include: ['commands/*.js'],
exclude: [],
pipeline: [new JsdocReader(), new JsonWriter('doc.json')]
}shigure -c config.js
Currently, JSDoc Reader, JSON Writer and handlebars Writer are available. handlebars is probably flexible enough for most use cases, so I'm not planning to add new Writers.