Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kazupon/vue-cli-plugin-p11n

:electric_plug: Vue CLI 3 plugin to pluginize your Vue project
https://github.com/kazupon/vue-cli-plugin-p11n

plugin vue vue-cli

Last synced: 3 months ago
JSON representation

:electric_plug: Vue CLI 3 plugin to pluginize your Vue project

Awesome Lists containing this project

README

        

# THIS REPOSITORY IS DEPRECATED

## :electric_plug: vue-cli-plugin-p11n

[![CircleCI](https://circleci.com/gh/kazupon/vue-cli-plugin-p11n.svg?style=svg)](https://circleci.com/gh/kazupon/vue-cli-plugin-p11n)

Vue CLI 3 plugin to pluginize your Vue project

> p11n = pluginization


Become a Patreon

## :star: Features
Adjust your project generated by Vue CLI 3 to plugin development environment.

- Setup the plugin development codes for JavaScript or TypeScript
- Build for production code with rollup
- Adjust some files to distribute your Vue plugin
- Adjust to the environment where developable your Vue plugin with App.vue
- Provide demonstrate environment for your Vue plugin
- Setup the initial documentation environment with VuePress
- Automatically insert node_modules as rollup externals

## :rocket: Getting Started
If yon don't have a project created with Vue CLI 3:

```sh
vue create vue-your-plugin
```

Install the plugin into your project:

```sh
cd vue-your-plugin
vue add p11n
```

## :package: Build Customizing

### Automatically insert node_modules as externals
If you don't want to bundle dependent modules like `axios` at your plugin, you can make it external using `dependencies` of `package.json`.

example the below:

```json
{
...
"dependencies": {
"axios": "^0.18.0"
},
...
}
```

## :scroll: Changelog

Detailed changes for each release are documented in the [CHANGELOG.md](https://github.com/kazupon/vue-cli-plugin-p11n/blob/master/CHANGELOG.md).

## :exclamation: Issues

Please make sure to read the [Issue Reporting Checklist](https://github.com/kazupon/vue-cli-plugin-p11n/blob/master/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.

## :muscle: Contribution

Please make sure to read the [Contributing Guide](https://github.com/kazupon/vue-cli-plugin-p11n/blob/master/CONTRIBUTING.md) before making a pull request.

## :white_check_mark: TODO
See the [GitHub projects](https://github.com/kazupon/vue-cli-plugin-p11n/projects/1)

## :copyright: License

[MIT](http://opensource.org/licenses/MIT)