Security News
Meet Socket at BlackHat and DEF CON in Las Vegas
Come meet the Socket team at BlackHat and DEF CON! We're sponsoring some fun networking events and we would love to see you there.
@firebolt-js/openrpc
Advanced tools
Readme
Tools to enable consistent Firebolt SDK and document generation.
npm install
.src/cli.js
. See below for arguments.Alternatively, you may install globally using npm install -g @firebolt-js/openrpc
, which will install the cli and add it to your $PATH so it may be invoked with the firebolt-openrpc
command.
Firebolt OpenRPC Tools require Node 16.
--task
: Tell the tool what you want it to do. Options are:
sdk
: Generate the SDKdocs
: Generate the docsopenrpc
: Generate the openrpcvalidate
Validate the openrpc--source
: The relative or absolute path to the folder or file that the task will use.
--template
: The relative or absolute path to the folder or file containing template resources for the task.
--output
: The relative or absolute path to the folder or file that will hold the task's generated output.
--as-path
: Used by the document generator. This is a toggle for generating content as files vs folders. More info below in Document Generation.
--static-modules
: String. Used by the SDK generator. "Static modules" are modules without an OpenRPC json document. More on this below.
Indicated by --task sdk
. Generate the Firebolt SDKs from an OpenRPC spec. Currently, only the JavaScript SDK is supported.
Static modules are modules without a corresponding OpenRPC json document. It will be included statically from the location supplied by the --template
option. Listing your module in the --static-modules
property ensures that it is properly exported by the SDK and wires up mock responses as well.
Indicated by --task docs
. Generate markdown docs from the OpenRPC spec.
When deploying docs to web servers, --as-path
is generally used. For deploying to GitHub pages/wikis, do not use --as-path
.
This toggle will generate content as files vs folders. For exmaple, this:
/docs/Topic.md
vs
/docs/Topic/index.md
It affects the output of:
Indicated by --task openrpc
. Assembles a corpus of individual OpenRPC documents into a single OpenRPC document.
Module.listen('eventName')
Indicated by --task validate
. Reads and validates a corpus of individual OpenRPC documents and validates the result of assembling them together into a single OpenRPC document.
Don't feel like typing? Use -t
instead of --task
. This table shows the mapping:
shorthand | command |
---|---|
-t | --task |
-s | --source |
-tm | --template |
-o | --output |
-ap | --as-path |
-sm | --static-modules |
FAQs
The Firebolt SDK Code & Doc Generator
We found that @firebolt-js/openrpc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Come meet the Socket team at BlackHat and DEF CON! We're sponsoring some fun networking events and we would love to see you there.
Security News
Learn how Socket's 'Non-Existent Author' alert helps safeguard your dependencies by identifying npm packages published by deleted accounts. This is one of the fastest ways to determine if a package may be abandoned.
Security News
In July, the Python Software Foundation mounted a quick response to address a leaked GitHub token, elected new board members, and added more members to the team supporting PSF and PyPI infrastructure.