Skip to content

Commit

Permalink
docs(readme): update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
0vidiu committed May 24, 2018
1 parent 60bd7e1 commit e868818
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 13 deletions.
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
# Frontvue-Plugin-Pug
# Frontvue-Plugin-JS

[![Build Status](https://travis-ci.org/0vidiu/frontvue-plugin-pug.svg?branch=master)](https://travis-ci.org/0vidiu/frontvue-plugin-pug) [![codecov](https://codecov.io/gh/0vidiu/frontvue-plugin-pug/branch/master/graph/badge.svg)](https://codecov.io/gh/0vidiu/frontvue-plugin-pug) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![Build Status](https://travis-ci.org/0vidiu/frontvue-plugin-js.svg?branch=master)](https://travis-ci.org/0vidiu/frontvue-plugin-js) [![codecov](https://codecov.io/gh/0vidiu/frontvue-plugin-js/branch/master/graph/badge.svg)](https://codecov.io/gh/0vidiu/frontvue-plugin-js) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

## A Frontvue plugin for Pug boilerplate and processing
This plugin will be one of the available options to choose from when you configure a new project using Frontvue. It handles Pug files and comes with a boilerplate template of Pug partials. It comes with the following tasks:
* *pug:config* — registers a configuration questionnaire;
* *pug:template* — copies the Pug template;
* *pug:clean* — removes the build folder;
* *pug:process* — handles compiling of Pug partials;
* *pug:watch* — starts listeners for changes in Pug partials;
## A Frontvue plugin for JavaScript boilerplate and processing
This plugin will be one of the available options to choose from when you configure a new project using Frontvue. It handles JavaScript ES6 files and comes with a boilerplate template (w.i.p). It comes with the following tasks:
* *js:config* — registers a configuration questionnaire;
* *js:template* — copies the JavaScript ES6 template;
* *js:clean* — removes the build folder;
* *js:process* — handles compiling of JS partials;
* *js:watch* — starts listeners for changes in JS partials;

## Default configuration
```js
{
// Source files directory name
sourceDir: 'pug',
sourceDir: 'js',

// Directory name where the HTML file(s) will be outputted
buildDir: 'html'
// Directory name where the JS file(s) will be outputted
buildDir: 'js',

// Entry point(s)
entrypoints: 'index.js',
}
```
2 changes: 1 addition & 1 deletion src/config/config-questionnaire.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export default {
},
{
default: defaults.entrypoints,
message: `Enter entrypoint filename(s).\n Multiple files need to be separated by commas: 'index.js,server.js'`,
message: `Enter entrypoint filename(s).\n Multiple files need to be separated by commas: 'index.js,modules.js'`,
name: 'entrypoints',
type: 'input',
},
Expand Down

0 comments on commit e868818

Please sign in to comment.