Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bowerrc docs #34

Closed
paulirish opened this issue Apr 14, 2014 · 2 comments
Closed

bowerrc docs #34

paulirish opened this issue Apr 14, 2014 · 2 comments
Assignees

Comments

@paulirish
Copy link
Member

Here's the import from gdocs:

The Bower configuration alters the behaviour of Bower on the local system.

The config is obtained by merging multiple configurations by this order of 
importance:

* [cli args via --config.*]
* environment variables
* local bowerrc located in the cwd
* all bowerrc files upwards the directory tree
* bowerrc file located in the home folder
* bowerrc file located in the global folder

Example of valid environment variables:

* `bower_endpoint_parser` is evaluated as `endpoint-parser`
* `bower_storage__cache` is evaluated as `storage.cache`

The bowerrc file mentioned must be a JSON valid file.

## cwd [string]

The directory from which bower should run. All relative paths will be calculated 
according to this setting.  

## directory [string]

The path in which installed components should be saved. If not specified this 
defaults to `bower_components`.  

## registry [object string]

The registry config. Can be an object or a string. If a string is used, all the 
property values bellow will have its value. Defaults to the bower registry URL.

If your organization wishes to maintain a private registry, you may change the 
values below.

## registry.search [array string]

An array of URLs pointing to read-only Bower registries. A string means only 
one. When looking into the registry for an endpoint, Bower will query these 
registries by the specified order.

**registry.register [string]**

The URL to use when registering packages. 

**registry.publish [string]**

The URL to use when publish packages.  


## shorthand-resolver [string]

Define a custom template for shorthand package names.  
Defaults to git://github.com/{{owner}}/{{package}}.git

The `shorthand-resolver` key provides support for defining a custom template 
which Bower uses when constructing a URL for a given shorthand. For example, if 
a shorthand of `twitter/flight` or `twitter/flight#v1.0.0` is specified in the 
package's manifest dependencies, the following data can be referenced from 
within the `shorthand-resolver` template:

owner: "twitter"  
package: "flight"  
shorthand: "twitter/flight"

Examples:

    "shorthand-resolver": "git://example.com/{{owner}}/components/{{package}}.git"
    "shorthand-resolver": "git://example.com/{{shorthand}}.git"

**proxy [string]**

The proxy to use for http requests.

**https-proxy [string]**

The proxy to use for https requests.

**user-agent [string]**

Sets the User-Agent for each request made.  
Defaults to: node/{process.version} {process.platform} {process.arch}

**timeout [****number****]**

The timeout to be used when making requests in milliseconds, defaults to 
60000ms.

**strict-ssl [boolean]**

Whether or not to do SSL key validation when making requests via https.

**ca [object string****]**

The CA certificates to be used, defaults to null. This is similar to the 
registry key, specifying each CA to use for each registry endpoint.

The Certificate Authority signing certificate that is trusted for SSL 
connections to the registry.  
Set to null to only allow "known" registrars, or to a specific CA cert to trust 
only that specific signing authority.

**color [boolean]**

Enable or disable use of colors in the CLI output. Defaults to true.

**storage**** [object]**

Where to store persistent data, such as cache, needed by bower. Defaults to 
paths that suite the OS/platform. Valid keys are `cache`, `registry`, `links`, 
`completion`.

**tmp [string]**

Where to store temporary files and folders. Defaults to the system temporary 
directory suffixed with /bower.

**interactive ****[boolean]**

Makes bower interactive, prompting whenever necessary. Defaults to `null` which 
means `auto`.
@paulirish
Copy link
Member Author

After added to bower.io let's link to it from bower/bower/readme

@desandro
Copy link
Member

Now up in Configuration. Fixed in #42

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants