Skip to content

webcored/vue-cli-plugin-pod

Repository files navigation

vue-cli-plugin-pod

Extended cli to manage file templates for vue projects


Refer

https://dev.to/prakash_chokalingam/generating-files-with-vue-cli-plugin-pod-5639

Installation

Add this vue cli plugin to your awesome vue project using the below command:

vue add pod

once installed, your project will have access to the following tasks:


Generate

Creates template files for the specified file type

npm run generate <filetype> <file name or path>

Example: npm run generate component UI/Button

Rename

Renames template files for the specified file type

npm run rename <filetype> <old file name or path> <new file name or path>

Example: npm run rename component icon avatar

Delete

Deletes template files for the specified file type

npm run delete <filetype> <file name or path>

Example: npm run delete component UI/Button

Config

Get a clone of the default pod config file and customize it.

npm run config

The above command will generate a pod.config.js file to the root of your project.

click here to check the default config.

Default file types allowed: component, directive & mixin.

The config file accepts fileType & array of files.

Available config file options:

key type / default description
filepath string : {filename}/{filename.extension} file default path and name
$basepath optional string : {filetype} file basepath directory
content string file default content
isTemplateFile optional boolean: true for .vue file A boolean flag to identify the template file
tagname optional string tag name applicable for component files alone. It specified the tag should be used while refering in the template file
tagAttributes optional Object Required attributes for file while refering the file in template file

Only component filetype will accept an object singleFile: true which decides whether to follow vue single file structure by infering the component files contents to the template file or create multiple files while generating a component and refer them in the template file.


TODO

  • VUE UI integration
  • Pre/Post callbacks for file operations