https://github.com/shinnn/script-fallback-from-urls

Create script tags to load a JavaScript file safely
https://github.com/shinnn/script-fallback-from-urls

Last synced: 26 days ago
JSON representation

Create script tags to load a JavaScript file safely

• Host: GitHub
• URL: https://github.com/shinnn/script-fallback-from-urls
• Owner: shinnn
• License: mit
• Created: 2014-10-09T01:35:02.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-09-18T16:31:34.000Z (about 8 years ago)
• Last Synced: 2024-10-02T03:07:15.447Z (about 1 month ago)
• Language: JavaScript
• Size: 18.6 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# script-fallback-from-urls

[![NPM version](https://img.shields.io/npm/v/script-fallback-from-urls.svg)](https://www.npmjs.com/package/script-fallback-from-urls)

[![Bower version](https://img.shields.io/bower/v/script-fallback-from-urls.svg)](https://github.com/shinnn/script-fallback-from-urls/releases)

[![Build Status](https://travis-ci.org/shinnn/script-fallback-from-urls.svg?branch=master)](https://travis-ci.org/shinnn/script-fallback-from-urls)

[![Build status](https://ci.appveyor.com/api/projects/status/5m4u2h2ln3qb2mq2?svg=true)](https://ci.appveyor.com/project/ShinnosukeWatanabe/script-fallback-from-urls)

[![Coverage Status](https://coveralls.io/repos/github/shinnn/script-fallback-from-urls/badge.svg?branch=master)](https://coveralls.io/github/shinnn/script-fallback-from-urls?branch=master)

[![dependencies Status](https://david-dm.org/shinnn/script-fallback-from-urls/status.svg)](https://david-dm.org/shinnn/script-fallback-from-urls)

[![devDependencies Status](https://david-dm.org/shinnn/script-fallback-from-urls/dev-status.svg)](https://david-dm.org/shinnn/script-fallback-from-urls?type=dev)

Create HTML tags to load a JavaScript file safely

```javascript

var html = scriptFallbackFromUrls('window.angular', [

  '//ajax.googleapis.com/ajax/libs/angularjs/1.5.7/angular.min.js',

  'path/to/local/angular.min.js'

], {min: false});

console.log(html);

```

yields:

```html

window.angular||document.write('path/to/local/angular.min.js');

```

## Installation

### Package managers

#### [npm](https://www.npmjs.com/)

```

npm i --save script-fallback-from-urls

```

#### [Bower](https://bower.io/)

```

bower i --save script-fallback-from-urls

```

## API

### scriptFallbackFromUrls(*variable*, *urls* [, *option*])

*variable*: `String` (global variable name the library should creates)  

*urls*: array of `String` (URL of CDNs and local copy)  

*option*: `Object`  

Return: `String`

It returns an HTML text of `` tags to load the script with single or multiple fallbacks.

Generated HTML tries to load the script from the URLs in order. If the first URL doesn't provide the global variable you specified — in most case, when the script isn't loaded successfully, it tries to load from the second URL, and so forth.

It is highly recommended that the last URL points at a local copy on your server because it is used as a last resort.

```javascript

scriptFallbackFromUrls('window.THREE', [

  '//ajax.googleapis.com/ajax/libs/threejs/r76/three.min.js',

  '//cdnjs.cloudflare.com/ajax/libs/three.js/r76/three.min.js',

  'path/to/local/three.min.js'

]);

//=> <script src="//ajax.googleapis.com/ajax/libs/threejs/r76/three.min.js">window.THREE||document.write(\'//cdnjs.cloudflare.com/ajax/libs/three.js/r76/three.min.js\')window.THREE||document.write(\'path/to/local/three.min.js\')

```

#### option.min

Type: `Boolean`  

Default: `true`

Adds newlines and semicolons by setting this option `false`.

```javascript

scriptFallbackFromUrls('window.THREE', [

  '//ajax.googleapis.com/ajax/libs/threejs/r76/three.min.js',

  '//cdnjs.cloudflare.com/ajax/libs/three.js/r76/three.min.js',

  'path/to/local/three.min.js'

], {min: false});

/* =>

window.THREE||document.write('//cdnjs.cloudflare.com/ajax/libs/three.js/r76/three.min.js');

window.THREE||document.write('path/to/local/three.min.js');

*/

```

## CLI

You can use this module as a CLI tool by installing it [globally](https://docs.npmjs.com/files/folders#global-installation).

```sh

npm install -g inline-source-map-comment

```

### Usage

```sh

script-fallback-from-urls v1.0.0

Create script tags to load a JavaScript file with single or multiple fallbacks

Usage: script-fallback-from-urls   [ ...] --variable 

--variable, --var, -V  Specify a required global variable

Options:

--no-min,              Do not minify output

--help,            -h  Print usage information

--version,         -v  Print version

```

### Example

```sh

$ script-fallback-from-urls http://d3js.org/d3.v3.min.js path/to/local/d3.v3.min.js --variable d3

> d3||document.write('path/to/local/d3.v3.min.js')

```

## License

Copyright (c) 2014 - 2016 [Shinnosuke Watanabe](https://github.com/shinnn)

Licensed under [the MIT License](./LICENSE).