Skip to content

Instantly share code, notes, and snippets.

@stelcheck
Created April 22, 2017 11:01
Show Gist options
  • Save stelcheck/9d4cc8fe6e86423f892c9eeadaae6d0c to your computer and use it in GitHub Desktop.
Save stelcheck/9d4cc8fe6e86423f892c9eeadaae6d0c to your computer and use it in GitHub Desktop.
An alternative way to document package.json scripts
{
"name": "my-game",
"description": "Super duper",
"version": "0.0.1",
"repository": "...",
"author": "Marc Trudel <mtrudel@...jp>",
"license": "See LICENSE%",
"scripts": {
"help": " echo 'Display help information (this screen)' && npm run",
"mage": " echo 'Run the mage binary' && mage",
"develop": " echo 'Run MAGE in development mode' && npm run mage",
"start": " echo 'Start MAGE as a daemon' && mage start",
"stop": " echo 'Stop the MAGE daemon' && mage stop",
"restart": " echo 'Restart the MAGE daemon' && mage restart",
"reload": " echo 'Reload the MAGE daemon' && mage reload",
"status": " echo 'Check the MAGE daemon status' && mage status"
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment