feat: Add ignorePath option in cli (infuse, squeeze) v2 version (#151)

* feat: Add ignore option in cli (infuse, squeeze)

* fix: utils & ignore option test

* fix: lint

* feat: infuse ignore test

Author: shota-kizawa

package.json

@@ -31,13 +31,15 @@
     "deepmerge": "^4.2.2",
     "flat": "^5.0.0",
     "glob": "^7.1.4",
+    "ignore": "^5.1.8",
     "js-yaml": "^3.13.1",
     "json-diff": "^0.5.4",
     "json5": "^2.1.0",
     "vue-template-compiler": "^2.6.10",
     "yargs": "^15.1.0"
   },
   "devDependencies": {
+    "@sucrase/jest-plugin": "^2.1.0",
     "@types/debug": "^4.1.4",
     "@types/deep-diff": "^1.0.0",
     "@types/deepmerge": "^2.2.0",
@@ -49,7 +51,6 @@
     "@types/node": "^12.6.8",
     "@types/prettier": "^2.0.0",
     "@types/yargs": "^15.0.0",
-    "@sucrase/jest-plugin": "^2.1.0",
     "@typescript-eslint/eslint-plugin": "^3.0.0",
     "@typescript-eslint/parser": "^3.0.0",
     "eslint": "^7.4.0",

src/commands/infuse.ts

@@ -34,6 +34,7 @@ type InfuseOptions = {
   unbundleMatch?: string
   namespace?: string
   dryRun: boolean
+  ignorePath?: string
 }
 
 export const command = 'infuse'
@@ -80,6 +81,11 @@ export const builder = (args: Argv): Argv<InfuseOptions> => {
       default: false,
       describe: 'run the infuse command, but do not apply them'
     })
+    .option('ignorePath', {
+      type: 'string',
+      alias: 'i',
+      describe: 'path to dot ignore file, i.e. ./.ignore-i18n'
+    })
 }
 
 export const handler = async (args: Arguments<InfuseOptions>) => {
@@ -96,7 +102,7 @@ export const handler = async (args: Arguments<InfuseOptions>) => {
   }
   debug('namespace dictionary:', nsDictionary)
 
-  const sources = readSFC(targetPath)
+  const sources = readSFC(targetPath, args.ignorePath)
   const messages = readLocaleMessages(messagesPath, args.match)
 
   const { sfc, external } = splitLocaleMessages(messages, nsDictionary, args.unbundleTo, args.unbundleMatch)

src/commands/squeeze.ts

@@ -27,6 +27,7 @@ type SqueezeOptions = {
   bundleMatch?: string
   namespace?: string
   output: string
+  ignorePath?: string
 }
 
 export const command = 'squeeze'
@@ -69,6 +70,11 @@ export const builder = (args: Argv): Argv<SqueezeOptions> => {
       default: outputDefault,
       describe: 'path to output squeezed locale messages'
     })
+    .option('ignorePath', {
+      type: 'string',
+      alias: 'i',
+      describe: 'path to dot ignore file, i.e. ./.ignore-i18n'
+    })
 }
 
 export const handler = async (args: Arguments<SqueezeOptions>) => {
@@ -85,7 +91,7 @@ export const handler = async (args: Arguments<SqueezeOptions>) => {
     console.warn('cannot load external locale messages failed')
   }
 
-  const meta = squeeze(targetPath, readSFC(targetPath))
+  const meta = squeeze(targetPath, readSFC(targetPath, args.ignorePath))
   const messages = deepmerge(generate(meta), externalMessages)
 
   writeLocaleMessages(messages, args)

src/utils.ts

@@ -28,6 +28,8 @@ import JSON5 from 'json5'
 import yaml from 'js-yaml'
 import deepmerge from 'deepmerge'
 import { promisify } from 'util'
+import ignore from 'ignore'
+import type { Ignore } from 'ignore'
 
 import { debug as Debug } from 'debug'
 const debug = Debug('vue-i18n-locale-message:utils')
@@ -139,15 +141,26 @@ export function stringifyContent (content: any, lang: string, options?: FormatOp
   return result
 }
 
-export function readSFC (target: string): SFCFileInfo[] {
-  const targets = resolveGlob(target)
+export function readSFC (target: string, ignorePath?: string): SFCFileInfo[] {
+  let targets = resolveGlob(target)
+  if ((ignorePath !== undefined)) {
+    const ig = returnIgnoreInstance(ignorePath)
+    targets = targets.filter(t => {
+      if (path.isAbsolute(t)) {
+        console.debug('Target is absolute path. Please change relative path.')
+        return !ig.ignores(path.relative('/', t))
+      } else {
+        return !ig.ignores(path.relative('./', t))
+      }
+    })
+  }
   debug('readSFC: targets = ', targets)
 
   // TODO: async implementation
-  return targets.map(target => {
-    const data = fs.readFileSync(target)
+  return targets.map(t => {
+    const data = fs.readFileSync(t)
     return {
-      path: target,
+      path: t,
       content: data.toString()
     }
   })
@@ -420,3 +433,30 @@ export function splitLocaleMessages (
 
   return { sfc: messages, external: metaExternalLocaleMessages }
 }
+
+function returnIgnoreInstance (ignorePath: string): Ignore {
+  const ig = ignore()
+  if (fs.existsSync(ignorePath)) {
+    addIgnoreFile(ig, ignorePath)
+  } else {
+    console.warn('cannot find ignore file.')
+  }
+  return ig
+}
+
+function readIgnoreFile (ignorePath: string): string[] {
+  const ignoreFiles = fs.readFileSync(ignorePath, 'utf8')
+    .split(/\r?\n/g)
+    .filter(Boolean)
+  console.log(`ignoreFiles ${ignoreFiles}`)
+  return ignoreFiles
+}
+
+function addIgnoreFile (
+  ig: Ignore,
+  ignorePath: string
+): void {
+  readIgnoreFile(ignorePath).forEach(ignoreRule =>
+    ig.add(ignoreRule)
+  )
+}

test/commands/__snapshots__/infuse.test.ts.snap

@@ -250,6 +250,87 @@ Object {
 }
 `;
 
+exports[`ignore option: /path/to/project1/src/App.vue 1`] = `
+"
+  <template>
+    <p>template</p>
+  </template>
+  
+  <script>
+  export default {}
+  </script>
+
+  <i18n>
+{
+  \\"en\\": {
+    \\"title\\": \\"Application\\"
+  },
+  \\"ja\\": {
+    \\"title\\": \\"アプリケーション\\"
+  }
+}
+</i18n>
+  "
+`;
+
+exports[`ignore option: /path/to/project1/src/components/Modal.vue 1`] = `
+"
+  <template>
+    <p>template</p>
+  </template>
+  
+  <script>
+  export default {}
+  </script>
+
+  <i18n locale=\\"en\\">
+{
+  \\"ok\\": \\"OK\\",
+  \\"cancel\\": \\"Cancel\\"
+}
+</i18n>
+  
+  <i18n locale=\\"ja\\">
+{
+  \\"ok\\": \\"OK\\",
+  \\"cancel\\": \\"キャンセル\\"
+}
+</i18n>
+  "
+`;
+
+exports[`ignore option: /path/to/project1/src/components/nest/RankingTable.vue 1`] = `
+"
+  <template>
+    <p>template</p>
+  </template>
+  
+  <script>
+  export default {}
+  </script>
+
+  <i18n locale=\\"en\\">
+{
+  \\"headers\\": {
+    \\"rank\\": \\"Rank\\",
+    \\"name\\": \\"Name\\",
+    \\"score\\": \\"Score\\"
+  }
+}
+</i18n>
+  
+
+<i18n locale=\\"ja\\">
+{
+  \\"headers\\": {
+    \\"rank\\": \\"ランク\\",
+    \\"name\\": \\"名前\\",
+    \\"score\\": \\"スコア\\"
+  }
+}
+</i18n>"
+`;
+
 exports[`match option: /path/to/project1/src/App.vue 1`] = `
 "
   <template>

test/commands/__snapshots__/squeeze.test.ts.snap

@@ -113,6 +113,44 @@ Object {
 }
 `;
 
+exports[`ignore option 1`] = `
+Object {
+  "/path/to/project1/locales": "{
+  \\"en\\": {
+    \\"App\\": {
+      \\"title\\": \\"Application\\"
+    },
+    \\"components\\": {
+      \\"Modal\\": {
+        \\"ok\\": \\"OK\\",
+        \\"cancel\\": \\"Cancel\\"
+      },
+      \\"nest\\": {
+        \\"RankingTable\\": {
+          \\"headers\\": {
+            \\"rank\\": \\"Rank\\",
+            \\"name\\": \\"Name\\",
+            \\"score\\": \\"Score\\"
+          }
+        }
+      }
+    }
+  },
+  \\"ja\\": {
+    \\"App\\": {
+      \\"title\\": \\"アプリケーション\\"
+    },
+    \\"components\\": {
+      \\"Modal\\": {
+        \\"ok\\": \\"OK\\",
+        \\"cancel\\": \\"キャンセル\\"
+      }
+    }
+  }
+}",
+}
+`;
+
 exports[`relative path 1`] = `
 Object {
   "/path/to/project1/locales-1.json": "{

test/commands/infuse.test.ts

@@ -24,6 +24,7 @@ const MOCK_FILES = SFC_FILES.reduce((files, file) => {
   const meta = jsonMetaInfo.find(meta => meta.contentPath === file)
   return Object.assign(files, { [file]: meta.raw })
 }, {})
+const MOCK_IGNORE_FILES = '**/Login.vue'
 
 let orgCwd // for process.cwd mock
 
@@ -41,7 +42,8 @@ import * as utils from '../../src/utils'
 jest.mock('fs', () => ({
   ...jest.requireActual('fs'),
   readFileSync: jest.fn(),
-  writeFileSync: jest.fn()
+  writeFileSync: jest.fn(),
+  existsSync: jest.fn().mockImplementation(path => true)
 }))
 import fs from 'fs'
 
@@ -270,3 +272,38 @@ test('bundle option', async () => {
 
   expect(output).toMatchSnapshot()
 })
+
+test('ignore option', async () => {
+  // setup mocks
+  const mockUtils = utils as jest.Mocked<typeof utils>
+  mockUtils.resolve.mockImplementation((...paths) => paths[0])
+  mockUtils.loadNamespaceDictionary.mockImplementation(async () => ({}))
+  mockUtils.splitLocaleMessages.mockImplementation((messages) => ({ sfc: messages }))
+  const writeFiles = {}
+  const mockFS = fs as jest.Mocked<typeof fs>
+  mockFS.readFileSync.mockImplementation(path => {
+    if (MOCK_FILES[path as string]) {
+      return MOCK_FILES[path as string]
+    } else {
+      return JSON.stringify(json)
+    }
+  })
+  mockFS.writeFileSync.mockImplementation((path, data) => {
+    writeFiles[path as string] = data.toString()
+  })
+  mockFS.readFileSync.mockImplementationOnce(path => MOCK_IGNORE_FILES);
+
+  // run
+  const infuse = await import('../../src/commands/infuse')
+  const cmd = yargs.command(infuse)
+  const output = await new Promise(resolve => {
+    cmd.parse(`infuse --target=${TARGET_PATH}/src --locales=${TARGET_PATH}/locales.json --ignorePath=./test/fixtures/.ignore-i18n`, () => {
+      resolve(writeFiles)
+    })
+  })
+
+  // check
+  for (const [key, value] of Object.entries(output)) {
+    expect(value).toMatchSnapshot(key)
+  }
+})

test/commands/squeeze.test.ts

@@ -1,4 +1,5 @@
 import * as yargs from 'yargs'
+import * as fs from 'fs';
 import jsonMetaInfo from '../fixtures/meta/json'
 import external from '../fixtures/external'
 
@@ -16,6 +17,7 @@ const MOCK_FILES = SFC_FILES.reduce((files, file) => {
   const meta = jsonMetaInfo.find(meta => meta.contentPath === file)
   return Object.assign(files, { [file]: meta.raw })
 }, {})
+const MOCK_IGNORE_FILES = '**/Login.vue'
 let writeFiles = {} // for fs mock
 let orgCwd // for process.cwd mock
 
@@ -39,7 +41,8 @@ jest.mock('fs', () => ({
   writeFileSync: jest.fn().mockImplementation((path, data) => {
     writeFiles[path as string] = data.toString()
   }),
-  mkdirSync: jest.fn().mockImplementation(path => {})
+  mkdirSync: jest.fn().mockImplementation(path => {}),
+  existsSync: jest.fn().mockImplementation(path => true)
 }))
 
 // -------------------
@@ -157,3 +160,22 @@ test('bundle options', async () => {
 
   expect(output).toMatchSnapshot()
 })
+
+test('ignore option', async () => {
+  const mockUtils = utils as jest.Mocked<typeof utils>
+  mockUtils.resolve.mockImplementation((...paths) => paths[0])
+  mockUtils.loadNamespaceDictionary.mockImplementation(async () => ({}))
+  mockUtils.getExternalLocaleMessages.mockImplementation(() => ({}))
+  const mockFS = fs as jest.Mocked<typeof fs>
+  mockFS.readFileSync.mockImplementationOnce(path => MOCK_IGNORE_FILES);
+
+  const squeeze = await import('../../src/commands/squeeze')
+  const cmd = yargs.command(squeeze)
+  const output = await new Promise(resolve => {
+    cmd.parse(`squeeze --target=${TARGET_PATH}/src --output=${TARGET_PATH}/locales --ignorePath=./test/fixtures/.ignore-i18n`, () => {
+      resolve(writeFiles)
+    })
+  })
+
+  expect(output).toMatchSnapshot()
+})

test/fixtures/.ignore-i18n

@@ -0,0 +1 @@
+**/Login.vue