package.json

The package.json file contains all the basic informations about your modules and allow you to run scripts and add package dependency.

There is some properties from the package.json that are used by Marjory to better understand your module, and we HIGHLY recommend filling them.

package.json
{
  "name": "pancake-api", // The name of the module
  "displayName": "Pancake Factory", // The name that will be displayed to users
  "description": "Module allowing every Marjorians to enjoy pancakes", // The description of your module, also displayed to users
  "version": "1.0.0", // The version of the modules
  "author": "Marjory", // Your company name
  "type": "module", // Mandatory, used for ES6
  
  // Keywords that will be used for the catalog search engine
  "keywords": [
    "pancake",
    "food",
    "module"
  ],
  ...
}

Last updated