Options
All
  • Public
  • Public/Protected
  • All
Menu

package.json Format

A Hain plugin is just a nodejs module. Plugin configuration is located in the package.json file.

● name: string Plugin name, must be prefixed hain-plugin-
● author: stringobject Plugin Author Name
● version: string Semantic Plugin Version e.g. 'x.y.z'
● dependencies?: string[] If your plugin has external dependencies, include them here. Optional
● hain: object
  ⚪ prefix: string Plugin command prefix which starts with one of ?@=\/#
  ⚪ usage?: string Plugin usage to be displayed with an empty query with your prefix Optional
  ⚪ icon: string Icon URL, see Icon URL Format
  ⚪ redirect?: string Query to redirect user input when user did select intro help Optional
  ⚪ group?: string Default result group name (defaults to name value) Optional
  ⚪ keywords: string[] Add Base API version hain-0.6.0 for sharing your plugin

Example package.json

{
  "name": "hain-plugin-google",
  "author": "Heejin Lee",
  "version": "0.0.1",
  "keywords": [
    "hain-0.6.0"
  ],
  "hain": {
    "prefix": "/g",
    "usage": "type /g something to google it",
    "icon": "#fa fa-google",
    "redirect": "/g "
  }
}

Generated using TypeDoc