@intlify/bundle-utils 11.2.5 → 11.2.6

package/lib/index.cjs

@@ -341,6 +341,25 @@ function filterMultiLocaleMessages(messages, shouldKeep) {
   }
   return result;
 }
+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 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 excludeLocales({
   messages,
   onlyLocales
@@ -688,7 +707,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(
@@ -884,6 +921,9 @@ function generate(targetSource, {
   usedKeyFilter = void 0
 }) {
   let value = Buffer.isBuffer(targetSource) ? targetSource.toString() : targetSource;
+  if (value.charCodeAt(0) === 65279) {
+    value = value.slice(1);
+  }
   const options = {
     type,
     source: value,
@@ -899,9 +939,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,
@@ -917,7 +979,7 @@ function generate(targetSource, {
     options.source = void 0;
   }
   if (usedKeyFilter) {
-    const messages = yamlEslintParser.getStaticYAMLValue(ast);
+    const messages = yamlEslintParser.getStaticYAMLValue(getRootDocument(ast, options));
     const isMultiLocale = !locale && type === "sfc";
     const filtered = isMultiLocale ? filterMultiLocaleMessages(messages, usedKeyFilter) : filterMessageKeys(messages, usedKeyFilter);
     value = JSON.stringify(filtered);
@@ -934,6 +996,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 = [];

package/lib/index.mjs

@@ -334,6 +334,25 @@ function filterMultiLocaleMessages(messages, shouldKeep) {
   }
   return result;
 }
+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 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 excludeLocales({
   messages,
   onlyLocales
@@ -681,7 +700,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(
@@ -877,6 +914,9 @@ function generate(targetSource, {
   usedKeyFilter = void 0
 }) {
   let value = Buffer.isBuffer(targetSource) ? targetSource.toString() : targetSource;
+  if (value.charCodeAt(0) === 65279) {
+    value = value.slice(1);
+  }
   const options = {
     type,
     source: value,
@@ -892,9 +932,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,
@@ -910,7 +972,7 @@ function generate(targetSource, {
     options.source = void 0;
   }
   if (usedKeyFilter) {
-    const messages = getStaticYAMLValue(ast);
+    const messages = getStaticYAMLValue(getRootDocument(ast, options));
     const isMultiLocale = !locale && type === "sfc";
     const filtered = isMultiLocale ? filterMultiLocaleMessages(messages, usedKeyFilter) : filterMessageKeys(messages, usedKeyFilter);
     value = JSON.stringify(filtered);
@@ -927,6 +989,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 = [];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@intlify/bundle-utils",
   "description": "Bundle utilities for Intlify project",
-  "version": "11.2.5",
+  "version": "11.2.6",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"