package.json
Your plugin should always contain a package.json file in the root of the plugin folder. This contains key information such as the plugin name, version, description, and plugin type.
Here is the outline of a package.json file:
| Field | Type | Description |
|---|---|---|
| name | string | The name of the plugin, including the "ice-sickle-" prefix |
| title | string | The proper name of the plugin to display to users |
| author | string or array | A string or array of strings listing the author(s) of this plugin; this may be your real name or username |
| version | string | A version number of the form Major.Minor.Patch, which follows semantic versioning |
| description (optional) | string | A short description of the plugin's purpose |
| type | string: "regular" | The type of plugin: only "regular" is supported at this time, although future plugin types are in development |
| main (optional) | string | The main entry point of your plugin code - that is, which file exports the init method (typically you'll call this file index.js) |
Example
{
"name": "ice-sickle-hello-world",
"title": "Hello World",
"author": "ChiefOfGxBxL",
"version": "1.0.5",
"description": "This plugin prints the 'Hello World' string every time a project is opened or saved. Super useful!",
"type": "regular",
"main": "index.js"
}