👕 refactor: locale messages menagements

Author: kazupon

README.md

@@ -29,7 +29,7 @@ Details changes for each release are documented in the [CHANGELOG.md](https://gi
 - [ ] valid-message-syntax
 - [ ] no-raw-text
 - [ ] keys-order
-- [ ] locale messages caching
+- [x] locale messages caching
 - [ ] replace documentation example with `eslint-playground` component
 
 ## :copyright: License

lib/rules/no-html-messages.js

@@ -4,50 +4,16 @@
 'use strict'
 
 const { extname } = require('path')
-const jsonAstParse = require('json-to-ast')
 const parse5 = require('parse5')
-const { UNEXPETECD_ERROR_LOCATION, loadLocaleMessages } = require('../utils/index')
+const {
+  UNEXPETECD_ERROR_LOCATION,
+  findExistLocaleMessage,
+  getLocaleMessages,
+  extractJsonInfo,
+  generateJsonAst
+} = require('../utils/index')
 const debug = require('debug')('eslint-plugin-vue-i18n:no-html-messages')
 
-let localeMessages = null // used locale messages
-let localeDir = null
-
-function findExistLocaleMessage (fullpath, localeMessages) {
-  return localeMessages.find(message => message.fullpath === fullpath)
-}
-
-function extractJsonInfo (context, node) {
-  try {
-    const [str, filename] = node.comments
-    return [
-      Buffer.from(str.value, 'base64').toString(),
-      Buffer.from(filename.value, 'base64').toString()
-    ]
-  } catch (e) {
-    context.report({
-      loc: UNEXPETECD_ERROR_LOCATION,
-      message: e.message
-    })
-    return []
-  }
-}
-
-function generateJsonAst (context, json, filename) {
-  let ast = null
-
-  try {
-    ast = jsonAstParse(json, { loc: true, source: filename })
-  } catch (e) {
-    const { message, line, column } = e
-    context.report({
-      message,
-      loc: { line, column }
-    })
-  }
-
-  return ast
-}
-
 function traverseNode (node, fn) {
   if (node.type === 'Object' && node.children.length > 0) {
     node.children.forEach(child => {
@@ -88,14 +54,7 @@ function create (context) {
     return {}
   }
 
-  if (localeDir !== settings['vue-i18n'].localeDir) {
-    debug(`change localeDir: ${localeDir} -> ${settings['vue-i18n'].localeDir}`)
-    localeDir = settings['vue-i18n'].localeDir
-    localeMessages = loadLocaleMessages(localeDir)
-  } else {
-    localeMessages = localeMessages || loadLocaleMessages(settings['vue-i18n'].localeDir)
-  }
-
+  const localeMessages = getLocaleMessages(settings['vue-i18n'].localeDir)
   const targetLocaleMessage = findExistLocaleMessage(filename, localeMessages)
   if (!targetLocaleMessage) {
     debug(`ignore ${filename} in no-html-messages`)

lib/rules/no-missing-keys.js

@@ -6,12 +6,10 @@
 const {
   UNEXPETECD_ERROR_LOCATION,
   defineTemplateBodyVisitor,
-  loadLocaleMessages,
+  getLocaleMessages,
   findMissingsFromLocaleMessages
 } = require('../utils/index')
 
-let localeMessages = null // cache
-
 function create (context) {
   const { settings } = context
   if (!settings['vue-i18n'] || !settings['vue-i18n'].localeDir) {
@@ -23,7 +21,7 @@ function create (context) {
   }
 
   const localeDir = settings['vue-i18n'].localeDir
-  localeMessages = localeMessages || loadLocaleMessages(localeDir)
+  const localeMessages = getLocaleMessages(localeDir)
 
   return defineTemplateBodyVisitor(context, {
     "VAttribute[directive=true][key.name='t']" (node) {

lib/rules/no-unused-keys.js

@@ -4,52 +4,19 @@
 'use strict'
 
 const { extname } = require('path')
-const jsonAstParse = require('json-to-ast')
 const jsonDiffPatch = require('jsondiffpatch').create({})
 const flatten = require('flat')
 const collectKeys = require('../utils/collect-keys')
-const { UNEXPETECD_ERROR_LOCATION, loadLocaleMessages } = require('../utils/index')
+const {
+  UNEXPETECD_ERROR_LOCATION,
+  findExistLocaleMessage,
+  getLocaleMessages,
+  extractJsonInfo,
+  generateJsonAst
+} = require('../utils/index')
 const debug = require('debug')('eslint-plugin-vue-i18n:no-unused-keys')
 
 let usedLocaleMessageKeys = null // used locale message keys
-let localeMessages = null // used locale messages
-let localeDir = null
-
-function findExistLocaleMessage (fullpath, localeMessages) {
-  return localeMessages.find(message => message.fullpath === fullpath)
-}
-
-function extractJsonInfo (context, node) {
-  try {
-    const [str, filename] = node.comments
-    return [
-      Buffer.from(str.value, 'base64').toString(),
-      Buffer.from(filename.value, 'base64').toString()
-    ]
-  } catch (e) {
-    context.report({
-      loc: UNEXPETECD_ERROR_LOCATION,
-      message: e.message
-    })
-    return []
-  }
-}
-
-function generateJsonAst (context, json, filename) {
-  let ast = null
-
-  try {
-    ast = jsonAstParse(json, { loc: true, source: filename })
-  } catch (e) {
-    const { message, line, column } = e
-    context.report({
-      message,
-      loc: { line, column }
-    })
-  }
-
-  return ast
-}
 
 function getUnusedKeys (context, json, usedkeys) {
   let unusedKeys = []
@@ -121,14 +88,7 @@ function create (context) {
     return {}
   }
 
-  if (localeDir !== settings['vue-i18n'].localeDir) {
-    debug(`change localeDir: ${localeDir} -> ${settings['vue-i18n'].localeDir}`)
-    localeDir = settings['vue-i18n'].localeDir
-    localeMessages = loadLocaleMessages(localeDir)
-  } else {
-    localeMessages = localeMessages || loadLocaleMessages(settings['vue-i18n'].localeDir)
-  }
-
+  const localeMessages = getLocaleMessages(settings['vue-i18n'].localeDir)
   const targetLocaleMessage = findExistLocaleMessage(filename, localeMessages)
   if (!targetLocaleMessage) {
     debug(`ignore ${filename} in no-unused-keys`)

lib/utils/index.js

@@ -6,6 +6,7 @@
 
 const glob = require('glob')
 const { resolve } = require('path')
+const jsonAstParse = require('json-to-ast')
 
 const UNEXPETECD_ERROR_LOCATION = { line: 1, column: 0 }
 
@@ -25,6 +26,10 @@ function defineTemplateBodyVisitor (context, templateBodyVisitor, scriptVisitor)
   return context.parserServices.defineTemplateBodyVisitor(templateBodyVisitor, scriptVisitor)
 }
 
+function findExistLocaleMessage (fullpath, localeMessages) {
+  return localeMessages.find(message => message.fullpath === fullpath)
+}
+
 function loadLocaleMessages (pattern) {
   const files = glob.sync(pattern)
   return files.map(file => {
@@ -35,6 +40,19 @@ function loadLocaleMessages (pattern) {
   })
 }
 
+let localeMessages = null // locale messages
+let localeDir = null // locale dir
+
+function getLocaleMessages (localeDirectory) {
+  if (localeDir !== localeDirectory) {
+    localeDir = localeDirectory
+    localeMessages = loadLocaleMessages(localeDir)
+  } else {
+    localeMessages = localeMessages || loadLocaleMessages(localeDir)
+  }
+  return localeMessages
+}
+
 function findMissingsFromLocaleMessages (localeMessages, key) {
   const missings = []
   const paths = key.split('.')
@@ -56,9 +74,44 @@ function findMissingsFromLocaleMessages (localeMessages, key) {
   return missings
 }
 
+function extractJsonInfo (context, node) {
+  try {
+    const [str, filename] = node.comments
+    return [
+      Buffer.from(str.value, 'base64').toString(),
+      Buffer.from(filename.value, 'base64').toString()
+    ]
+  } catch (e) {
+    context.report({
+      loc: UNEXPETECD_ERROR_LOCATION,
+      message: e.message
+    })
+    return []
+  }
+}
+
+function generateJsonAst (context, json, filename) {
+  let ast = null
+
+  try {
+    ast = jsonAstParse(json, { loc: true, source: filename })
+  } catch (e) {
+    const { message, line, column } = e
+    context.report({
+      message,
+      loc: { line, column }
+    })
+  }
+
+  return ast
+}
+
 module.exports = {
   UNEXPETECD_ERROR_LOCATION,
   defineTemplateBodyVisitor,
-  loadLocaleMessages,
-  findMissingsFromLocaleMessages
+  getLocaleMessages,
+  findMissingsFromLocaleMessages,
+  findExistLocaleMessage,
+  extractJsonInfo,
+  generateJsonAst
 }