snippet #1 - vue logger

published on the 7th of Nov, 2019

One of the first things I do for new projects is to copy over some common utility files, to keep in my handy src/utils/ belt. Today, let's explore a member of that family - logger.js

export const logger = (...args) => process.env.DEBUG && console.log(...args)

This allows us to sprinkle logger('quack') statements all over our code, without worrying of logging sensitive things in our production environment. The spread operator allows us to pass in all included arguments, so they'd work just like they do when you call console.log('Variable:', someVar, '...meow')

Note that you should use a proper logging library like winston long multiline link or bunyan for Node.js.

We can also turn this into a Vue plugin. vue-cli provides us with various .env files, so make sure to add VUE_APP_DEBUG=true for your .env.local or .env.development files (but definitely set it to false in .env.production)

export const logger = (...args) => process.env.VUE_APP_DEBUG && console.log(...args)

export default {
  install (Vue) {
    Vue.prototype.$log = logger
  }
}

We still export the logger function, since it comes in handy in regular .js files, e.g. for your router and store files.
We can now import those in our entrypoint (e.g. main.js).

import Vue from 'vue'
import logPlugin, { logger } from '@/src/utils/logger'

Vue.use(logPlugin)
new Vue({
  render: h => h(App)
}).$mount('#app')
logger('App mounted')

By using it as a plugin, it's always available in our Vue components without excessive import statements. Note that multiple parameters work just like they do for console.log:

<script>
export default {
  name: 'some-child',
  props: {
    msg: String
  },
  created () {
    this.$log('Child component created!', msg)
  }
}
</script>

Find me on

Proudly generated with Saber,

safely hosted on Netlify.