@messagevisor/core 0.13.0 → 0.16.0

package/src/create/index.spec.ts

@@ -181,9 +181,7 @@ describe("createPlugin", function () {
     expect(summary.requestedKeys).toEqual(["auth.signin", "auth.signout"]);
     expect(summary.createdKeys).toEqual(["auth.signout"]);
     expect(summary.skippedKeys).toEqual(["auth.signin"]);
-    expect(summary.createdFilePaths).toEqual([
-      path.relative(process.cwd(), path.join(root, "messages/auth/signout.yml")),
-    ]);
+    expect(summary.createdFilePaths).toEqual([path.join("messages", "auth", "signout.yml")]);
     logSpy.mockRestore();
   });
 

package/src/create/index.ts

@@ -4,6 +4,7 @@ import type { Attribute, Locale, Message, Target, Segment } from "@messagevisor/
 
 import type { Plugin } from "../cli";
 import { MessagevisorCLIError, printMessagevisorCLIError } from "../error";
+import { formatProjectPath } from "../path";
 import { getProjectSetExecutions } from "../sets";
 
 type CreateEntityType = "messages" | "locales" | "targets" | "attributes" | "segments";
@@ -224,7 +225,7 @@ async function createDefinitions(
     await writeEntity(datasource, entityType, key);
     createdKeys.push(key);
     createdFilePaths.push(
-      path.relative(process.cwd(), getEntityFilePath(projectConfig, entityType, key)),
+      formatProjectPath(projectConfig, getEntityFilePath(projectConfig, entityType, key)),
     );
     existingKeys.add(key);
   }

package/src/importer/index.ts

@@ -7,6 +7,7 @@ import type { Locale, Message, Override, Translation } from "@messagevisor/types
 import type { ProjectConfig } from "../config";
 import type { Datasource } from "../datasource";
 import { MessagevisorCLIError, printMessagevisorCLIError } from "../error";
+import { formatProjectPath } from "../path";
 import { getProjectSetExecutions } from "../sets";
 import {
   CLI_FORMAT_BOLD,
@@ -1091,12 +1092,12 @@ export async function importProjectSets(
   );
 }
 
-function printImportResult(result: ImportProjectResult) {
+function printImportResult(projectConfig: ProjectConfig, result: ImportProjectResult) {
   console.log("");
   console.log(CLI_FORMAT_BOLD, "Importing Messagevisor translations");
   const inputLabel = isHttpUrl(result.inputFilePath)
     ? result.inputFilePath
-    : path.relative(process.cwd(), result.inputFilePath);
+    : formatProjectPath(projectConfig, result.inputFilePath);
   console.log(`  Input: ${colorize(inputLabel, 36)}`);
   console.log(`  Mode: ${result.apply ? "apply" : "preview"}`);
   if (result.summary.sets.length > 0) {
@@ -1152,7 +1153,7 @@ export const importPlugin = {
         parsed,
       );
 
-      printImportResult(result);
+      printImportResult(projectConfig, result);
     } catch (error) {
       if (printMessagevisorCLIError(error)) {
         return false;

package/src/index.ts

@@ -15,5 +15,6 @@ export * from "./info";
 export * from "./importer";
 export * from "./init";
 export * from "./linter";
+export * from "./path";
 export * from "./promoter";
 export * from "./tester";

package/src/linter/index.spec.ts

@@ -52,6 +52,7 @@ describe("lintProject", function () {
       result.errors.some(
         (error) =>
           error.entityType === "locale" &&
+          error.filePath === path.join("locales", "en.yml") &&
           error.code === "unrecognized_keys" &&
           error.message.includes("unknown"),
       ),

package/src/linter/index.ts

@@ -21,6 +21,7 @@ import {
   getProjectSetExecutions,
   getProjectSetRelativeFilePath,
 } from "../sets";
+import { formatProjectPath, getProjectRootDirectoryPath } from "../path";
 import { CLI_FORMAT_BOLD, CLI_FORMAT_GREEN, CLI_FORMAT_RED, colorize } from "../tester/cliFormat";
 import { prettyDuration } from "../tester/prettyDuration";
 
@@ -102,7 +103,7 @@ function getFullPathFromKey(projectConfig: ProjectConfig, entityType: LintEntity
       : path.join(projectConfig.testsDirectoryPath, fileName);
   }
 
-  return path.join(process.cwd(), "messagevisor.config.js");
+  return path.join(getProjectRootDirectoryPath(projectConfig), "messagevisor.config.js");
 }
 
 async function readAll<T>(
@@ -147,7 +148,7 @@ export async function lintProject(
   ) {
     for (const issue of getLintIssuesFromZodError(error)) {
       recordError({
-        filePath: path.relative(process.cwd(), fullPath),
+        filePath: formatProjectPath(projectConfig, fullPath),
         entityType,
         entityKey: key,
         message: issue.message,
@@ -168,7 +169,7 @@ export async function lintProject(
 
     if (!isValidEntityKey(projectConfig, key)) {
       recordError({
-        filePath: path.relative(process.cwd(), fullPath),
+        filePath: formatProjectPath(projectConfig, fullPath),
         entityType,
         entityKey: key,
         message: `Invalid name: "${key}". ${ENTITY_NAME_REGEX_ERROR}`,
@@ -186,7 +187,7 @@ export async function lintProject(
       }
     } catch (error) {
       recordError({
-        filePath: path.relative(process.cwd(), fullPath),
+        filePath: formatProjectPath(projectConfig, fullPath),
         entityType,
         entityKey: key,
         message: error instanceof Error ? error.message : String(error),
@@ -252,7 +253,7 @@ export async function lintProject(
       const fullPath = getFullPathFromKey(projectConfig, "locale", key);
 
       recordError({
-        filePath: path.relative(process.cwd(), fullPath),
+        filePath: formatProjectPath(projectConfig, fullPath),
         entityType: "locale",
         entityKey: key,
         message: `Circular locale dependency detected for ${field}: ${circularDependency.cycle.join(" -> ")}`,
@@ -289,7 +290,8 @@ export async function lintProject(
       ...lintMessageIcuFormatStyles(
         Object.fromEntries(Object.entries(messagesByKey).filter(([key]) => shouldLintKey(key))),
         localesByKey,
-        (key) => path.relative(process.cwd(), getFullPathFromKey(projectConfig, "message", key)),
+        (key) =>
+          formatProjectPath(projectConfig, getFullPathFromKey(projectConfig, "message", key)),
         { icuSkeleton: projectConfig.icuSkeleton },
       ),
     );

package/src/path.spec.ts

@@ -0,0 +1,20 @@
+import * as path from "path";
+
+import { formatRootRelativePath } from "./path";
+
+describe("path formatting", function () {
+  it("formats paths relative to the selected project root", function () {
+    const root = path.join(path.sep, "tmp", "messagevisor-project");
+
+    expect(formatRootRelativePath(root, path.join(root, "messages/auth/signin.yml"))).toEqual(
+      path.join("messages", "auth", "signin.yml"),
+    );
+  });
+
+  it("keeps paths outside the selected project root absolute", function () {
+    const root = path.join(path.sep, "tmp", "messagevisor-project");
+    const outside = path.join(path.sep, "tmp", "other", "translations.csv");
+
+    expect(formatRootRelativePath(root, outside)).toEqual(outside);
+  });
+});

package/src/path.ts

@@ -0,0 +1,31 @@
+import * as path from "path";
+
+import type { ProjectConfig } from "./config";
+
+export function getProjectRootDirectoryPath(projectConfig: ProjectConfig) {
+  return path.dirname(projectConfig.setsDirectoryPath);
+}
+
+export function formatRootRelativePath(rootDirectoryPath: string, filePath: string) {
+  const absoluteRootDirectoryPath = path.resolve(rootDirectoryPath);
+  const absoluteFilePath = path.resolve(filePath);
+  const relativePath = path.relative(absoluteRootDirectoryPath, absoluteFilePath);
+
+  if (!relativePath) {
+    return ".";
+  }
+
+  if (
+    relativePath === ".." ||
+    relativePath.startsWith(`..${path.sep}`) ||
+    path.isAbsolute(relativePath)
+  ) {
+    return absoluteFilePath;
+  }
+
+  return relativePath;
+}
+
+export function formatProjectPath(projectConfig: ProjectConfig, filePath: string) {
+  return formatRootRelativePath(getProjectRootDirectoryPath(projectConfig), filePath);
+}

package/src/promoter/index.spec.ts

@@ -488,10 +488,7 @@ describe("promoteProjectSets", function () {
         ".messagevisor/promotions/20260419T102030-dev-to-staging-1.md",
       );
 
-      const audit = await fs.promises.readFile(
-        path.resolve(process.cwd(), first.auditFilePath),
-        "utf8",
-      );
+      const audit = await fs.promises.readFile(path.resolve(root, first.auditFilePath), "utf8");
       expect(audit).toContain("# Messagevisor Promotion");
       expect(audit).toContain("- Mode: apply");
       expect(audit).toContain("messages/product/price.yml");
@@ -516,7 +513,7 @@ describe("promoteProjectSets", function () {
     expect(result.auditFilePath).toContain(".json");
 
     const audit = JSON.parse(
-      await fs.promises.readFile(path.resolve(process.cwd(), result.auditFilePath!), "utf8"),
+      await fs.promises.readFile(path.resolve(root, result.auditFilePath!), "utf8"),
     );
 
     expect(audit.apply).toEqual(true);

package/src/promoter/index.ts

@@ -16,6 +16,7 @@ import type { ProjectConfig } from "../config";
 import type { Datasource } from "../datasource";
 import { MessagevisorCLIError, printMessagevisorCLIError } from "../error";
 import { lintProject, type LintError } from "../linter";
+import { formatProjectPath } from "../path";
 import { CLI_FORMAT_BOLD, CLI_FORMAT_GREEN, colorize } from "../tester/cliFormat";
 import { prettyDuration } from "../tester/prettyDuration";
 
@@ -1008,7 +1009,7 @@ async function writePromotionAudit(
 
   await fs.promises.writeFile(filePath, content);
 
-  return path.relative(process.cwd(), filePath);
+  return formatProjectPath(projectConfig, filePath);
 }
 
 export async function promoteProjectSets(
@@ -1075,24 +1076,24 @@ export async function promoteProjectSets(
   const created = plans
     .filter((plan) => !plan.destination)
     .map((plan) =>
-      path.relative(
-        process.cwd(),
+      formatProjectPath(
+        projectConfig,
         getEntityFilePath(destinationDatasource.getConfig(), plan.type, plan.key),
       ),
     );
   const updated = plans
     .filter((plan) => plan.destination && !deepEqual(plan.destination, plan.merged))
     .map((plan) =>
-      path.relative(
-        process.cwd(),
+      formatProjectPath(
+        projectConfig,
         getEntityFilePath(destinationDatasource.getConfig(), plan.type, plan.key),
       ),
     );
   const unchanged = plans
     .filter((plan) => plan.destination && deepEqual(plan.destination, plan.merged))
     .map((plan) =>
-      path.relative(
-        process.cwd(),
+      formatProjectPath(
+        projectConfig,
         getEntityFilePath(destinationDatasource.getConfig(), plan.type, plan.key),
       ),
     );

package/src/prune/index.ts

@@ -13,6 +13,7 @@ import type {
 import type { ProjectConfig } from "../config";
 import type { Datasource } from "../datasource";
 import { mergeFormatPresets } from "../formats";
+import { formatProjectPath } from "../path";
 import { getProjectSetExecutions } from "../sets";
 import { CLI_FORMAT_BOLD, CLI_FORMAT_GREEN } from "../tester/cliFormat";
 
@@ -100,8 +101,8 @@ function getEntityFilePath(
 ) {
   const parser = projectConfig.parser as CustomParser;
 
-  return path.relative(
-    process.cwd(),
+  return formatProjectPath(
+    projectConfig,
     path.join(directoryPath, ...key.split(projectConfig.namespaceCharacter)) +
       `${suffix}.${parser.extension}`,
   );

package/src/sets.ts

@@ -3,6 +3,7 @@ import * as path from "path";
 import type { ProjectConfig } from "./config";
 import type { Datasource } from "./datasource";
 import { MessagevisorCLIError } from "./error";
+import { formatProjectPath } from "./path";
 
 export interface ProjectSetExecution {
   set: string;
@@ -61,8 +62,8 @@ export function getProjectSetRelativeFilePath(
   set: string,
   filePath: string,
 ) {
-  const setDirectoryPath = path.relative(
-    process.cwd(),
+  const setDirectoryPath = formatProjectPath(
+    projectConfig,
     path.join(projectConfig.setsDirectoryPath, set),
   );
 

package/src/tester/index.ts

@@ -7,6 +7,7 @@ import type { ProjectConfig } from "../config";
 import type { Datasource } from "../datasource";
 import { buildDatafile, resolveFormats } from "../builder";
 import { evaluateSegment } from "../evaluate";
+import { formatProjectPath } from "../path";
 import {
   assertProjectSetJsonSelection,
   getProjectSetExecutions,
@@ -200,7 +201,7 @@ function getTestFilePath(projectConfig: ProjectConfig, testKey: string) {
   const specPath = `${basePath}.spec.${extension}`;
   const legacyPath = `${basePath}.${extension}`;
 
-  return path.relative(process.cwd(), fs.existsSync(specPath) ? specPath : legacyPath);
+  return formatProjectPath(projectConfig, fs.existsSync(specPath) ? specPath : legacyPath);
 }
 
 async function runTest(