Merge pull request #227 from vuejs/feat/support-custom-i18n-blocks-natively

feat: add support for custom blocks by default

Author: JessicaSachs

README.md

@@ -67,8 +67,65 @@ vue-jest compiles the script and template of SFCs into a JavaScript file that Je
 
 You can change the behavior of `vue-jest` by using `jest.globals`.
 
+#### Supporting custom blocks
+
+A great feature of the Vue SFC compiler is that it can support custom blocks. You might want to use those blocks in your tests. To render out custom blocks for testing purposes, you'll need to write a transformer. Once you have your transformer, you'll add an entry to vue-jest's transform map. This is how [vue-i18n's](https://github.com/kazupon/vue-i18n) `<i18n>` custom blocks are supported in unit tests.
+
+A `package.json` Example
+
+```json
+{
+  "jest": {
+    "moduleFileExtensions": ["js", "json", "vue"],
+    "transform": {
+      "^.+\\.js$": "babel-jest",
+      "^.+\\.vue$": "vue-jest"
+    },
+    "globals": {
+      "vue-jest": {
+        "transform": {
+          "your-custom-block": "./custom-block-processor.js"
+        }
+      }
+    }
+  }
+}
+```
+
 > _Tip:_ Need programmatic configuration? Use the [--config](https://jestjs.io/docs/en/cli.html#config-path) option in Jest CLI, and export a `.js` file
 
+A `jest.config.js` Example - If you're using a dedicated configuration file like you can reference and require your processor in the config file instead of using a file reference.
+
+```js
+module.exports = {
+  globals: {
+    'vue-jest': {
+      transform: {
+        'your-custom-block': require('./custom-block-processor')
+      }
+    }
+  }
+}
+```
+
+#### Writing a processor
+
+Processors must return an object with a "process" method, like so...
+
+```js
+module.exports = {
+  /**
+   * Process the content inside of a custom block and prepare it for execution in a testing environment
+   * @param {SFCCustomBlock[]} blocks All of the blocks matching your type, returned from `@vue/component-compiler-utils`
+   * @param {string} vueOptionsNamespace The internal namespace for a component's Vue Options in vue-jest
+   * @param {string} filename The SFC file being processed
+   * @param {Object} config The full Jest config
+   * @returns {string} The code to be output after processing all of the blocks matched by this type
+   */
+  process(blocks, vueOptionsNamepsace, filename, config) {}
+}
+```
+
 #### babelConfig
 
 Provide `babelConfig` in one of the following formats:

lib/constants.js

@@ -0,0 +1,6 @@
+module.exports = {
+  vueOptionsNamespace: '__options__',
+  defaultVueJestConfig: {
+    transform: {}
+  }
+}

lib/generate-code.js

@@ -1,9 +1,12 @@
+const namespace = require('./constants').vueOptionsNamespace
+
 const splitRE = /\r?\n/g
 
 module.exports = function generateCode(
   scriptResult,
   templateResult,
   stylesResult,
+  customBlocksResult,
   isFunctional
 ) {
   let output = ''
@@ -21,7 +24,7 @@ module.exports = function generateCode(
   }
 
   output +=
-    `var __options__ = typeof exports.default === 'function' ` +
+    `var ${namespace} = typeof exports.default === 'function' ` +
     `? exports.default.options ` +
     `: exports.default\n`
 
@@ -37,11 +40,11 @@ module.exports = function generateCode(
 
     output +=
       `__options__.render = render\n` +
-      `__options__.staticRenderFns = staticRenderFns\n`
+      `${namespace}.staticRenderFns = staticRenderFns\n`
 
     if (isFunctional) {
-      output += '__options__.functional = true\n'
-      output += '__options__._compiled = true\n'
+      output += `${namespace}.functional = true\n`
+      output += `${namespace}._compiled = true\n`
     }
   }
 
@@ -59,22 +62,26 @@ module.exports = function generateCode(
     if (isFunctional) {
       output +=
         `;(function() {\n` +
-        `  var originalRender = __options__.render\n` +
+        `  var originalRender = ${namespace}.render\n` +
         `  var styleFn = function () { ${styleStr} }\n` +
-        `  __options__.render = function renderWithStyleInjection (h, context) {\n` +
+        `  ${namespace}.render = function renderWithStyleInjection (h, context) {\n` +
         `    styleFn.call(context)\n` +
         `    return originalRender(h, context)\n` +
         `  }\n` +
         `})()\n`
     } else {
       output +=
         `;(function() {\n` +
-        `  var beforeCreate = __options__.beforeCreate\n` +
+        `  var beforeCreate = ${namespace}.beforeCreate\n` +
         `  var styleFn = function () { ${styleStr} }\n` +
-        `  __options__.beforeCreate = beforeCreate ? [].concat(beforeCreate, styleFn) : [styleFn]\n` +
+        `  ${namespace}.beforeCreate = beforeCreate ? [].concat(beforeCreate, styleFn) : [styleFn]\n` +
         `})()\n`
     }
   }
+
+  if (customBlocksResult) {
+    output += `;\n ${customBlocksResult}`
+  }
   return {
     code: output,
     renderFnStartLine,

lib/process-custom-blocks.js

@@ -0,0 +1,41 @@
+const { getVueJestConfig, getCustomTransformer } = require('./utils')
+const vueOptionsNamespace = require('./constants').vueOptionsNamespace
+
+function applyTransformer(
+  transformer,
+  blocks,
+  vueOptionsNamespace,
+  filename,
+  config
+) {
+  return transformer.process({ blocks, vueOptionsNamespace, filename, config })
+}
+
+function groupByType(acc, block) {
+  acc[block.type] = acc[block.type] || []
+  acc[block.type].push(block)
+  return acc
+}
+
+module.exports = function(allBlocks, filename, config) {
+  const blocksByType = allBlocks.reduce(groupByType, {})
+  const code = []
+  for (const [type, blocks] of Object.entries(blocksByType)) {
+    const transformer = getCustomTransformer(
+      getVueJestConfig(config).transform,
+      type
+    )
+    if (transformer) {
+      const codeStr = applyTransformer(
+        transformer,
+        blocks,
+        vueOptionsNamespace,
+        filename,
+        config
+      )
+      code.push(codeStr)
+    }
+  }
+
+  return code.length ? code.join('\n') : ''
+}

lib/process.js

@@ -2,9 +2,10 @@ const splitRE = /\r?\n/g
 
 const VueTemplateCompiler = require('vue-template-compiler')
 const generateSourceMap = require('./generate-source-map')
-const typescriptTransformer = require('./typescript-transformer')
-const coffeescriptTransformer = require('./coffee-transformer')
+const typescriptTransformer = require('./transformers/typescript')
+const coffeescriptTransformer = require('./transformers/coffee')
 const _processStyle = require('./process-style')
+const processCustomBlocks = require('./process-custom-blocks')
 const getVueJestConfig = require('./utils').getVueJestConfig
 const logResultErrors = require('./utils').logResultErrors
 const stripInlineSourceMap = require('./utils').stripInlineSourceMap
@@ -99,6 +100,11 @@ module.exports = function(src, filename, config) {
   const templateResult = processTemplate(descriptor.template, filename, config)
   const scriptResult = processScript(descriptor.script, filename, config)
   const stylesResult = processStyle(descriptor.styles, filename, config)
+  const customBlocksResult = processCustomBlocks(
+    descriptor.customBlocks,
+    filename,
+    config
+  )
 
   const isFunctional =
     descriptor.template &&
@@ -112,6 +118,7 @@ module.exports = function(src, filename, config) {
     scriptResult,
     templateResult,
     stylesResult,
+    customBlocksResult,
     isFunctional
   )
 

lib/coffee-transformer.js renamed to lib/transformers/coffee.js

@@ -1,6 +1,6 @@
-const ensureRequire = require('./ensure-require.js')
-const throwError = require('./utils').throwError
-const getBabelOptions = require('./utils').getBabelOptions
+const ensureRequire = require('../ensure-require.js')
+const throwError = require('../utils').throwError
+const getBabelOptions = require('../utils').getBabelOptions
 
 module.exports = {
   process(src, filename, config) {

lib/typescript-transformer.js renamed to lib/transformers/typescript.js

@@ -1,10 +1,12 @@
-const ensureRequire = require('./ensure-require')
+const ensureRequire = require('../ensure-require')
 const babelJest = require('babel-jest')
-const getBabelOptions = require('./utils').getBabelOptions
-const getTsJestConfig = require('./utils').getTsJestConfig
-const stripInlineSourceMap = require('./utils').stripInlineSourceMap
-const getCustomTransformer = require('./utils').getCustomTransformer
-const getVueJestConfig = require('./utils').getVueJestConfig
+const {
+  getBabelOptions,
+  getTsJestConfig,
+  stripInlineSourceMap,
+  getCustomTransformer,
+  getVueJestConfig
+} = require('../utils')
 
 module.exports = {
   process(scriptContent, filePath, config) {

lib/utils.js

@@ -1,3 +1,4 @@
+const constants = require('./constants')
 const loadPartialConfig = require('@babel/core').loadPartialConfig
 const chalk = require('chalk')
 const path = require('path')
@@ -83,19 +84,32 @@ const getCustomTransformer = function getCustomTransformer(
   transform = {},
   lang
 ) {
-  let transformerPath = fetchTransformer(lang, transform)
-  if (transformerPath) {
-    const transformer = require(resolvePath(transformerPath))
-
-    if (!isValidTransformer(transformer)) {
-      throwError(
-        `transformer must contain at least one process, preprocess, or ` +
-          `postprocess method`
-      )
-    }
-    return transformer
+  transform = { ...constants.defaultVueJestConfig.transform, ...transform }
+
+  const transformerPath = fetchTransformer(lang, transform)
+
+  if (!transformerPath) {
+    return null
   }
-  return null
+
+  let transformer
+  if (
+    typeof transformerPath === 'string' &&
+    require(resolvePath(transformerPath))
+  ) {
+    transformer = require(resolvePath(transformerPath))
+  } else if (typeof transformerPath === 'object') {
+    transformer = transformerPath
+  }
+
+  if (!isValidTransformer(transformer)) {
+    throwError(
+      `transformer must contain at least one process, preprocess, or ` +
+        `postprocess method`
+    )
+  }
+
+  return transformer
 }
 
 const throwError = function error(msg) {

package.json

@@ -58,6 +58,7 @@
     "stylus": "^0.54.5",
     "typescript": "^3.2.2",
     "vue": "^2.4.2",
+    "vue-i18n": "^8.15.5",
     "vue-template-compiler": "^2.4.2"
   },
   "peerDependencies": {
@@ -72,7 +73,8 @@
     "chalk": "^2.1.0",
     "convert-source-map": "^1.6.0",
     "extract-from-css": "^0.4.4",
-    "source-map": "^0.5.6",
+    "js-yaml": "^3.13.1",
+    "json5": "^2.1.1",
     "ts-jest": "^24.0.0"
   },
   "repository": {