RDVue

RDVue is an opinionated CLI for generating Vue.js projects. We do so by adopting a development style guide which enforces strong typing with TypeScript, standardized Component, Layout and Page models, and a data-layer design promoting unified consumption through Stores and Services.

Table of Contents

• About
• Usage
• Commands
• Dev Instructions
• Testing

About

The RDVue CLI is the product of RealDecoy's Frontend Practice group. Contributions are welcome! You can help us by reporting or fixing bugs and giving us feedback on new/existing features.

Usage

Installing RDVue can be done with the command:

$ frontier plugins:install @rdfrontier/plugin-vue

The help menu can be accessed with the command:

frontier vue --help

The format for running an RDVue command is generally:

frontier vue:COMMAND

Commands

• frontier vue:create-project [NAME]
• frontier vue:add:component [NAME]
• frontier vue:add:page [NAME]
• frontier vue:add:service [NAME]
• frontier vue:add:store [NAME]
• frontier vue:plugin [NAME]
• frontier vue:plugin:buefy
• frontier vue:plugin:localization
• frontier vue:plugin:vuetify
• frontier vue:upgrade [NAME]

frontier vue:create-project [NAME] [PERSET]

Create a RDVue project

USAGE
  $ frontier vue:create-project [NAME] [PRESET]

ARGUMENTS
  NAME  Name of project to be created
  PERSET Name of plugin preset

OPTIONS
  -h, --help  show CLI help

See code: src/commands/create-project/index.ts

frontier vue:add:component [NAME]

Add a new component module to project

USAGE
  $ frontier vue:add:component [NAME]

ARGUMENTS
  NAME  Name of new compnent

OPTIONS
  -h, --help  show CLI help

See code: src/commands/add/component/index.ts

frontier vue:add:page [NAME]

Add a new page module to project

USAGE
  $ frontier vue:add:page [NAME]

ARGUMENTS
  NAME  Name of the new page 

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ frontier vue:add:page
       Running this add command!

See code: src/commands/add/page/index.ts

frontier vue:add:service [NAME]

Add a new service module to project

USAGE
  $ frontier vue:add:service [NAME]

ARGUMENTS
  NAME  Name of new service

OPTIONS
  -h, --help  show CLI help

See code: src/commands/add:service/index.ts

frontier vue:add:store [NAME]

Add a new store module to project

USAGE
  $ frontier vue:add:store [NAME]

ARGUMENTS
  NAME  Name of new store module

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ frontier vue:add:store
       Running this add command!

See code: src/commands/add/store/index.ts

frontier vue:plugin [NAME]

Add a new plugin module to project

USAGE
  $ frontier vue:plugin [NAME]

ARGUMENTS
  BUEFY  Lightweigth UI components for Vue.js
  LOCALIZATION Adds i18bn localization
  VUETIFY lightweigth UI components for Vuejs

OPTIONS
  -h, --help  show CLI help

frontier vue:plugin:buefy

Add lightweigth UI components for Vue.js

USAGE
  $ frontier vue:plugin:buefy

OPTIONS
  -h, --help  show CLI help

See code: src/commands/plugin/buefy/index.ts

frontier vue:plugin:localization

Add i18bn localization to vue project

USAGE
  $ frontier vue:plugin:localization


OPTIONS
  -h, --help  show CLI help

See code: src/commands/plugin/localization/index.ts

frontier vue:plugin:vuetify

Add lightweigth UI components for Vue.js

USAGE
  $ frontier vue:plugin:vuetify


OPTIONS
  -h, --help  show CLI help

See code: src/commands/plugin/vuetify/index.ts

frontier vue:upgrade [NAME]

Specify the rdvue template version for a project

USAGE
  $ frontier vue:upgrade [NAME]

ARGUMENTS
  NAME  RDVue version to specify to

OPTIONS
  -h, --help  show CLI help

See code: src/commands/upgrade/index.ts

Development

Testing

Run Unit Test Suite

npm run test

Creating Tests

• create a <module-name>.test.ts file in the /test folder
• using chai assertion syntax, describe your unit test cases
• visit the oclif testing documentation to see more details