Overview
This plugin is designed to help plugin creators and developers easily create open-sourced Vue plugins. It offers several features and tools to assist in the development process.
Features
- Create Vue components and directives on installation
- Add or inject Vuex stores
- Runtime accessors for Vue instances
- Configured integration with Storybook
- Nuxt compatibility
- TypeScript type definitions
- Includes a kitchensink for showcasing plugin features
Installation
There are two methods for installing this plugin:
Using GitHub Template Repository:
- Click the button provided to create a new project from this project structure.
- You will be prompted to enter a repository name, and it will be automatically cloned for you.
- After cloning, remember to edit the package.json details.
Using Shellpress Command:
- Run the press command for both shell and GitHub Template installations.
- The press file is a script that will rewrite some words in the package according to your changes.
- You will be prompted during the run to provide necessary details.
- After running the command, your package will be ready for development.
- Don’t forget to edit the package.json details!
Summary
This plugin is a valuable tool for plugin creators and developers who want to create open-sourced Vue plugins. With features such as the ability to create components and directives, inject Vuex stores, integrate with Storybook, and provide kitchensink examples, this plugin makes the development process easier. Additionally, its compatibility with Nuxt and TypeScript type definitions add even more value.
