README.md

Vue::Generators

vue-generators is an opinionated library for generating Vue components, mixins, packs, and stores for a Rails project.

Usage

Help

rails g vue:component -h
rails g vue:mixin -h
rails g vue:store -h
rails g vue:pack -h

Generate a component

rails g vue:component ButtonCounter

This will generate:

app/javascript/components/ButtonCounter.vue

<template>
  <div>
  </div>
</template>

<script>
export default {
  name: 'ButtonCounter',

  components: {},

  mixins: [],

  props: {
    /*
    property: {
      type: String|Number|Boolean|Array|Object|Date|Function|Symbol,
      default: null,
      required: false
    },
    */
  },

  data() {
    return {
      // field: 'value'
    }
  },

  computed: {
    // computed properties are cached based on their dependencies
    /*
    computedProperty() {
      return 'value'
    },
    */
  },

  methods: {
    // Methods run whenever a re-render happens, their results aren't cached.
    /*
    onClick() {
      this.$emit('click-happened')
    },
    */
  },

  mounted() {
    // Invoked when the component loads, good place to fetch data from the API
  },
}
</script>

<style lang="stylus" scoped>
</style>

Generate a mixin

rails g vue:mixin MyMixin

This will generate:

app/javascript/mixins/MyMixin.js

export default {
  props: {
    /*
    property: {
      type: String|Number|Boolean|Array|Object|Date|Function|Symbol,
      default: null,
      required: false
    },
    */
  },

  data() {
    return {
      // field: 'value'
    }
  },

  computed: {
    // computed properties are cached based on their dependencies
    /*
    computedProperty() {
      return 'value'
    },
    */
  },

  methods: {
    // Methods run whenever a re-render happens, their results aren't cached.
    /*
    onClick() {
      this.$emit('click-happened')
    },
    */
  },
}

Generate a pack

rails g vue:pack admin

This will generate: *app/javascript/packs/admin.js

import VueRouter from 'vue-router'

// Routing
const router = new VueRouter({
})

// Vuex
const store = new Vuex.Store({

})

document.addEventListener("DOMContentLoaded", () => {
  Vue.use(VueRouter)

  const el = document.getElementById("root")

  const app = new Vue({
    el: el,
    template: "<div><router-view /></div>",
    components: {},
    router,
    store,
    mounted() {
    },
  })
})

Generate a store

rails g vue:store Application

This will generate:

app/javascript/stores/application/Store.js

import { actions }    from "./actions"
import { getters }    from "./getters"
import { mutations }  from "./mutations"
import { state }      from "./state"

export default {
  namespaced: true,

  actions:    actions,
  getters:    getters,
  mutations:  mutations,
  state:      state
}

app/javascript/stores/application/actions.js

export const actions = {

}

app/javascript/stores/application/getters.js

export const getters = {

}

app/javascript/stores/application/mutations.js

export const mutations = {
}

app/javascript/stores/application/state.js

export const state = {

}

Installation

Add this line to your application's Gemfile:

group :development do
  gem 'vue-generators'
end

And then execute:

$ bundle

Or install it yourself as:

$ gem install vue-generators

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake to run the tests.

To install this gem onto your local machine, run bundle exec rake install.

To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/GoodMeasuresLLC/vue-generators. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the vue-generators project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.