feat: extract rfced comments tool

Author: NGPixel

src-electron/electron-preload.js

@@ -42,7 +42,7 @@ contextBridge.exposeInMainWorld('ipcBridge', {
   gitDiscardChanges: (files) => ipcRenderer.invoke('gitDiscardChanges', { files }),
   gitCommit: (message) => ipcRenderer.invoke('gitCommit', { message }),
   lspSendRequest: (method, params) => ipcRenderer.invoke('lspSendRequest', { method, params }),
-  saveValidationResults: (output, filePath) => ipcRenderer.invoke('saveValidationResults', { output, filePath }),
+  saveContentToFile: (output, filePath, title) => ipcRenderer.invoke('saveContentToFile', { output, filePath, title }),
   persistSession: (data) => ipcRenderer.invoke('persistSession', data),
   restoreSession: () => ipcRenderer.invoke('restoreSession')
 })

src-electron/handlers.js

@@ -364,12 +364,12 @@ export function registerCallbacks (mainWindow, mainMenu, auth, git, lsp, tlm, te
     lsp.sendNotification(opts.method, opts.params)
   })
   // ----------------------------------------------------------
-  // VALIDATION CHECKS
+  // SAVE GENERIC CONTENT TO FILE
   // ----------------------------------------------------------
-  ipcMain.handle('saveValidationResults', async (ev, opts) => {
+  ipcMain.handle('saveContentToFile', async (ev, opts) => {
     const saveOpts = await dialog.showSaveDialog(mainWindow, {
-      title: 'Save Validation Results As...',
-      defaultPath: opts.filePath || path.join(app.getPath('desktop'), 'results.txt'),
+      title: opts.title ?? 'Save As...',
+      defaultPath: opts.filePath || path.join(app.getPath('desktop'), 'output.txt'),
       filters: [{
         name: 'Plain Text',
         extensions: ['txt']

src/components/DrawerChecks.vue

@@ -410,7 +410,7 @@ async function saveResultsToFile (key) {
   }
   filePath = `${filePath}-${key}.txt`
 
-  if (await window.ipcBridge.saveValidationResults(editorStore.validationChecksDetails[key].getTextOutput(), filePath)) {
+  if (await window.ipcBridge.saveContentToFile(editorStore.validationChecksDetails[key].getTextOutput(), filePath, 'Save Validation Results As...')) {
     $q.notify({
       message: 'Results saved!',
       caption: 'Results have been saved to file successfully.',

src/components/DrawerTools.vue

@@ -4,6 +4,12 @@
     .text-caption.text-light-blue-3
       strong Tools
 q-list
+  q-item(clickable v-if='currentMode === `review`' @click='extractRfcedComments')
+    q-item-section(side)
+      q-icon(name='mdi-comment-arrow-right-outline' size='xs' color='purple-2')
+    q-item-section
+      q-item-label Extract [rfced] comments
+      q-item-label.text-purple-2(caption) List all comments for the RPC staff
   q-item(clickable @click='reformat')
     q-item-section(side)
       q-icon(name='mdi-page-previous-outline' size='xs' color='purple-2')
@@ -19,13 +25,34 @@ q-list
 </template>
 
 <script setup>
+import { computed, defineAsyncComponent } from 'vue'
+import { useRoute } from 'vue-router'
 import { useQuasar } from 'quasar'
 
 const $q = useQuasar()
 
+const route = useRoute()
+
+const currentMode = computed(() => {
+  if (route.name === 'editor') {
+    if (route.query.mode === 'review') {
+      return 'review'
+    }
+    return 'write'
+  } else {
+    return route.name
+  }
+})
+
 // METHODS
 
-function reformat() {
+function extractRfcedComments () {
+  $q.dialog({
+    component: defineAsyncComponent(() => import('components/ExtractRfcedCommentsDialog.vue'))
+  })
+}
+
+function reformat () {
   EVENT_BUS.emit('editorAction', 'format')
   $q.notify({
     message: 'Document reformatted succesfully',
@@ -34,7 +61,7 @@ function reformat() {
   })
 }
 
-function stripmchars() {
+function stripmchars () {
   EVENT_BUS.emit('editorAction', 'stripMChars')
   $q.notify({
     message: 'Document cleaned succesfully',

src/components/ExtractRfcedCommentsDialog.vue

@@ -0,0 +1,139 @@
+<template lang="pug">
+q-dialog(
+  ref='dialogRef'
+  @hide='onDialogHide'
+  :transition-show='editorStore.animationEffects ? `jump-up` : `none`'
+  :transition-hide='editorStore.animationEffects ? `jump-down` : `none`'
+  )
+  q-card.mica(style='min-width: 800px;')
+    q-card-section.flex.items-center.bg-light-blue-10
+      q-icon(name='mdi-comment-arrow-right-outline', left, size='sm')
+      span Extract [rfced] Comments
+    q-card-section.card-border
+      q-card-section.q-pa-sm(style='max-height: 520px')
+        q-input(
+          autofocus
+          color='light-blue-4'
+          outlined
+          v-model='state.output'
+          tabindex='0'
+          type='textarea'
+          autogrow
+          input-style='max-height: 500px;'
+          )
+      q-card-actions(align='right')
+        q-btn(
+          outline
+          label='Close'
+          color='grey-5'
+          padding='xs md'
+          @click='onDialogCancel'
+          tabindex='3'
+          )
+        q-btn(
+          unelevated
+          label='Copy to Clipboard'
+          color='primary'
+          padding='xs md'
+          @click='copyToClipboard'
+          tabindex='2'
+          )
+        q-btn(
+          unelevated
+          label='Save to File'
+          color='primary'
+          padding='xs md'
+          @click='saveToFile'
+          tabindex='1'
+          )
+
+</template>
+
+<script setup>
+import { useDialogPluginComponent, useQuasar } from 'quasar'
+import { onMounted, reactive } from 'vue'
+import { useDocsStore } from 'src/stores/docs'
+import { useEditorStore } from 'src/stores/editor'
+import { modelStore } from 'src/stores/models'
+
+const commentsRgx = /<!-- \[rfced\]([^]+?)-->/gmi
+
+const $q = useQuasar()
+
+// EMITS
+
+defineEmits([
+  ...useDialogPluginComponent.emits
+])
+
+// STORES
+
+const docsStore = useDocsStore()
+const editorStore = useEditorStore()
+
+// QUASAR
+
+const { dialogRef, onDialogCancel, onDialogHide } = useDialogPluginComponent()
+
+// STATE
+
+const state = reactive({
+  output: ''
+})
+
+// METHODS
+
+function copyToClipboard () {
+  window.ipcBridge.emit('writeToClipboard', {
+    text: state.output
+  })
+  $q.notify({
+    message: 'Comments copied!',
+    caption: 'Comments have been copied to the clipboard successfully.',
+    color: 'positive',
+    icon: 'mdi-clipboard'
+  })
+}
+
+async function saveToFile () {
+  let filePath = docsStore.activeDocument.path
+  const extPosition = filePath.lastIndexOf('.')
+  if (extPosition >= 0) {
+    filePath = filePath.slice(0, extPosition)
+  }
+  filePath = `${filePath}-comments.txt`
+
+  if (await window.ipcBridge.saveContentToFile(state.output, filePath, 'Save Comments As...')) {
+    $q.notify({
+      message: 'Comments saved!',
+      caption: 'Comments have been saved to file successfully.',
+      color: 'positive',
+      icon: 'mdi-comment-check-outline'
+    })
+  }
+}
+
+// MOUNTED
+
+onMounted(() => {
+  const contents = modelStore[docsStore.activeDocument.id].getValue()
+  const comments = []
+  for (const match of contents.matchAll(commentsRgx)) {
+    comments.push(match[1].trim())
+  }
+  if (comments.length > 0) {
+    state.output = comments.join('\n\n============\n\n')
+  } else {
+    $q.notify({
+      message: 'No comments found.',
+      caption: 'No comments found in the active document.',
+      color: 'negative',
+      icon: 'mdi-alert'
+    })
+    setTimeout(() => {
+      onDialogCancel()
+    })
+  }
+})
+
+</script>