search

jgeewax / phoenix

Open source UI :)
Apache License 2.0
2 stars 3 forks source link

package.json schema #12

Closed stephenplusplus closed 6 years ago

stephenplusplus commented 9 years ago

All plug-ins are hosted on npm, and we will use the package.json to store metadata.

{
  "name": "storage-bucket-explorer",
  "description": "Bucket Explorer is a quick and easy way to preview the files in your GCS buckets",
  "keywords": [
    "gcloud-console", // REQUIRED to be in package discovery page
    "storage",
    "bucket"
  ],
  "main": "index.js", // The entry file that exports the plugin's Angular module
  "files": [
    // What is listed here gets injected into the page
    "index.js",
    "plugin-controller.js",
    "plugin-view.html"
  ],
  "gcloud-console": {
    "name": "Storage Browser" // used for sidebar text / display throughout the console
  }
}
callmehiphop commented 9 years ago

Definitely should be in package.json imo, because for uninstalled plugins we could simply parse the JSON in the plugin explorer (whenever that comes) to display most info about it. Then for installed plugins we would know which files to load when a user requests to view a particular plugin.