bower.json Format

Example bower.json

{
  "name": "rainbows",
  "description": "Description of my minetest mod.",
  "keywords": [
    "rainbows"
  ],
  "homepage": "http://example.com/",
  "forum": "https://forum.minetest.net/viewtopic.php?id=1",
  "screenshots": [
    "http://example.com/screenshot.png"
  ],
  "authors": [
    "Author <author@example.com>"
  ],
  "license": "WTFPL",
  "dependencies": {
    "some_mod": "~1.2.3",
    "another_mod": "~4.2.11"
  },
  "ignore": [
    "**/.*",
    "mods",
    "test"
  ]
}

Specifications

name

Required

Type: String

The name of the package as stored in the registry.

description

Recommended

Type: String

Any character. Max 140.

Help users identify and search for your package with a brief description. Describe what your package does, rather than what it's made of. Will be displayed in search/lookup results on the CLI and the website that can be used to search for packages.

keywords

Recommended

Type: Array of String

Same format requirements as name.

Used for search by keyword. Helps make your package easier to discover without people needing to know its name.

homepage

Recommended

Type: String

URL to learn more about the package. Falls back to GitHub/BitBucket project if not specified and it's a GitHub or BitBucket endpoint.

forum

Recommended

Type: String

URL to discuss the package.

screenshots

Recommended

Type: Array of String

Used to display screenshots of your package.

authors

Recommended

Type: Array of (String or Object)

A list of people that authored the contents of the package.

Either:

"authors": [
    "John Doe",
    "John Doe <john@doe.com>",
    "John Doe <john@doe.com> (http://johndoe.com)"
]

or:

"authors": [
    { "name": "John Doe" },
    { "name": "John Doe", "email": "john@doe.com" },
    { "name": "John Doe", "email": "john@doe.com", "homepage": "http://johndoe.com" }
]

license

Recommended

Type: String or Array of String

SPDX license identifier or path/url to a license.

dependencies

Optional

Type: Object

Dependencies are specified with a simple hash of package name to a semver compatible identifier or URL.

ignore

Recommended

Type: Array of String

A list of files for Bower to ignore when installing your package.

Note: symbolic links will always be ignored. However `bower.json` will never be ignored.

The ignore rules follow the same rules specified in the gitignore pattern spec.