diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..405cf06 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,39 @@ +# Changelog + +All Notable changes to `rollup-plugin-vue` will be documented in this file. + +## [Unreleased] + +### Added +- Nothing + +### Deprecated +- Nothing + +### Fixed +- Nothing + +### Removed +- Nothing + +### Security +- Nothing + +## [1.0.3] - 2016-01-24 + +### Added +- Initial release. + +### Deprecated +- Nothing + +### Fixed +- Nothing + +### Removed +- Nothing + +### Security +- Nothing + +[Unreleased]: https://github.com/znck/rollup-plugin-vue/compare/v1.0.3...HEAD diff --git a/CONDUCT.md b/CONDUCT.md new file mode 100644 index 0000000..6ff94ca --- /dev/null +++ b/CONDUCT.md @@ -0,0 +1,22 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing other's private information, such as physical or electronic addresses, without explicit permission +* Other unethical or unprofessional conduct. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. + +This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community in a direct capacity. Personal views, beliefs and values of individuals do not necessarily reflect those of the organisation or affiliated individuals and organisations. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. + +This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a3ad3e0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +We accept contributions via Pull Requests on [Github](https://github.com/znck/rollup-plugin-vue). + + +## Pull Requests + +- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer). + +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. + +- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. + +- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option. + +- **Create feature branches** - Don't ask us to pull from your master branch. + +- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. + +- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. + + +## Running Tests + +``` bash +$ composer test +``` + + +**Happy coding**! diff --git a/README.md b/README.md index c601804..3583351 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,39 @@ -# rollup-plugin-vue [![circleci](https://circleci.com/gh/znck/rollup-plugin-vue.svg?style=shield&circle-token=:8f5a3f8b258950508dfe8574a46d9ba2de67f2d2)](https://circleci.com/gh/znck/rollup-plugin-vue) [![npm](https://img.shields.io/npm/v/rollup-plugin-vue.svg)](https://www.npmjs.com/package/rollup-plugin-vue) [![Coveralls](https://img.shields.io/coveralls/znck/rollup-plugin-vue.svg)](https://coveralls.io/github/znck/rollup-plugin-vue) +# Rollup Plugin for Vue +As vue-loader is for webpack and vueify is for browserify, similarly its for rollup. As we know, webpack and browserify concat stuff and make it runnable in browser. Its difficult to share .vue components. **Now roll your [Vue](http://vuejs.org/) components.** -Roll .vue files +With rollup you can break your application into reusable modules. -### Installation +![Rollup Plugin for Vue](cover.png) + +

+ + Build Status + + + Coverage Status + + + Software License + + + NPM + + + Latest Version + + + + Issues + +

+### Installation +[Node](http://nodejs.org/) and [Rollup](http://rollupjs.org) are required. ``` -npm install --save-dev rollup rollup-plugin-vue +npm install --save-dev rollup-plugin-vue ``` -### Configuration +### Usage ```js import {rollup} from 'rollup'; @@ -23,3 +48,34 @@ rollup({ ### Limitations - Multiple script tags not working. + + +## Change log + +Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. + +## Testing + +``` bash +$ npm run test +``` + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details. + +## Security + +If you discover any security related issues, please email hi@znck.me instead of using the issue tracker. + +## Credits + +- [Rahul Kadyan][link-author] +- [All Contributors][link-contributors] + +## License + +The MIT License (MIT). Please see [License File](LICENSE) for more information. + +[link-author]: https://github.com/:author_username +[link-contributors]: ../../contributors diff --git a/cover.png b/cover.png new file mode 100644 index 0000000..533fc37 Binary files /dev/null and b/cover.png differ diff --git a/package.json b/package.json index 2b07f5e..bbacbb3 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "scripts": { "build": "NODE_ENV=production node --harmony config/build.js", "test": "NODE_ENV=production mocha test/test.js --slow=5000 --timeout=10000", - "coveralls": "NODE_ENV=production istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- --slow=5000 --timeout=10000 test/test.js && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage" + "coveralls": "NODE_ENV=production istanbul cover --default-excludes -x 'dist/**' -x 'config/**' ./node_modules/mocha/bin/_mocha --report lcovonly -- --slow=5000 --timeout=10000 test/test.js && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage" }, "repository": { "type": "git", @@ -25,9 +25,8 @@ "homepage": "https://github.com/znck/rollup-plugin-vue#readme", "dependencies": { "rollup-pluginutils": "latest", - "vueify": "latest" - }, - "devDependencies": { + "rollup": "latest", + "vueify": "latest", "babel-core": "^6.1.2", "babel-plugin-transform-runtime": "latest", "babel-preset-es2015": "latest", @@ -35,23 +34,25 @@ "babel-register": "latest", "babel-runtime": "^5.8.0", "coffee-script": "^1.10.0", - "coveralls": "^2.11.6", "diff": "^2.2.1", "hash-sum": "latest", "html-minifier": "^1.1.1", - "istanbul": "^0.4.2", "jade": "^1.11.0", "less": "^2.5.3", "minify": "^2.0.3", - "mocha": "^2.3.4", - "mocha-lcov-reporter": "^1.0.0", "node-sass": "^3.4.2", "rollup": "^0.25.1", "rollup-plugin-babel": "^2.3.9", "rollup-plugin-commonjs": "^2.2.0", "rollup-plugin-replace": "^1.1.0", "stylus": "^0.53.0", - "vue-hot-reload-api": "^1.2.2", "vueify-insert-css": "^1.0.0" + }, + "devDependencies": { + "coveralls": "^2.11.6", + "istanbul": "^0.4.2", + "mocha": "^2.3.4", + "mocha-lcov-reporter": "^1.0.0", + "vue-hot-reload-api": "^1.2.2" } } diff --git a/test/test.js b/test/test.js index 86f03cb..f69256c 100644 --- a/test/test.js +++ b/test/test.js @@ -51,10 +51,6 @@ function test(name) { var result = bundle['generate'](); var code = result.code; - //if (code !== expected) { - //console.warn([code, expected]); - //} - assert.equal(code, expected, 'should compile correctly'); // check src