Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated the project with Babel 7 and Gulp 4.
- Loading branch information
Showing
30 changed files
with
16,953 additions
and
12,136 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,11 @@ | ||
{ | ||
"presets": [ | ||
["env", { | ||
"targets": { | ||
"browsers": ["last 2 versions", "ie 9"] | ||
}, | ||
"test": { | ||
"plugins": [ "istanbul" ] | ||
} | ||
}] | ||
"@babel/preset-env", | ||
], | ||
"plugins": ["add-module-exports"] | ||
"plugins": ["add-module-exports"], | ||
"env": { | ||
"test": { | ||
"plugins": ["istanbul"] | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,5 @@ | ||
.DS_Store | ||
__trash | ||
_dist | ||
.nyc_output | ||
coverage | ||
docs/_book | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2019 jclo <jclo@mobilabs.fr> (http://www.mobilabs.fr/) | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,167 @@ | ||
# ES6UMD | ||
|
||
[![NPM version][npm-image]][npm-url] | ||
[![Travis CI][travis-image]][travis-url] | ||
[![Test coverage][coveralls-image]][coveralls-url] | ||
[![Dependencies status][dependencies-image]][dependencies-url] | ||
[![Dev Dependencies status][devdependencies-image]][devdependencies-url] | ||
[![License][license-image]](LICENSE.md) | ||
<!--- [![node version][node-image]][node-url] --> | ||
|
||
[![NPM install][npm-install-image]][npm-install-url] | ||
|
||
ES6UMD is a template for writing micro ES6 Javascript libraries that run both on Node.js and the browser. | ||
|
||
ES6UMD uses [Babel](https://babeljs.io) to compile ES6 Javascript code to ES5. It uses [Browserify](http://browserify.org) to bundle all the Javascript files in one Javascript UMD file that can run both on Node.js and the browser. | ||
|
||
ES6UMD uses [Gulp](http://gulpjs.com) for the build. | ||
|
||
ES6UMD relies on [Mocha](https://mochajs.org) and [Chai](http://chaijs.com) for unitary testing. It relies on [Istanbul](https://gotwarlost.github.io/istanbul/) for code coverage. | ||
|
||
ES6UMD uses [Travis CI](https://travis-ci.org) for continuous integration and [Coveralls.io](https://coveralls.io) to display test coverage. | ||
|
||
|
||
## Quick Startup | ||
|
||
You can easily get your first ES6UMD library running in a couple of minutes by just typing a few command lines. But first, you need to create an empty folder. It will contain your library. | ||
|
||
Then, you have to install the `es6umd` package globally. Open a terminal session and type the command line: | ||
|
||
``` | ||
npm install es6umd -g | ||
``` | ||
|
||
Or, if you don't have the rights to install ES6UMD globally, you can install it locally in your project. Open a terminal session, move to your working directory - the empty folder you created - and type the following command line: | ||
|
||
``` | ||
npm install es6umd | ||
``` | ||
|
||
Now populate your empty folder and create your first UMD library with these command lines: | ||
|
||
``` | ||
// populate (// means a comment and not a command line!) | ||
es6umd populate -n myapp | ||
// Or, if you installed the package locally: | ||
./node_modules/es6umd/bin/es6umd.js populate -n <name of your library> | ||
// Install Node.js packages | ||
npm install | ||
``` | ||
|
||
Now your project folder contains the following files: | ||
|
||
``` | ||
Your project Folder | ||
|_ docs // The Gitbook documentation of your project, | ||
|_ lib | ||
| |_ lib.js // Your lib converted by babel and browserify to an ES5 module, | ||
|_ src | ||
| |_ main.js // Your ES6 main library, | ||
| |_ lib.js // A second ES6 library, | ||
|_ tasks | ||
| |_ ... // The Gulp tasks to build your project, | ||
|_ test | ||
| |_ main.js // Your Mocha, Chai test file, | ||
|_ .babelrc // The configuration file for Babel, | ||
|_ .eslintrc // A Configuration file for the ESLint linter tool (if you use it), | ||
|_ .gitignore // Files that Git must ignore (if you use git), | ||
|_ .travis.yml // A configuration file for Travis CI (if you use it), | ||
|_ .CHANGELOG.md // The changes between your different versions, | ||
|_ .gulpfile.js // The main Gulp task, | ||
|_ index.js // The link to your ES6 libraries, | ||
|_ LICENSE.md // The license that applies to your library (here MIT), | ||
|_ package-lock.json // The NPM dependency tree, | ||
|_ package.json // The NPM package file, | ||
|_ README.md // Your README file, | ||
``` | ||
|
||
This project folder is now an NPM package. | ||
|
||
|
||
### How to build it | ||
|
||
Your `package.json` file provides two scripts to build and update your library: | ||
|
||
* `npm run build`, | ||
* `npm run watch`. | ||
|
||
`npm run build` creates a folder `_dist` that contains the Javascript file `<name of your library>.js`. This file is an UMD javascript library that bundles all the es6 files of your project (here index.js, lib/main.js and lib/lib.js). | ||
|
||
`npm run watch` updates on the fly `_dist/<name of your library>.js` each time you modify a Javascript file in your project. | ||
|
||
|
||
## How to test it | ||
|
||
Your `package.json` file contains three scripts to test your UMD library: | ||
|
||
* `npm run test`, | ||
* `npm run check-coverage`, | ||
* `npm run display-coverage`. | ||
|
||
`npm run test` executes the tests and computes the test coverage. | ||
|
||
`npm run check-coverage` checks if the test coverage matches the requirements. Here 100%. | ||
|
||
`npm run display-coverage` opens your browser and reports the test coverage. | ||
|
||
|
||
## How to use it | ||
|
||
On Node.js, your project folder is viewed as a NPM package (usually, it has the same name as your library). Choose a working directory outside your project folder, create a folder `node_modules` and copy your project folder into `node_modules`. Then, on your terminal, type (at your working directory level): | ||
|
||
``` | ||
node | ||
> var MyLib = require('<name of your project folder>'); | ||
undefined | ||
> var mylib = new MyLib(); | ||
undefined | ||
> mylib.getString(); | ||
'I am a string!' | ||
> mylib.getArray(); | ||
[ 1, 2, 3 ] | ||
> | ||
``` | ||
|
||
On the browser, pick-up the Javascript file `_dist/<name of your library>.js` and add it as a script in your HTML file. `<name of your library>.js` is an immediately-invoked function expression. It attaches the `UMDLib` variable to the current context. | ||
|
||
``` | ||
<!DOCTYPE html> | ||
<html> | ||
<body> | ||
<script src="<name of your library>.js"></script> | ||
<script> | ||
var lib = new <name of your library>(); | ||
lib.getString(); | ||
lib.getArray(); | ||
</script> | ||
</body> | ||
</html> | ||
``` | ||
|
||
Enjoy! | ||
|
||
## License | ||
|
||
[MIT](LICENSE.md). | ||
|
||
<!--- URls --> | ||
|
||
[npm-image]: https://img.shields.io/npm/v/es6umd.svg?style=flat-square | ||
[npm-install-image]: https://nodei.co/npm/es6umd.png?compact=true | ||
[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square | ||
[download-image]: https://img.shields.io/npm/dm/es6umd.svg?style=flat-square | ||
[travis-image]: https://img.shields.io/travis/jclo/es6umd.svg?style=flat-square | ||
[coveralls-image]: https://img.shields.io/coveralls/jclo/es6umd/master.svg?style=flat-square | ||
[dependencies-image]: https://david-dm.org/jclo/es6umd/status.svg?theme=shields.io | ||
[devdependencies-image]: https://david-dm.org/jclo/es6umd/dev-status.svg?theme=shields.io | ||
[license-image]: https://img.shields.io/npm/l/es6umd.svg?style=flat-square | ||
|
||
[npm-url]: https://www.npmjs.com/package/es6umd | ||
[npm-install-url]: https://nodei.co/npm/es6umd | ||
[node-url]: http://nodejs.org/download | ||
[download-url]: https://www.npmjs.com/package/es6umd | ||
[travis-url]: https://travis-ci.org/jclo/es6umd | ||
[coveralls-url]: https://coveralls.io/github/jclo/es6umd?branch=master | ||
[dependencies-url]: https://david-dm.org/jclo/es6umd | ||
[devdependencies-url]: https://david-dm.org/jclo/es6umd?type=dev | ||
[license-url]: http://opensource.org/licenses/MIT |
Oops, something went wrong.