Vue Templates Logo Vue Templates
Vue Plugin Boilerplate screenshot

Vue Plugin Boilerplate

Author Avatar Theme by Kazupon
Updated: 24 Sep 2018
145 Stars

:nut_and_bolt: Boilerplate for Vue.js plugin

Github

Categories

Templates & themes

Overview

This product analysis will provide an overview of the Vue.js plugin boilerplate called vue-plugin-boilerplate. This boilerplate is designed to assist developers in creating Vue.js plugins by providing them with a base template that includes various tools and frameworks for development, testing, and bundling.

Features

  • Using tools: This boilerplate incorporates various tools including a compiler, linter, bundler, and test framework to aid in the development process.
  • Compiler: The compiler used in this boilerplate is TypeScript, allowing developers to write their plugins in TypeScript.
  • Transpile: The boilerplate utilizes babel for development and buble for distribution in order to transpile the code.
  • Linter: This boilerplate uses eslint as the linter, ensuring that the code follows best practices and maintains a consistent style.
  • Bundler: webpack is used as the bundler for development, while rollup is used for distribution, allowing efficient bundling of the plugin.
  • Test Assertion: The boilerplate includes power-assert as the test assertion library, aiding in writing concise and effective tests.
  • Test Framework: Developers can utilize mocha as the test framework to write and execute tests for their Vue.js plugin.
  • Test Runner: Karma is the test runner included in this boilerplate, providing a powerful and flexible environment for running tests.
  • Test Coverage: The boilerplate integrates istanbul for test coverage, helping developers analyze the coverage of their tests.
  • Headless Browser: Chrome headless is the headless browser used in this boilerplate, enabling developers to run tests in a headless environment.
  • End-to-End Test Framework: This boilerplate incorporates nightwatch.js as the end-to-end test framework, allowing developers to perform automated browser tests.

Installation

To install the vue-plugin-boilerplate, follow these steps:

  1. Clone the repository:
git clone [repository-url]
  1. Navigate to the cloned directory:
cd vue-plugin-boilerplate
  1. Install the dependencies:
npm install
  1. Start the development server:
npm run dev
  1. Build the distribution files:
npm run build
  1. Run the tests:
npm run test

Summary

The vue-plugin-boilerplate is a comprehensive Vue.js plugin boilerplate that provides developers with a base template containing various tools and frameworks for efficient development, testing, and bundling of Vue.js plugins. With features such as TypeScript compiler, eslint linter, webpack bundler, and Karma test runner, this boilerplate streamlines the plugin development process and ensures code quality. Additionally, the inclusion of nightwatch.js for end-to-end testing and support for test coverage with istanbul further enhances the testing capabilities of this boilerplate.