Create, validate, and render Heroku app.json manifests
npm install app.jsonapp.json is a manifest format for describing web apps. It's a file in the root
directory of your app that describes build requirements, environment variables, addons,
and other information.
This repository contains the source for an npm module called
app.json, which has many facets:
- A JavaScript interface for creating, validating, and producing app.json manifests.
- A module that is designed to work in browsers and Node.js.
- A command-line interface (CLI) for cloning apps, creating manifests, and producing schema documentation.
For more info about app.json, see
- Introducing the app.json Application Manifest
- app.json Schema
- Setting Up Apps using the Platform API
To use the command line tool, install it globally using npm:
``sh`
npm install app.json --global
Now you can run app.json (or simply app) on the command line.
You can use the CLI to create new Heroku apps from publicly-accessible .tar.gz
or files (colloquially known as "tarballs"), or from GitHub and Bitbucket URLs. The general form is:
`sh`
app.json clone
- repo is required.new-app-name
- is optional.
Here are some examples:
`shGitHub shorthand URL
app.json clone github:zeke/slideshow
$3
The
command will create a new app.json file in your current
working directory. If the directory already has a Heroku git remote in .git/config,
the CLI will attempt to populate the env and addons properties of the new
app.json file with live data from your running Heroku app.`sh
app.json init
`$3
Use the
command to ensure that your app.json file conforms to the
schema.`sh
app.json validate
`$3
Use the
command to fetch the latest addons and env properties from
a running Heroku app.`sh
app.json update
`Programmatic usage with Node.js or Browserify
Download the module from npm and save it to your package.json:
sh
npm install app.json --save
`Require it in your script:
js
var App = require("app.json")
`$3
If browserify isn't your thing, use the pre-compiled browser-ready bundle in
dist/app.json.js. Include this file in your html page and it will create
for you.You can also use Bower if that's your thing:
`sh
bower install app.json
`Schema
The app.json schema is defined using the JSON Schema
specification and is validated with the
revalidator node module. View
the raw schema or the auto-generated app.json
Schema Documentation on Heroku Dev Center.
Class Methods
$3
Instantiate with a JSON filename:
js
var app = App.new(__dirname + "/path/to/app.json")
`Instantiate with a JSON string:
js
var json = "{name: \"small-sharp-tool\", description: \"This app does one little thing, and does it well.\"}"
var app = App.new(json)
`Instantiate with a JavaScript object:
js
var app = App.new({
name: "small-sharp-tool",
description: "This app does one little thing, and does it well."
})
`$3
You can fetch app manifests straight from GitHub or Bitbucket. The
app-json-fetcher service is used
to make the
file downloadable from browsers.url can be a fully qualified repository URL or a shorthand string in the form github:user/repo or bitbucket:user/repojs
App.fetch("github:zeke/slideshow", function(err, manifest) {
console.log(err, manifest)
})
`$3
Generates an example manifest from
properties in the schema.`js
App.example
`Instance Methods
$3
A getter method that validates the app manifest and returns
or false$3
Returns an array of error objects:
js
[
{property: "name", message: "is required"},
{property: "website", message: "is not a valid url"}
]
``If the manifest is valid, an empty array is returned.
Returns a pretty JSON string of the manifest, minus any undocumented properties.
Fetch pricing data about the app's required addons by hitting the Heroku Platform API.
See CONTRIBUTING.md
MIT