feat: able rename keys and remove keys

Author: antfu

package.json

@@ -83,6 +83,14 @@
         "title": "Go to definaition",
         "icon": "./static/icon-open-file.svg"
       },
+      {
+        "command": "extension.vue-i18n-ally.delete-key",
+        "title": "Delete key"
+      },
+      {
+        "command": "extension.vue-i18n-ally.rename-key",
+        "title": "Rename key path"
+      },
       {
         "command": "extension.vue-i18n-ally.locale-visibility-toggle",
         "title": "Toggle locale visibility",
@@ -108,6 +116,14 @@
         {
           "command": "extension.vue-i18n-ally.set-source-language",
           "when": "config.no_exits"
+        },
+        {
+          "command": "extension.vue-i18n-ally.delete-key",
+          "when": "config.no_exits"
+        },
+        {
+          "command": "extension.vue-i18n-ally.rename-key",
+          "when": "config.no_exits"
         }
       ],
       "view/item/context": [
@@ -139,6 +155,14 @@
           "command": "extension.vue-i18n-ally.set-source-language",
           "when": "view =~ /locales-progress/ && viewItem =~ /notsource/"
         },
+        {
+          "command": "extension.vue-i18n-ally.delete-key",
+          "when": "view =~ /locales-tree/ && viewItem =~ /node/"
+        },
+        {
+          "command": "extension.vue-i18n-ally.rename-key",
+          "when": "view =~ /locales-tree/ && viewItem =~ /node/"
+        },
         {
           "command": "extension.vue-i18n-ally.locale-visibility-show",
           "when": "view =~ /locales-progress/ && viewItem =~ /show/",

src/commands/keyManipulations.ts

@@ -1,8 +1,9 @@
 import { window, commands, workspace, Selection, TextEditorRevealType, env } from 'vscode'
-import { Global, Commands } from '../core'
+import { Global, Commands, LocaleRecord } from '../core'
 import { ExtensionModule } from '../modules'
 import { LocaleTreeItem, Node } from '../views/LocalesTreeView'
 import * as path from 'path'
+import { flatten } from 'lodash'
 
 async function getRecordFromNode (node: Node, defaultLocale?: string) {
   if (node.type === 'tree')
@@ -125,6 +126,72 @@ const m: ExtensionModule = (ctx) => {
           window.showErrorMessage(err.toString())
         }
       }),
+
+    commands.registerCommand(Commands.rename_key,
+      async ({ node }: LocaleTreeItem) => {
+        let records: LocaleRecord[] = []
+
+        if (node.type === 'tree')
+          return
+
+        else if (node.type === 'record')
+          records = [node]
+
+        else
+          records = Object.values(node.locales)
+
+        try {
+          const newkeypath = await window.showInputBox({
+            value: node.keypath,
+            prompt: 'Enter the new keypath',
+          })
+
+          if (newkeypath !== undefined && newkeypath !== node.keypath) {
+            const writes = flatten(records
+              .map(record => [{
+                value: undefined,
+                keypath: record.keypath,
+                filepath: record.filepath,
+                locale: record.locale,
+              }, {
+                value: record.value,
+                keypath: newkeypath,
+                filepath: record.filepath,
+                locale: record.locale,
+              }]))
+            await Global.loader.writeToFile(writes)
+          }
+        }
+        catch (err) {
+          window.showErrorMessage(err.toString())
+        }
+      }),
+
+    commands.registerCommand(Commands.delete_key,
+      async ({ node }: LocaleTreeItem) => {
+        let records: LocaleRecord[] = []
+
+        if (node.type === 'tree')
+          return
+
+        else if (node.type === 'record')
+          records = [node]
+
+        else
+          records = Object.values(node.locales)
+
+        try {
+          await Global.loader.writeToFile(records.map(record => ({
+            value: undefined,
+            keypath: record.keypath,
+            filepath: record.filepath,
+            locale: record.locale,
+          })))
+        }
+        catch (err) {
+          window.showErrorMessage(err.toString())
+        }
+      }),
   ]
 }
 

src/core/Commands.ts

@@ -11,6 +11,8 @@ export enum Commands {
   translate_key = 'extension.vue-i18n-ally.translate-key',
   edit_key = 'extension.vue-i18n-ally.edit-key',
   open_key = 'extension.vue-i18n-ally.open-key',
+  delete_key = 'extension.vue-i18n-ally.delete-key',
+  rename_key = 'extension.vue-i18n-ally.rename-key',
   locale_visibility_toggle = 'extension.vue-i18n-ally.locale-visibility-toggle',
   locale_visibility_show = 'extension.vue-i18n-ally.locale-visibility-show',
   locale_visibility_hide = 'extension.vue-i18n-ally.locale-visibility-hide',

src/core/LocaleLoader.ts

@@ -8,6 +8,7 @@ import { MachinTranslate } from './MachineTranslate'
 import { getKeyname, getFileInfo, replaceLocalePath, notEmpty } from './utils'
 import { LocaleTree, ParsedFile, FlattenLocaleTree, Coverage, LocaleNode, LocaleRecord, PendingWrite } from './types'
 import { AllyError, ErrorType } from './Errors'
+import { load } from 'js-yaml'
 
 function newTree (keypath = '', values = {}): LocaleTree {
   return {
@@ -298,12 +299,25 @@ export class LocaleLoader extends Disposable {
     await parser.save(filepath, original)
   }
 
+  private _ignoreChanges = false
   async writeToFile (pendings: PendingWrite|PendingWrite[]) {
+    this._ignoreChanges = true
     if (!Array.isArray(pendings))
       pendings = [pendings]
     pendings = pendings.filter(i => i)
-    for (const pending of pendings)
-      await this.writeToSingleFile(pending)
+    try {
+      for (const pending of pendings)
+        await this.writeToSingleFile(pending)
+    }
+    catch (e) {
+      this._ignoreChanges = false
+      throw e
+    }
+    this._ignoreChanges = false
+    for (const pending of pendings) {
+      if (pending.filepath)
+        await this.loadFile(pending.filepath)
+    }
   }
 
   private async loadFile (filepath: string) {
@@ -362,6 +376,8 @@ export class LocaleLoader extends Disposable {
     const watcher = workspace.createFileSystemWatcher(`${rootPath}/**`)
 
     const updateFile = async (type: string, { fsPath: filepath }: { fsPath: string }) => {
+      if (this._ignoreChanges)
+        return
       filepath = path.resolve(filepath)
       const { ext } = path.parse(filepath)
       if (!Global.getMatchedParser(ext))

src/core/types.ts

@@ -62,7 +62,7 @@ export interface PendingWrite {
   locale: string
   keypath: string
   filepath?: string
-  value: string
+  value?: string
 }
 
 export interface ExtractTextOptions {