cdnjs
Version:
Search and URL retrieval from cdnjs
157 lines (114 loc) • 5.36 kB
Markdown
# cdnjs
[](http://travis-ci.org/phuu/cdnjs)
A search and URL retrieval tool for [cdnjs](//cdnjs.com). It can be used globally, on your command line, or as a module.
It powers the [pulldown-api](https://github.com/phuu/pulldown-api).
## Command-line tool
Install `cdnjs` globally:
`npm install -g cdnjs`
### Search
To search cdnjs:
`cdnjs search require`
```
require-cs : //cdnjs.cloudflare.com/ajax/libs/require-cs/0.4.2/cs.js
require-domReady : //cdnjs.cloudflare.com/ajax/libs/require-domReady/2.0.1/domReady.js
require-i18n : //cdnjs.cloudflare.com/ajax/libs/require-i18n/2.0.1/i18n.js
require-jquery : //cdnjs.cloudflare.com/ajax/libs/require-jquery/0.25.0/require-jquery.min.js
require-text : //cdnjs.cloudflare.com/ajax/libs/require-text/2.0.5/text.js
require.js : //cdnjs.cloudflare.com/ajax/libs/require.js/2.1.5/require.min.js
```
### URL
To get a url for a library:
`cdnjs url jquery`
```
jquery : //cdnjs.cloudflare.com/ajax/libs/jquery/1.9.1/jquery.min.js
```
The url method also supports versioning:
`cdnjs url jquery@1.7.1`
```
jquery@1.7.1 : //cdnjs.cloudflare.com/ajax/libs/jquery/1.7.1/jquery.min.js
```
### Default
With only one argument passed, `cdnjs` assumes you want to search.
`cdnjs angular`
```
Unknown method, assuming search.
angular-strap : //cdnjs.cloudflare.com/ajax/libs/angular-strap/0.7.1/angular-strap.min.js
angular-ui-bootstrap : //cdnjs.cloudflare.com/ajax/libs/angular-ui-bootstrap/0.2.0/ui-bootstrap-tpls.min.js
angular-ui : //cdnjs.cloudflare.com/ajax/libs/angular-ui/0.4.0/angular-ui.min.js
angular.js : //cdnjs.cloudflare.com/ajax/libs/angular.js/1.1.1/angular.min.js
```
## Module
`cdnjs` can also be used as a module. The methods are roughly the same.
### Install
Install via npm:
`npm install cdnjs`
### Search
Search `cdnjs` for a given identifier:
```javascript
var cdnjs = require('cdnjs'),
util = require('util');
cdnjs.search('angular', function (err, packages) {
console.log(util.inspect(packages, {
depth: null,
colors: true
}));
});
/*
[ { name: 'angular-strap',
url: '//cdnjs.cloudflare.com/ajax/libs/angular-strap/0.7.3/angular-strap.min.js',
versions:
{ '0.7.3': '//cdnjs.cloudflare.com/ajax/libs/angular-strap/0.7.3/angular-strap.min.js',
... } },
{ name: 'angular-ui-bootstrap',
url: '//cdnjs.cloudflare.com/ajax/libs/angular-ui-bootstrap/0.2.0/ui-bootstrap-tpls.min.js',
versions: { '0.2.0': '//cdnjs.cloudflare.com/ajax/libs/angular-ui-bootstrap/0.2.0/ui-bootstrap-tpls.min.js' } },
{ name: 'angular-ui',
url: '//cdnjs.cloudflare.com/ajax/libs/angular-ui/0.4.0/angular-ui.min.js',
versions: { '0.4.0': '//cdnjs.cloudflare.com/ajax/libs/angular-ui/0.4.0/angular-ui.min.js' } },
{ name: 'angular.js',
url: '//cdnjs.cloudflare.com/ajax/libs/angular.js/1.1.3/angular.min.js',
versions:
{ '1.1.3': '//cdnjs.cloudflare.com/ajax/libs/angular.js/1.1.3/angular.min.js',
'1.1.1': '//cdnjs.cloudflare.com/ajax/libs/angular.js/1.1.1/angular.min.js',
... } },
... ]
*/
```
### URL
Grab a URL for a specific package (it supports versions too):
```javascript
var cdnjs = require('cdnjs'),
util = require('util');
cdnjs.url('angular.js', function (err, packages) {
console.log(util.inspect(packages, {
depth: null,
colors: true
}));
});
/*
{ name: 'angular.js',
url: '//cdnjs.cloudflare.com/ajax/libs/angular.js/1.1.3/angular.min.js',
versions:
{ '1.1.3': '//cdnjs.cloudflare.com/ajax/libs/angular.js/1.1.3/angular.min.js',
'1.1.1': '//cdnjs.cloudflare.com/ajax/libs/angular.js/1.1.1/angular.min.js',
... } }
*/
cdnjs.url('angular.js@1.0.0', function (err, packages) {
console.log(util.inspect(packages, {
depth: null,
colors: true
}));
});
/*
{ name: 'angular.js@1.0.0',
url: '//cdnjs.cloudflare.com/ajax/libs/angular.js/1.0.0/angular.min.js',
versions:
{ '1.1.3': '//cdnjs.cloudflare.com/ajax/libs/angular.js/1.1.3/angular.min.js',
'1.1.1': '//cdnjs.cloudflare.com/ajax/libs/angular.js/1.1.1/angular.min.js',
... } }
*/
```
## License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.