@intlify/bundle-utils 12.0.0-alpha.3 → 12.0.0-alpha.4

package/lib/index.cjs

@@ -14,7 +14,20 @@ const yamlEslintParser = require('yaml-eslint-parser');
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
+  const n = Object.create(null);
+  if (e) {
+    for (const k in e) {
+      n[k] = e[k];
+    }
+  }
+  n.default = e;
+  return n;
+}
+
 const module__default = /*#__PURE__*/_interopDefaultCompat(module$1);
+const messageCompiler__namespace = /*#__PURE__*/_interopNamespaceCompat(messageCompiler);
 
 const _require = module__default.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)));
 function checkInstallPackage(pkg, debug) {
@@ -160,6 +173,14 @@ const ON_ERROR_NOOP = () => {
 function parsePath(path) {
   return path ? path.join(".") : "";
 }
+const COMPILE_ERROR_MESSAGES = messageCompiler__namespace.errorMessages;
+function getCompileErrorMessage(err) {
+  if (err.message !== String(err.code)) {
+    return err.message;
+  }
+  const text = COMPILE_ERROR_MESSAGES?.[err.code];
+  return text ? text.replace(/:\s*\\?'?\{\d+\}'?/g, "") : err.message;
+}
 function generateMessageFunction(msg, options = {}, path) {
   const env = options.env != null ? options.env : "development";
   const strictMessage = shared.isBoolean(options.strictMessage) ? options.strictMessage : true;
@@ -188,7 +209,7 @@ function generateMessageFunction(msg, options = {}, path) {
         domain: err.domain,
         location: err.location
       };
-      onError(err.message, extra);
+      onError(getCompileErrorMessage(err), extra);
       errors.push(err);
     }
   };
@@ -307,7 +328,7 @@ function generateResourceAst(msg, options = {}, path) {
         domain: err.domain,
         location: err.location
       };
-      onError(err.message, extra);
+      onError(getCompileErrorMessage(err), extra);
       errors.push(err);
     }
   };
@@ -316,6 +337,41 @@ function generateResourceAst(msg, options = {}, path) {
   const code = !occured ? `${shared.friendlyJSONstringify(ast)}` : `\`${_msg}\``;
   return { code, ast, map, errors };
 }
+function describeResource({ type, filename }) {
+  return type === "sfc" ? `the i18n custom block of ${filename}` : `${filename}`;
+}
+function describeValue(value) {
+  if (Array.isArray(value)) return "an array";
+  if (value === void 0) return "undefined";
+  return `a ${typeof value}`;
+}
+function stringifyValue(value) {
+  if (typeof value === "number") return Object.is(value, -0) ? "-0" : String(value);
+  if (value === void 0) return "undefined";
+  return JSON.stringify(value);
+}
+function createResourceError(message, options) {
+  return new Error(`${message} in ${describeResource(options)}.`);
+}
+function createResourceParseError(err, options, columnOffset = 0) {
+  if (!(err instanceof Error)) return err;
+  const { lineNumber, column } = err;
+  const position = lineNumber != null ? ` (${lineNumber}:${column + columnOffset})` : "";
+  return new SyntaxError(`${err.message} in ${describeResource(options)}${position}`, {
+    cause: err
+  });
+}
+function createOxcParseError(errors, source, options, offsetUnit = "utf-16") {
+  const error = errors.find((e) => e.severity === "Error") ?? errors[0];
+  const err = new Error(error.message);
+  const start = error.labels[0]?.start;
+  if (start != null) {
+    const before = offsetUnit === "utf-8" ? Buffer.from(source).subarray(0, start).toString() : source.slice(0, start);
+    err.lineNumber = before.split("\n").length;
+    err.column = before.length - before.lastIndexOf("\n");
+  }
+  return createResourceParseError(err, options);
+}
 function excludeLocales({
   messages,
   onlyLocales
@@ -351,10 +407,16 @@ function generate$3(targetSource, options) {
   const value = Buffer.isBuffer(targetSource) ? targetSource.toString() : targetSource;
   const _options = Object.assign({}, DEFAULT_OPTIONS, options, { source: value });
   const generator = createCodeGenerator(_options);
-  const { program: ast } = oxcParser.parseSync(_options.filename ?? "", value, {
+  const { program: ast, errors } = oxcParser.parseSync(_options.filename ?? "", value, {
     sourceType: "module",
-    lang: "js"
+    lang: "js",
+    // `(value)` is the value itself: `export default ({ ... })` is an object, a parenthesized
+    // message is compiled, and escodegen does not know `ParenthesizedExpression`
+    preserveParens: false
   });
+  if (errors.length > 0) {
+    throw createOxcParseError(errors, value, _options);
+  }
   const exportResult = scanAst(ast);
   if (!_options.allowDynamic) {
     if (!exportResult) {
@@ -646,7 +708,25 @@ function generate$2(targetSource, {
     escapeHtml,
     jit
   };
-  let ast = jsoncEslintParser.parseJSON(value, { filePath: filename });
+  let ast;
+  try {
+    ast = jsoncEslintParser.parseJSON(value, { filePath: filename });
+  } catch (err) {
+    throw createResourceParseError(err, options);
+  }
+  const root = ast.body[0].expression;
+  if (root.type !== "JSONObjectExpression") {
+    const rootValue = jsoncEslintParser.getStaticJSONValue(root);
+    if (rootValue !== null) {
+      throw createResourceError(
+        `You need to define an object as the locale messages at the top level, but got ${describeValue(rootValue)}`,
+        options
+      );
+    }
+    value = JSON.stringify({});
+    ast = jsoncEslintParser.parseJSON(value, { filePath: filename });
+    options.source = void 0;
+  }
   if (!locale && type === "sfc" && onlyLocales?.length) {
     const messages = jsoncEslintParser.getStaticJSONValue(ast);
     value = JSON.stringify(
@@ -686,6 +766,19 @@ function _generate$1(generator, node, options = {}) {
     sourceMap && map != null && codeMaps.set(value, map);
     return code;
   }
+  function pushExpressionValue(node2) {
+    const value = jsoncEslintParser.getStaticJSONValue(node2);
+    if (shared.isString(value)) {
+      generator.push(codegenFn(value), node2, value);
+      return;
+    }
+    const strValue = stringifyValue(value);
+    if (forceStringify) {
+      generator.push(codegenFn(strValue), node2, strValue);
+    } else {
+      generator.push(strValue);
+    }
+  }
   const componentNamespace = "_Component";
   jsoncEslintParser.traverseNodes(node, {
     enterNode(node2, parent) {
@@ -742,6 +835,8 @@ function _generate$1(generator, node, options = {}) {
             } else {
               generator.push(strValue2);
             }
+          } else if (node2.value.type !== "JSONObjectExpression" && node2.value.type !== "JSONArrayExpression") {
+            pushExpressionValue(node2.value);
           }
           break;
         }
@@ -757,6 +852,14 @@ function _generate$1(generator, node, options = {}) {
             generator.push(strValue);
           }
           break;
+        case "JSONUnaryExpression":
+        case "JSONIdentifier":
+        case "JSONTemplateLiteral":
+        case "JSONBinaryExpression":
+          if (parent.type === "JSONArrayExpression") {
+            pushExpressionValue(node2);
+          }
+          break;
       }
     },
     leaveNode(node2, parent) {
@@ -806,6 +909,9 @@ function generate$1(targetSource, options) {
   let value = Buffer.isBuffer(targetSource) ? targetSource.toString() : targetSource;
   const _options = Object.assign({}, DEFAULT_OPTIONS, options, { source: value });
   const transformed = oxcTransform.transform(_options.filename ?? "", value, { lang: "ts" });
+  if (transformed.errors.length > 0) {
+    throw createOxcParseError(transformed.errors, value, _options, "utf-8");
+  }
   if (transformed && transformed.code) {
     value = transformed.code;
     _options.source = transformed.code;
@@ -829,6 +935,9 @@ function generate(targetSource, {
   jit = false
 }) {
   let value = Buffer.isBuffer(targetSource) ? targetSource.toString() : targetSource;
+  if (value.charCodeAt(0) === 65279) {
+    value = value.slice(1);
+  }
   const options = {
     type,
     source: value,
@@ -844,9 +953,31 @@ function generate(targetSource, {
     escapeHtml,
     jit
   };
-  let ast = yamlEslintParser.parseYAML(value, { filePath: filename });
+  let ast;
+  try {
+    ast = yamlEslintParser.parseYAML(value, { filePath: filename });
+  } catch (err) {
+    throw createResourceParseError(err, options, 1);
+  }
+  const rootDocument = getRootDocument(ast, options);
+  const content = rootDocument?.content;
+  const root = content?.type === "YAMLWithMeta" ? content.value : content;
+  if (root?.type !== "YAMLMapping") {
+    const isAlias = root?.type === "YAMLAlias";
+    const rootValue = rootDocument == null || isAlias ? null : yamlEslintParser.getStaticYAMLValue(rootDocument);
+    if (isAlias || rootValue !== null) {
+      const actual = isAlias ? "an alias" : describeValue(rootValue);
+      throw createResourceError(
+        `You need to define an object as the locale messages at the top level, but got ${actual}`,
+        options
+      );
+    }
+    value = JSON.stringify({});
+    ast = yamlEslintParser.parseYAML(value, { filePath: filename });
+    options.source = void 0;
+  }
   if (!locale && type === "sfc" && onlyLocales?.length) {
-    const messages = yamlEslintParser.getStaticYAMLValue(ast);
+    const messages = yamlEslintParser.getStaticYAMLValue(getRootDocument(ast, options));
     value = JSON.stringify(
       excludeLocales({
         messages,
@@ -871,6 +1002,16 @@ function generate(targetSource, {
     map: newMap != null ? newMap : void 0
   };
 }
+function getRootDocument(ast, options) {
+  const documents = ast.body.filter((doc) => doc.content != null);
+  if (documents.length > 1) {
+    throw createResourceError(
+      `You need to define the locale messages in a single YAML document, but got ${documents.length} documents`,
+      options
+    );
+  }
+  return documents[0] ?? null;
+}
 function _generate(generator, node, options = {}) {
   const propsCountStack = [];
   const pathStack = [];
@@ -931,7 +1072,7 @@ function _generate(generator, node, options = {}) {
             const name = node2.key.value;
             const value = node2.value.value;
             const strName = JSON.stringify(name);
-            const strValue = JSON.stringify(value);
+            const strValue = stringifyValue(value);
             name && pathStack.push(name.toString());
             generator.push(`${strName}: `);
             if (shared.isString(value)) {
@@ -950,7 +1091,7 @@ function _generate(generator, node, options = {}) {
         case "YAMLScalar":
           if (parent.type === "YAMLSequence") {
             const value = node2.value;
-            const strValue = JSON.stringify(value);
+            const strValue = stringifyValue(value);
             if (shared.isString(value)) {
               generator.push(codegenFn(value), node2, value);
             } else if (forceStringify) {

package/lib/index.mjs

@@ -3,6 +3,7 @@ import { isBoolean, format, escapeHtml, friendlyJSONstringify, isString, isNumbe
 import { generate as generate$4 } from 'escodegen';
 import { parseSync } from 'oxc-parser';
 import { walk } from 'oxc-walker';
+import * as messageCompiler from '@intlify/message-compiler';
 import { LOCATION_STUB, detectHtmlTag, baseCompile } from '@intlify/message-compiler';
 import { SourceMapGenerator, SourceMapConsumer } from 'source-map-js';
 import { parseJSON, getStaticJSONValue, traverseNodes } from 'jsonc-eslint-parser';
@@ -153,6 +154,14 @@ const ON_ERROR_NOOP = () => {
 function parsePath(path) {
   return path ? path.join(".") : "";
 }
+const COMPILE_ERROR_MESSAGES = messageCompiler.errorMessages;
+function getCompileErrorMessage(err) {
+  if (err.message !== String(err.code)) {
+    return err.message;
+  }
+  const text = COMPILE_ERROR_MESSAGES?.[err.code];
+  return text ? text.replace(/:\s*\\?'?\{\d+\}'?/g, "") : err.message;
+}
 function generateMessageFunction(msg, options = {}, path) {
   const env = options.env != null ? options.env : "development";
   const strictMessage = isBoolean(options.strictMessage) ? options.strictMessage : true;
@@ -181,7 +190,7 @@ function generateMessageFunction(msg, options = {}, path) {
         domain: err.domain,
         location: err.location
       };
-      onError(err.message, extra);
+      onError(getCompileErrorMessage(err), extra);
       errors.push(err);
     }
   };
@@ -300,7 +309,7 @@ function generateResourceAst(msg, options = {}, path) {
         domain: err.domain,
         location: err.location
       };
-      onError(err.message, extra);
+      onError(getCompileErrorMessage(err), extra);
       errors.push(err);
     }
   };
@@ -309,6 +318,41 @@ function generateResourceAst(msg, options = {}, path) {
   const code = !occured ? `${friendlyJSONstringify(ast)}` : `\`${_msg}\``;
   return { code, ast, map, errors };
 }
+function describeResource({ type, filename }) {
+  return type === "sfc" ? `the i18n custom block of ${filename}` : `${filename}`;
+}
+function describeValue(value) {
+  if (Array.isArray(value)) return "an array";
+  if (value === void 0) return "undefined";
+  return `a ${typeof value}`;
+}
+function stringifyValue(value) {
+  if (typeof value === "number") return Object.is(value, -0) ? "-0" : String(value);
+  if (value === void 0) return "undefined";
+  return JSON.stringify(value);
+}
+function createResourceError(message, options) {
+  return new Error(`${message} in ${describeResource(options)}.`);
+}
+function createResourceParseError(err, options, columnOffset = 0) {
+  if (!(err instanceof Error)) return err;
+  const { lineNumber, column } = err;
+  const position = lineNumber != null ? ` (${lineNumber}:${column + columnOffset})` : "";
+  return new SyntaxError(`${err.message} in ${describeResource(options)}${position}`, {
+    cause: err
+  });
+}
+function createOxcParseError(errors, source, options, offsetUnit = "utf-16") {
+  const error = errors.find((e) => e.severity === "Error") ?? errors[0];
+  const err = new Error(error.message);
+  const start = error.labels[0]?.start;
+  if (start != null) {
+    const before = offsetUnit === "utf-8" ? Buffer.from(source).subarray(0, start).toString() : source.slice(0, start);
+    err.lineNumber = before.split("\n").length;
+    err.column = before.length - before.lastIndexOf("\n");
+  }
+  return createResourceParseError(err, options);
+}
 function excludeLocales({
   messages,
   onlyLocales
@@ -344,10 +388,16 @@ function generate$3(targetSource, options) {
   const value = Buffer.isBuffer(targetSource) ? targetSource.toString() : targetSource;
   const _options = Object.assign({}, DEFAULT_OPTIONS, options, { source: value });
   const generator = createCodeGenerator(_options);
-  const { program: ast } = parseSync(_options.filename ?? "", value, {
+  const { program: ast, errors } = parseSync(_options.filename ?? "", value, {
     sourceType: "module",
-    lang: "js"
+    lang: "js",
+    // `(value)` is the value itself: `export default ({ ... })` is an object, a parenthesized
+    // message is compiled, and escodegen does not know `ParenthesizedExpression`
+    preserveParens: false
   });
+  if (errors.length > 0) {
+    throw createOxcParseError(errors, value, _options);
+  }
   const exportResult = scanAst(ast);
   if (!_options.allowDynamic) {
     if (!exportResult) {
@@ -639,7 +689,25 @@ function generate$2(targetSource, {
     escapeHtml,
     jit
   };
-  let ast = parseJSON(value, { filePath: filename });
+  let ast;
+  try {
+    ast = parseJSON(value, { filePath: filename });
+  } catch (err) {
+    throw createResourceParseError(err, options);
+  }
+  const root = ast.body[0].expression;
+  if (root.type !== "JSONObjectExpression") {
+    const rootValue = getStaticJSONValue(root);
+    if (rootValue !== null) {
+      throw createResourceError(
+        `You need to define an object as the locale messages at the top level, but got ${describeValue(rootValue)}`,
+        options
+      );
+    }
+    value = JSON.stringify({});
+    ast = parseJSON(value, { filePath: filename });
+    options.source = void 0;
+  }
   if (!locale && type === "sfc" && onlyLocales?.length) {
     const messages = getStaticJSONValue(ast);
     value = JSON.stringify(
@@ -679,6 +747,19 @@ function _generate$1(generator, node, options = {}) {
     sourceMap && map != null && codeMaps.set(value, map);
     return code;
   }
+  function pushExpressionValue(node2) {
+    const value = getStaticJSONValue(node2);
+    if (isString(value)) {
+      generator.push(codegenFn(value), node2, value);
+      return;
+    }
+    const strValue = stringifyValue(value);
+    if (forceStringify) {
+      generator.push(codegenFn(strValue), node2, strValue);
+    } else {
+      generator.push(strValue);
+    }
+  }
   const componentNamespace = "_Component";
   traverseNodes(node, {
     enterNode(node2, parent) {
@@ -735,6 +816,8 @@ function _generate$1(generator, node, options = {}) {
             } else {
               generator.push(strValue2);
             }
+          } else if (node2.value.type !== "JSONObjectExpression" && node2.value.type !== "JSONArrayExpression") {
+            pushExpressionValue(node2.value);
           }
           break;
         }
@@ -750,6 +833,14 @@ function _generate$1(generator, node, options = {}) {
             generator.push(strValue);
           }
           break;
+        case "JSONUnaryExpression":
+        case "JSONIdentifier":
+        case "JSONTemplateLiteral":
+        case "JSONBinaryExpression":
+          if (parent.type === "JSONArrayExpression") {
+            pushExpressionValue(node2);
+          }
+          break;
       }
     },
     leaveNode(node2, parent) {
@@ -799,6 +890,9 @@ function generate$1(targetSource, options) {
   let value = Buffer.isBuffer(targetSource) ? targetSource.toString() : targetSource;
   const _options = Object.assign({}, DEFAULT_OPTIONS, options, { source: value });
   const transformed = transform(_options.filename ?? "", value, { lang: "ts" });
+  if (transformed.errors.length > 0) {
+    throw createOxcParseError(transformed.errors, value, _options, "utf-8");
+  }
   if (transformed && transformed.code) {
     value = transformed.code;
     _options.source = transformed.code;
@@ -822,6 +916,9 @@ function generate(targetSource, {
   jit = false
 }) {
   let value = Buffer.isBuffer(targetSource) ? targetSource.toString() : targetSource;
+  if (value.charCodeAt(0) === 65279) {
+    value = value.slice(1);
+  }
   const options = {
     type,
     source: value,
@@ -837,9 +934,31 @@ function generate(targetSource, {
     escapeHtml,
     jit
   };
-  let ast = parseYAML(value, { filePath: filename });
+  let ast;
+  try {
+    ast = parseYAML(value, { filePath: filename });
+  } catch (err) {
+    throw createResourceParseError(err, options, 1);
+  }
+  const rootDocument = getRootDocument(ast, options);
+  const content = rootDocument?.content;
+  const root = content?.type === "YAMLWithMeta" ? content.value : content;
+  if (root?.type !== "YAMLMapping") {
+    const isAlias = root?.type === "YAMLAlias";
+    const rootValue = rootDocument == null || isAlias ? null : getStaticYAMLValue(rootDocument);
+    if (isAlias || rootValue !== null) {
+      const actual = isAlias ? "an alias" : describeValue(rootValue);
+      throw createResourceError(
+        `You need to define an object as the locale messages at the top level, but got ${actual}`,
+        options
+      );
+    }
+    value = JSON.stringify({});
+    ast = parseYAML(value, { filePath: filename });
+    options.source = void 0;
+  }
   if (!locale && type === "sfc" && onlyLocales?.length) {
-    const messages = getStaticYAMLValue(ast);
+    const messages = getStaticYAMLValue(getRootDocument(ast, options));
     value = JSON.stringify(
       excludeLocales({
         messages,
@@ -864,6 +983,16 @@ function generate(targetSource, {
     map: newMap != null ? newMap : void 0
   };
 }
+function getRootDocument(ast, options) {
+  const documents = ast.body.filter((doc) => doc.content != null);
+  if (documents.length > 1) {
+    throw createResourceError(
+      `You need to define the locale messages in a single YAML document, but got ${documents.length} documents`,
+      options
+    );
+  }
+  return documents[0] ?? null;
+}
 function _generate(generator, node, options = {}) {
   const propsCountStack = [];
   const pathStack = [];
@@ -924,7 +1053,7 @@ function _generate(generator, node, options = {}) {
             const name = node2.key.value;
             const value = node2.value.value;
             const strName = JSON.stringify(name);
-            const strValue = JSON.stringify(value);
+            const strValue = stringifyValue(value);
             name && pathStack.push(name.toString());
             generator.push(`${strName}: `);
             if (isString(value)) {
@@ -943,7 +1072,7 @@ function _generate(generator, node, options = {}) {
         case "YAMLScalar":
           if (parent.type === "YAMLSequence") {
             const value = node2.value;
-            const strValue = JSON.stringify(value);
+            const strValue = stringifyValue(value);
             if (isString(value)) {
               generator.push(codegenFn(value), node2, value);
             } else if (forceStringify) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@intlify/bundle-utils",
   "description": "Bundle utilities for Intlify project",
-  "version": "12.0.0-alpha.3",
+  "version": "12.0.0-alpha.4",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -22,7 +22,7 @@
     "@intlify/shared": "next",
     "escodegen": "^2.1.0",
     "jsonc-eslint-parser": "^2.3.0",
-    "oxc-parser": "^0.130.0",
+    "oxc-parser": "^0.131.0",
     "oxc-transform": "^0.96.0",
     "oxc-walker": "^0.7.0",
     "source-map-js": "^1.0.1",