fix: ignore files when using bundle option (#158)

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

* fix: utils & ignore option test

* fix: lint

* feat: infuse ignore test

* fix: path relative

* fix: ignore files when using bundle option

Author: shota-kizawa

src/commands/infuse.ts

@@ -5,7 +5,9 @@ import {
   parsePath,
   readSFC,
   loadNamespaceDictionary,
-  splitLocaleMessages
+  splitLocaleMessages,
+  readIgnoreFile,
+  returnIgnoreInstance
 } from '../utils'
 
 import infuse from '../infuser'
@@ -24,6 +26,7 @@ import {
 } from '../../types'
 
 import { debug as Debug } from 'debug'
+import ignore from 'ignore'
 const debug = Debug('vue-i18n-locale-message:commands:infuse')
 
 type InfuseOptions = {
@@ -91,6 +94,11 @@ export const builder = (args: Argv): Argv<InfuseOptions> => {
 export const handler = async (args: Arguments<InfuseOptions>) => {
   const targetPath = resolve(args.target)
   const messagesPath = resolve(args.locales)
+  const ig = ignore()
+  if (args.ignorePath && fs.existsSync(args.ignorePath)) {
+    const ignoreFiles = readIgnoreFile(args.ignorePath)
+    returnIgnoreInstance(ig, ignoreFiles)
+  }
 
   let nsDictionary = {} as NamespaceDictionary
   try {
@@ -102,7 +110,7 @@ export const handler = async (args: Arguments<InfuseOptions>) => {
   }
   debug('namespace dictionary:', nsDictionary)
 
-  const sources = readSFC(targetPath, args.ignorePath)
+  const sources = readSFC(targetPath, ig)
   const messages = readLocaleMessages(messagesPath, args.match)
 
   const { sfc, external } = splitLocaleMessages(messages, nsDictionary, args.unbundleTo, args.unbundleMatch)

src/commands/squeeze.ts

@@ -4,7 +4,9 @@ import {
   parsePath,
   readSFC,
   loadNamespaceDictionary,
-  getExternalLocaleMessages
+  getExternalLocaleMessages,
+  readIgnoreFile,
+  returnIgnoreInstance
 } from '../utils'
 import squeeze from '../squeezer'
 import fs from 'fs'
@@ -18,6 +20,7 @@ import {
 } from '../../types'
 
 import { debug as Debug } from 'debug'
+import ignore from 'ignore'
 const debug = Debug('vue-i18n-locale-message:commands:squeeze')
 
 type SqueezeOptions = {
@@ -82,16 +85,21 @@ export const handler = async (args: Arguments<SqueezeOptions>) => {
 
   let nsDictionary = {} as NamespaceDictionary
   let externalMessages = {} as LocaleMessages
+  const ig = ignore()
+  if (args.ignorePath && fs.existsSync(args.ignorePath)) {
+    const ignoreFiles = readIgnoreFile(args.ignorePath)
+    returnIgnoreInstance(ig, ignoreFiles)
+  }
   try {
     if (args.namespace) {
       nsDictionary = await loadNamespaceDictionary(args.namespace)
     }
-    externalMessages = getExternalLocaleMessages(nsDictionary, args.bundleWith, args.bundleMatch)
+    externalMessages = getExternalLocaleMessages(nsDictionary, ig, args.bundleWith, args.bundleMatch)
   } catch (e) {
     console.warn('cannot load external locale messages failed')
   }
 
-  const meta = squeeze(targetPath, readSFC(targetPath, args.ignorePath))
+  const meta = squeeze(targetPath, readSFC(targetPath, ig))
   const messages = deepmerge(generate(meta), externalMessages)
 
   writeLocaleMessages(messages, args)

src/utils.ts

@@ -26,7 +26,6 @@ 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'
@@ -134,18 +133,15 @@ export function stringifyContent (content: any, lang: string, options?: FormatOp
   return result
 }
 
-export function readSFC (target: string, ignorePath?: string): SFCFileInfo[] {
-  let targets = resolveGlob(path.relative(process.cwd(), target))
-  if ((ignorePath !== undefined)) {
-    const ig = returnIgnoreInstance(ignorePath)
-    targets = targets.filter(t => {
-      return !ig.ignores(path.relative(process.cwd(), t))
-    })
-  }
-  debug('readSFC: targets = ', targets)
+export function readSFC (target: string, ig: Ignore): SFCFileInfo[] {
+  const targets = resolveGlob(target)
+  const cookedTargets = targets.filter(t => {
+    return !ig.ignores(path.relative(process.cwd(), t))
+  }).map(p => path.resolve(p))
+  debug('readSFC: targets = ', cookedTargets)
 
   // TODO: async implementation
-  return targets.map(t => {
+  return cookedTargets.map(t => {
     const data = fs.readFileSync(t)
     return {
       path: t,
@@ -155,8 +151,9 @@ export function readSFC (target: string, ignorePath?: string): SFCFileInfo[] {
 }
 
 function resolveGlob (target: string) {
+  const relativeTarget = path.relative(process.cwd(), target)
   // TODO: async implementation
-  return glob.sync(`${target}/**/*.vue`)
+  return glob.sync(`${relativeTarget}/**/*.vue`)
 }
 
 export const DEFUALT_CONF = { provider: {}} as ProviderConfiguration
@@ -337,14 +334,16 @@ function getLocaleMessagePathInfo (fullPath: string, bundleMatch?: string): Pars
 }
 
 export function getExternalLocaleMessages (
-  dictionary: NamespaceDictionary, bundleWith?: string, bundleMatch?: string
+  dictionary: NamespaceDictionary, ig: Ignore, bundleWith?: string, bundleMatch?: string
 ) {
   if (!bundleWith) { return {} }
 
   const bundleTargetPaths = bundleWith.split(',').filter(p => p)
   return bundleTargetPaths.reduce((messages, targetPath) => {
     const namespace = dictionary[targetPath] || ''
-    const globedPaths = glob.sync(targetPath).map(p => resolve(p))
+    const globedPaths = glob.sync(path.relative(process.cwd(), targetPath)).filter(t => {
+      return !ig.ignores(t)
+    }).map(p => resolve(p))
     return globedPaths.reduce((messages, fullPath) => {
       const { locale, filename } = getLocaleMessagePathInfo(fullPath, bundleMatch)
       if (!locale) { return messages }
@@ -422,29 +421,16 @@ 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[] {
+export 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 =>
+export function returnIgnoreInstance (ig: Ignore, ignoreFiles: string[]): void {
+  ignoreFiles.forEach(ignoreRule => {
     ig.add(ignoreRule)
-  )
+  })
 }

test/commands/infuse.test.ts

@@ -55,6 +55,7 @@ jest.mock('glob', () => ({ sync: jest.fn((pattern) => {
     return SFC_FILES
   }
 }) }))
+import * as glob from "glob"
 
 // -------------------
 // setup/teadown hooks

test/utils.test.ts

@@ -13,6 +13,8 @@ import {
   splitLocaleMessages
 } from '../src/utils'
 
+import ignore from 'ignore'
+
 // ------
 // mocks
 
@@ -63,23 +65,26 @@ test('getExternalLocaleMessages: basic usage', async () => {
   }
   const withBundle = './test/fixtures/packages/package1/locales/**/*.json,./test/fixtures/packages/package2/locales/**/*.json'
   const withBundleMatch = '([\\w]*)/([\\w]*)\\.json$'
-  const messages = getExternalLocaleMessages(namespaces, withBundle, withBundleMatch)
+  const ig = ignore()
+  const messages = getExternalLocaleMessages(namespaces, ig, withBundle, withBundleMatch)
 
   expect(messages).toMatchSnapshot()
 })
 
 test('getExternalLocaleMessages: no namespace', async () => {
   const withBundle = './test/fixtures/packages/package1/locales/**/*.json,./test/fixtures/packages/package2/locales/**/*.json'
   const withBundleMatch = '([\\w]*)/([\\w]*)\\.json$'
-  const messages = getExternalLocaleMessages({}, withBundle, withBundleMatch)
+  const ig = ignore()
+  const messages = getExternalLocaleMessages({}, ig, withBundle, withBundleMatch)
 
   expect(messages).toMatchSnapshot()
 })
 
 test('getExternalLocaleMessages: no filename', async () => {
   const withBundle = './test/fixtures/packages/package1/locales/**/*.json,./test/fixtures/packages/package2/locales/**/*.json'
   const withBundleMatch = '([\\w]*)/[\\w]*\\.json$'
-  const messages = getExternalLocaleMessages({}, withBundle, withBundleMatch)
+  const ig = ignore()
+  const messages = getExternalLocaleMessages({}, ig, withBundle, withBundleMatch)
 
   expect(messages).toMatchSnapshot()
 })
@@ -89,7 +94,8 @@ test('getExternalLocaleMessages: no bundle option', async () => {
     './test/fixtures/packages/package1/locales/**/*.json': 'package1',
     './test/fixtures/packages/package2/locales/**/*.json': 'package2'
   }
-  const messages = getExternalLocaleMessages(namespaces)
+  const ig = ignore()
+  const messages = getExternalLocaleMessages(namespaces, ig)
 
   expect(messages).toMatchObject({})
 })