{"_id":"6to5-library-boilerplate","_rev":"9-b79c8204fb79aed4ea5b3fc2dce1dbae","name":"6to5-library-boilerplate","description":"Author libraries in ES6 for Node and the browser.","dist-tags":{"latest":"2.1.0"},"versions":{"1.1.2":{"name":"6to5-library-boilerplate","version":"1.1.2","description":"Author libraries in ES6 for Node and the browser.","main":"dist/library-dist.js","scripts":{"test":"gulp"},"repository":{"type":"git","url":"https://github.com/6to5/6to5-boilerplate.git"},"keywords":["boilerplate","es6","node","starter","kit","transpile","6to5"],"author":{"name":"Jmeas"},"license":"MIT","bugs":{"url":"https://github.com/6to5/6to5-boilerplate/issues"},"homepage":"https://github.com/6to5/6to5-boilerplate","devDependencies":{"6to5":"^3.3.3","browserify":"^8.1.1","chai":"^1.10.0","del":"^1.1.1","esperanto":"^0.6.7","gulp":"^3.8.10","gulp-6to5":"^3.0.0","gulp-file":"^0.2.0","gulp-filter":"^2.0.0","gulp-istanbul":"^0.6.0","gulp-jshint":"^1.9.0","gulp-livereload":"^3.4.0","gulp-load-plugins":"^0.8.0","gulp-mocha":"^2.0.0","gulp-notify":"^2.1.0","gulp-plumber":"^0.6.6","gulp-rename":"^1.2.0","gulp-sourcemaps":"^1.3.0","gulp-uglifyjs":"^0.5.0","isparta":"^1.0.1","jshint-stylish":"^1.0.0","mocha":"^2.1.0","run-sequence":"^1.0.2","sinon":"^1.12.2","sinon-chai":"^2.6.0","vinyl-source-stream":"^1.0.0"},"gitHead":"899f45484260381613778be217fd0bb1c718b4d6","_id":"6to5-library-boilerplate@1.1.2","_shasum":"1c5569a20fdf1fe1bff662a348216538e3fdfac9","_from":".","_npmVersion":"2.4.1","_nodeVersion":"0.10.13","_npmUser":{"name":"jmeas","email":"jellyes2@gmail.com"},"maintainers":[{"name":"jmeas","email":"jellyes2@gmail.com"}],"dist":{"shasum":"1c5569a20fdf1fe1bff662a348216538e3fdfac9","tarball":"https://registry.npmjs.org/6to5-library-boilerplate/-/6to5-library-boilerplate-1.1.2.tgz","integrity":"sha512-4j67UC54pYm/FKz54Kefs91/gxDGwqPwKcHA3FxdCr6rmDfUfHyjW2uNaZzSSwWX96I8fgyBzW2QiyRO+Tjm7A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDgwAO7/KEoovLQoN9nRil20iMd6VFtRf2nX3buwwXboQIgTcGNjGjvC8M9Cqe4BDaUrWRmpoMP7h+2DdCs4LZHycU="}]},"deprecated":"Use babel-library-boilerplate."},"2.0.0":{"name":"6to5-library-boilerplate","version":"2.0.0","description":"Author libraries in ES6 for Node and the browser.","main":"dist/library-dist.js","scripts":{"test":"gulp","test-browser":"gulp test-browser","build":"gulp build","coverage":"gulp coverage"},"repository":{"type":"git","url":"https://github.com/6to5/6to5-library-boilerplate.git"},"keywords":["boilerplate","es6","node","starter","kit","transpile","6to5"],"author":{"name":"Jmeas"},"license":"MIT","bugs":{"url":"https://github.com/6to5/6to5-library-boilerplate/issues"},"homepage":"https://github.com/6to5/6to5-library-boilerplate","devDependencies":{"6to5":"^3.3.3","browserify":"^8.1.1","chai":"^1.10.0","del":"^1.1.1","esperanto":"^0.6.7","gulp":"^3.8.10","gulp-6to5":"^3.0.0","gulp-file":"^0.2.0","gulp-filter":"^2.0.0","gulp-istanbul":"^0.6.0","gulp-jshint":"^1.9.0","gulp-livereload":"^3.4.0","gulp-load-plugins":"^0.8.0","gulp-mocha":"^2.0.0","gulp-notify":"^2.1.0","gulp-plumber":"^0.6.6","gulp-rename":"^1.2.0","gulp-sourcemaps":"^1.3.0","gulp-uglifyjs":"^0.5.0","isparta":"^1.0.1","jshint-stylish":"^1.0.0","mocha":"^2.1.0","run-sequence":"^1.0.2","sinon":"^1.12.2","sinon-chai":"^2.6.0","vinyl-source-stream":"^1.0.0"},"to5BoilerplateOptions":{"destinationFolder":"dist","exportFileName":"library-dist","entryFileName":"index","exportVarName":"MyLibrary","mochaGlobals":["stub","spy","expect"]},"gitHead":"d7472e0c49fa8743d3666427406ac0677ae87104","_id":"6to5-library-boilerplate@2.0.0","_shasum":"fe93b740f393b07f31a93b49419bb28d296d19ba","_from":".","_npmVersion":"2.4.1","_nodeVersion":"0.10.13","_npmUser":{"name":"jmeas","email":"jellyes2@gmail.com"},"maintainers":[{"name":"jmeas","email":"jellyes2@gmail.com"}],"dist":{"shasum":"fe93b740f393b07f31a93b49419bb28d296d19ba","tarball":"https://registry.npmjs.org/6to5-library-boilerplate/-/6to5-library-boilerplate-2.0.0.tgz","integrity":"sha512-5AUr3mFExxliW0hqwQpffLby9rdfNbRWb7eHLmRZOPUVdC8dy7yVjZMxXztMx7zTL3pzWnsGd02BqYnX5klAtA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBxgBz5mAcSmGhoz/YwkFlUO3AR51risvKvza8ucWEKfAiEAlcm7cXDOGri0eO8mMKvxO7j+2k2tdjRmuerTD4FQ6ug="}]},"deprecated":"Use babel-library-boilerplate."},"2.1.0":{"name":"6to5-library-boilerplate","version":"2.1.0","description":"Author libraries in ES6 for Node and the browser.","main":"dist/library-dist.js","scripts":{"test":"gulp","test-browser":"gulp test-browser","build":"gulp build","coverage":"gulp coverage"},"repository":{"type":"git","url":"https://github.com/6to5/6to5-library-boilerplate.git"},"keywords":["boilerplate","es6","node","starter","kit","transpile","6to5"],"author":{"name":"Jmeas"},"license":"MIT","bugs":{"url":"https://github.com/6to5/6to5-library-boilerplate/issues"},"homepage":"https://github.com/6to5/6to5-library-boilerplate","devDependencies":{"6to5":"^3.3.3","6to5ify":"^4.1.1","browserify":"^8.1.1","chai":"^1.10.0","del":"^1.1.1","esperanto":"^0.6.7","glob":"^4.3.5","gulp":"^3.8.10","gulp-6to5":"^3.0.0","gulp-file":"^0.2.0","gulp-filter":"^2.0.0","gulp-istanbul":"^0.6.0","gulp-jscs":"^1.4.0","gulp-jshint":"^1.9.0","gulp-livereload":"^3.4.0","gulp-load-plugins":"^0.8.0","gulp-mocha":"^2.0.0","gulp-notify":"^2.1.0","gulp-plumber":"^0.6.6","gulp-rename":"^1.2.0","gulp-sourcemaps":"^1.3.0","gulp-uglifyjs":"^0.6.0","isparta":"^1.0.1","jshint-stylish":"^1.0.0","mkdirp":"^0.5.0","mocha":"^2.1.0","run-sequence":"^1.0.2","sinon":"^1.12.2","sinon-chai":"^2.6.0","vinyl-source-stream":"^1.0.0"},"to5BoilerplateOptions":{"entryFileName":"index","exportVarName":"MyLibrary","mochaGlobals":["stub","spy","expect"]},"gitHead":"8b35c848a960999961aa0e72913eaa72e0c0a26b","_id":"6to5-library-boilerplate@2.1.0","_shasum":"cdcdea0587010fc65ff97a4e550f48ab5088c8fa","_from":".","_npmVersion":"2.4.1","_nodeVersion":"0.10.13","_npmUser":{"name":"jmeas","email":"jellyes2@gmail.com"},"maintainers":[{"name":"jmeas","email":"jellyes2@gmail.com"}],"dist":{"shasum":"cdcdea0587010fc65ff97a4e550f48ab5088c8fa","tarball":"https://registry.npmjs.org/6to5-library-boilerplate/-/6to5-library-boilerplate-2.1.0.tgz","integrity":"sha512-XbzvaYbINxtVtM/hQCCH9vjWyn1J+k8QXxtMJKWxOLb3Gk+hYFBJzXwFIPbqh5K+DBqK0dWHhhnY+U2ssR40Og==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQClAowiK9Ps6tp0GUja8tO8YD5jNU4FIZE/GkS+z2UAyQIgZDOILXRdCP5yFKp5D0XenbuBfFgXC3VekhqE9TCleqg="}]},"deprecated":"Use babel-library-boilerplate."}},"readme":"# 6to5-library-boilerplate\n[![Travis build status](http://img.shields.io/travis/6to5/6to5-library-boilerplate.svg?style=flat)](https://travis-ci.org/6to5/6to5-library-boilerplate)\n[![Code Climate](https://codeclimate.com/github/6to5/6to5-library-boilerplate/badges/gpa.svg)](https://codeclimate.com/github/6to5/6to5-library-boilerplate)\n[![Test Coverage](https://codeclimate.com/github/6to5/6to5-library-boilerplate/badges/coverage.svg)](https://codeclimate.com/github/6to5/6to5-library-boilerplate)\n[![Dependency Status](https://david-dm.org/6to5/6to5-library-boilerplate.svg)](https://david-dm.org/6to5/6to5-library-boilerplate)\n[![devDependency Status](https://david-dm.org/6to5/6to5-library-boilerplate/dev-status.svg)](https://david-dm.org/6to5/6to5-library-boilerplate#info=devDependencies)\n\nAuthor libraries in ES6 for Node and the browser.\n\n### Features\n\n- Author in ES6 (even the unit tests)\n- Export as ES5 & UMD\n- Mocha-Chai-Sinon testing stack\n- Unit tests that work in Node and in the browser\n\n### Getting Started\n\nUpdate the metadata about the project, including the name in the `LICENSE`\nand the `package.json` information.\n\nWrite your code in `src`. The primary file is `index.js` ([although the filename\ncan be changed](https://github.com/6to5/6to5-library-boilerplate#i-want-to-change-the-primary-source-file)).\n\nRun `gulp build` to compile the source into a distributable format.\n\nPut your unit tests in `test/unit`. The `gulp` command runs the tests.\n\n### Gulp tasks\n\n- `gulp` - Lint the library and tests, then run the unit tests\n- `gulp build` - Lint then build the library\n- `gulp watch` - Continuously run the unit tests as you make changes to the source\n   and test files themselves\n- `gulp test-browser` - Build the library for use with the browser spec runner.\n  Changes to the source will cause the runner to automatically refresh.\n\n### Browser Tests\n\nThe [browser spec runner](https://github.com/6to5/6to5-library-boilerplate/blob/master/test/runner.html)\ncan be opened in a browser to run your tests. For it to work, you must first run `gulp test-browser`. This\nwill set up a watch task that will automatically refresh the tests when your scripts, or the tests, change.\n\n### Code Climate\n\nThis library is set up to integrate with Code Climate. If you've never used Code Climate, then you might be wondering\nwhy it's useful. There are two reasons:\n\n1. It consumes code coverage reports, and provides a coverage badge for the README\n2. It provides interesting stats on your library, if you're into that kinda thing\n\nEither of these items on the list can simply be ignored if you're uninterested in them. Or you can pull Code Climate\nout entirely from the boilerplate and not worry about it. To do that, update the relevant Gulp tasks and the Travis\nbuild.\n\nIf you'd like to set up Code Climate for your project, follow [the steps here](https://github.com/6to5/6to5-library-boilerplate/wiki/Code-Climate).\n\n### Linting\n\nThis boilerplate uses [JSHint](http://jshint.com/docs/options/)\nand [JSCS](http://jscs.info/rules.html) to lint your source. To change the rules,\nedit the `.jshintrc` and `.jscsrc` files in the root directory, respectively.\n\nGiven that your unit tests aren't your library code, it makes sense to\nlint them against a separate JSHint configuration. For this reason, a\nseparate, unit-test specific `.jshintrc` can be found in the `test`\ndirectory. Unlike JSHint, the same JSCS rules are applied to both your code\nand your tests.\n\n### FAQ\n\n#### When should I consider using this boilerplate?\n\nYou're authoring a library that exports a single file, and that one file\nexports a single variable.\n\n#### When might I not want to use this boilerplate?\n\nYou can always use this boilerplate as inspiration, but it works best for smaller libraries.\nIf you're building a full-scale webapp, you will likely need many more changes to the build system.\n\n#### What's the browser compatibility?\n\nAs a rule of thumb, this transpiler works best in IE9+. You can support IE8 by limiting yourself\nto a subset of ES6 features. The [6to5 caveats page](http://6to5.org/docs/usage/caveats/) does an\nexcellent job at explaining the nitty gritty details of supporting legacy browsers.\n\n#### Are there examples?\n\nQuite a few! Check them out on [the wiki](https://github.com/6to5/6to5-library-boilerplate/wiki/Examples).\n\n#### Is there a Yeoman generator?\n\n[There sure is.](https://github.com/thejameskyle/generator-es6-library-boilerplate)\n\n### Customizing\n\nThis boilerplate is, to a certain extent, easily customizable. To make changes,\nfind what you're looking to do below and follow the instructions.\n\n#### I want to change the primary source file\n\nThe primary source file for the library is `src/index.js`. Only the files that this\nfile imports will be included in the final build. To change the name of this entry file:\n\n1. Rename the file\n2. Update the value of `entryFileName` in `package.json` under `to5BoilerplateOptions`\n\n#### I want to change the exported file name\n\n1. Update `main` in `package.json`\n\n#### I want to change the destination directory\n\n1. Update `main` in `package.json`\n\n#### I want to change what variable my module exports\n\n`MyLibrary` is the name of the variable exported from this boilerplate. You can change this by following\nthese steps:\n\n1. Ensure that the variable you're exporting exists in your scripts\n2. Update the value of `exportVarName` in `package.json` under `to5BoilerplateOptions`\n3. Update the globals array in the `test/.jshintrc` file\n4. Check that the unit tests have been updated to reference the new value\n\n#### I don't want to export a variable\n\n1. Ensure that your entry file does not export anything\n2. Set the property of `exportVarName` in `package.json` to be `null`\n3. Remove the variable name from the globals array in `test/.jshintrc`\n\n#### My library depends on an external module\n\nIn the simplest case, you just need to install the module and use it in your scripts.\n\nIf you want to access the module itself in your unit test files, you will need to set up the\ntest environment to support the module. To do this:\n\n1. Load the module in the [test setup file](https://github.com/6to5/6to5-library-boilerplate/blob/master/test/setup/setup.js).\n  Attach any exported variables to global object if you'll be using them in your tests.\n2. Update both `.jshintrc` files to include any new global variable that you have added\n3. Add those same global variables to the `mochaGlobals` array in `package.json` under\n  `to5BoilerplateOptions`\n","maintainers":[{"name":"jmeas","email":"jellyes2@gmail.com"}],"time":{"modified":"2022-06-12T14:08:26.661Z","created":"2015-02-04T06:40:50.713Z","1.1.2":"2015-02-04T06:40:50.713Z","2.0.0":"2015-02-05T05:22:15.418Z","2.1.0":"2015-02-14T05:37:02.442Z"},"homepage":"https://github.com/6to5/6to5-library-boilerplate","keywords":["boilerplate","es6","node","starter","kit","transpile","6to5"],"repository":{"type":"git","url":"https://github.com/6to5/6to5-library-boilerplate.git"},"author":{"name":"Jmeas"},"bugs":{"url":"https://github.com/6to5/6to5-library-boilerplate/issues"},"license":"MIT","readmeFilename":"README.md"}