Feature/git-notes (WIP)

package.json

@@ -62,8 +62,7 @@
   },
   "engines": {
     "node": ">= 8.9.0",
-    "npm": ">= 5.6.0",
-    "yarn": ">= 1.6.0"
+    "npm": ">= 5.6.0"
   },
   "browserslist": [
     "> 1%",

src/components/git-notes/CreateButton.vue

@@ -0,0 +1,39 @@
+<template lang="pug">
+  q-btn(icon="create" v-bind="$attrs" @click="add")
+</template>
+
+<style>
+</style>
+
+<script>
+import { run } from '@/node-utils'
+
+/** A button to insert notes
+ * @prop {String} notes notes that want to be inserted
+ * @prop {String} commitId SHA-1 of commits. If not provided, it will add notes in the HEAD (current commit)
+ * @prop {String} workingDirectory in case the application not runned in project directory
+ * @fires success when notes is committed
+ * @fires fail#ErrorMessage when notes fail to commit
+ * @example gn-button(:notes="markdownNotes" commitId="98e34" workingDirectory="/home/user/projects")
+ */
+export default {
+  name: 'GitNotesCreateButton',
+  props: {
+    notes: {
+      type: String,
+      required: true
+    },
+    commitId: String,
+    workingDirectory: String
+  },
+  methods: {
+    add () {
+      const cwd = this.workingDirectory
+      const sha = this.commitId
+      run('git', ['notes', '--ref=utopian', 'add', '-m', this.notes, ...(sha ? [sha] : [])], { cwd })
+        .then(data => this.$emit('success'))
+        .catch(data => this.$emit('fail', data.toString()))
+    }
+  }
+}
+</script>

src/components/git-notes/RemoveButton.vue

@@ -0,0 +1,34 @@
+<template lang="pug">
+  q-btn(icon="delete" v-bind="$attrs" @click="remove")
+</template>
+
+<style>
+</style>
+
+<script>
+import { run } from '@/node-utils'
+
+/** A button to remove notes
+ * @prop {String} commitId SHA-1 of commits. If not provided, it will remove notes in the HEAD (current commit)
+ * @prop {String} workingDirectory in case the application not runned in project directory
+ * @fires success when notes is removed
+ * @fires fail#ErrorMessage when notes fail to removed
+ * @example gn-button(commitId="98e34" workingDirectory="/home/user/projects")
+ */
+export default {
+  name: 'GitNotesRemoveButton',
+  props: {
+    commitId: String,
+    workingDirectory: String
+  },
+  methods: {
+    remove () {
+      const cwd = this.workingDirectory
+      const sha = this.commitId
+      run('git', ['notes', '--ref=utopian', 'remove', ...(sha ? [sha] : [])], { cwd })
+        .then(data => this.$emit('success'))
+        .catch(data => this.$emit('fail', data.toString()))
+    }
+  }
+}
+</script>

src/components/git-notes/ShowButton.vue

@@ -0,0 +1,35 @@
+<template lang="pug">
+  q-btn(icon="visibility" v-bind="$attrs" @click="show")
+</template>
+
+<style>
+</style>
+
+<script>
+import { run, runSync } from '@/node-utils'
+
+/** A button to insert notes
+ * @prop {String} commitId SHA-1 of commits. If not provided, it will show notes in the HEAD (current commit)
+ * @prop {String} workingDirectory in case the application not runned in project directory
+ * @fires success#Notes when notes can be retrieved
+ * @fires fail#ErrorMessage when notes fail to be retrieved
+ * @example gn-button(commitId="98e34" workingDirectory="/home/user/projects")
+ */
+export default {
+  name: 'GitNotesCreateButton',
+  props: {
+    commitId: String,
+    workingDirectory: String
+  },
+  methods: {
+    show () {
+      const cwd = this.workingDirectory
+      const sha = this.commitId
+      const getHead = [runSync('git', ['rev-parse', 'HEAD'])]
+      run('git', ['notes', '--ref=utopian', 'show', ...(sha ? [sha] : getHead)], { cwd })
+        .then(data => this.$emit('success'), data.stdout)
+        .catch(data => this.$emit('fail', data.toString()))
+    }
+  }
+}
+</script>

src/node-utils.js

@@ -0,0 +1,18 @@
+import { promisify } from 'util'
+import { execFile, execFileSync } from 'child_process'
+
+const elecOpts = {
+  shell: true,
+  windowsHide: true,
+  encoding: 'utf-8'
+}
+
+export const run = (cmd, args, opts) => promisify(execFile)(cmd, args, {
+  ...elecOpts,
+  ...opts
+})
+
+export const runSync = (cmd, args, opts) => promisify(execFileSync)(cmd, args, {
+  ...elecOpts,
+  ...opts
+})

src/pages/__Test__.vue

@@ -0,0 +1,25 @@
+<template lang="pug">
+  q-page.flex.flex-center
+    .column.flex-center
+      p {{ $t('pages.dashboard.title') }}
+      gn-button(label="Create Notes")
+</template>
+
+<style>
+</style>
+
+<script>
+import GnButton from '@/components/git-notes/CreateButton.vue'
+
+export default {
+  name: 'PageDashboard',
+  components: {
+    GnButton
+  },
+  meta () {
+    return {
+      title: 'Dashboard'
+    }
+  }
+}
+</script>

test/utils/index.js

@@ -20,7 +20,7 @@ localVue.use(VueRouter)
 localVue.use(Quasar)
 
 export const mountQuasar = (component, options = {}) => {
-  const app= {}
+  const app = {}
   const store = new Vuex.Store({})
   const router = new VueRouter()