fern-api 0.16.8 → 0.16.9

package/bundle.cjs

@@ -736685,7 +736685,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "0.16.8",
+          version: "0.16.9",
           usingAccessToken: true
         }
       });
@@ -736747,7 +736747,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "0.16.8",
+        version: "0.16.9",
         ...event,
         ...event.properties
       }
@@ -761175,10 +761175,10 @@ var CliContext = class {
     return "fern-api";
   }
   getPackageVersion() {
-    if ("0.16.8" == null) {
+    if ("0.16.9" == null) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "0.16.8";
+    return "0.16.9";
   }
   getCliName() {
     if ("fern" == null) {
@@ -768845,38 +768845,48 @@ async function validatePackageMarker({ relativeFilepath, contents, allRuleVisito
 
 // pnp:/home/circleci/project/packages/cli/cli/src/commands/validate/validateAPIWorkspaceAndLogIssues.ts
 var import_validate_npm_package_name = __toESM(require_lib15());
-async function validateAPIWorkspaceAndLogIssues(workspace, context) {
-  if (!(0, import_validate_npm_package_name.default)(workspace.name).validForNewPackages) {
-    context.failAndThrow("Workspace name is not valid.");
-  }
-  const violations = await validateFernWorkspace(workspace, context.logger);
-  let violationsContainError = false;
-  for (const violation of violations) {
-    if (!violationsContainError && violation.severity === "error") {
-      violationsContainError = true;
-    }
-    context.logger.log(
-      getLogLevelForSeverity(violation.severity),
-      formatLog({
-        breadcrumbs: [
-          violation.relativeFilepath,
-          ...violation.nodePath.map((nodePathItem) => {
-            let itemStr = typeof nodePathItem === "string" ? nodePathItem : nodePathItem.key;
-            if (typeof nodePathItem !== "string" && nodePathItem.arrayIndex != null) {
-              itemStr += `[${nodePathItem.arrayIndex}]`;
-            }
-            return itemStr;
-          })
-        ],
-        title: violation.message
-      })
-    );
-  }
-  if (violationsContainError) {
-    context.failAndThrow();
-  } else {
-    context.logger.info(source_default.green("\u2713 All checks passed"));
+
+// pnp:/home/circleci/project/packages/cli/cli/src/commands/validate/logViolations.ts
+function logViolations({
+  context,
+  violations,
+  logWarnings
+}) {
+  const stats = getViolationStats(violations);
+  logViolationsSummary({ context, stats, logWarnings });
+  violations.forEach((violation) => {
+    if (violation.severity === "error") {
+      logViolation({ violation, context });
+    }
+  });
+  if (logWarnings) {
+    violations.forEach((violation) => {
+      if (violation.severity === "warning") {
+        logViolation({ violation, context });
+      }
+    });
   }
+  return {
+    hasErrors: stats.numErrors > 0
+  };
+}
+function logViolation({ violation, context }) {
+  context.logger.log(
+    getLogLevelForSeverity(violation.severity),
+    formatLog({
+      breadcrumbs: [
+        violation.relativeFilepath,
+        ...violation.nodePath.map((nodePathItem) => {
+          let itemStr = typeof nodePathItem === "string" ? nodePathItem : nodePathItem.key;
+          if (typeof nodePathItem !== "string" && nodePathItem.arrayIndex != null) {
+            itemStr += `[${nodePathItem.arrayIndex}]`;
+          }
+          return itemStr;
+        })
+      ],
+      title: violation.message
+    })
+  );
 }
 function getLogLevelForSeverity(severity) {
   switch (severity) {
@@ -768886,6 +768896,60 @@ function getLogLevelForSeverity(severity) {
       return LogLevel.Warn;
   }
 }
+function logViolationsSummary({
+  stats,
+  context,
+  logWarnings
+}) {
+  const { numErrors, numWarnings } = stats;
+  let message = `Found ${numErrors} errors and ${numWarnings} warnings.`;
+  if (!logWarnings) {
+    message += " Run fern check --warnings to print out the warnings.";
+  }
+  if (numErrors > 0) {
+    context.logger.error(message);
+  } else if (numWarnings > 0) {
+    context.logger.warn(message);
+  } else {
+    context.logger.info(source_default.green("\u2713 All checks passed"));
+  }
+}
+function getViolationStats(violations) {
+  let numErrors = 0;
+  let numWarnings = 0;
+  for (const violation of violations) {
+    switch (violation.severity) {
+      case "error":
+        numErrors += 1;
+        continue;
+      case "warning":
+        numWarnings += 1;
+        continue;
+      default:
+        assertNever(violation.severity);
+    }
+  }
+  return {
+    numErrors,
+    numWarnings
+  };
+}
+
+// pnp:/home/circleci/project/packages/cli/cli/src/commands/validate/validateAPIWorkspaceAndLogIssues.ts
+async function validateAPIWorkspaceAndLogIssues({
+  workspace,
+  context,
+  logWarnings
+}) {
+  if (!(0, import_validate_npm_package_name.default)(workspace.name).validForNewPackages) {
+    context.failAndThrow("Workspace name is not valid.");
+  }
+  const violations = await validateFernWorkspace(workspace, context.logger);
+  const { hasErrors } = logViolations({ violations, context, logWarnings });
+  if (hasErrors) {
+    context.failAndThrow();
+  }
+}
 
 // pnp:/home/circleci/project/packages/cli/cli/src/commands/generate-ir/generateIrForFernWorkspace.ts
 async function generateIrForFernWorkspace({
@@ -768894,7 +768958,7 @@ async function generateIrForFernWorkspace({
   generationLanguage,
   audiences
 }) {
-  await validateAPIWorkspaceAndLogIssues(workspace, context);
+  await validateAPIWorkspaceAndLogIssues({ workspace, context, logWarnings: false });
   return generateIntermediateRepresentation({
     workspace,
     generationLanguage,
@@ -776384,7 +776448,7 @@ async function generateWorkspace({
   if (group == null) {
     return context.failAndThrow(`Group '${groupNameOrDefault}' does not exist.`);
   }
-  await validateAPIWorkspaceAndLogIssues(workspace, context);
+  await validateAPIWorkspaceAndLogIssues({ workspace, context, logWarnings: false });
   if (useLocalDocker) {
     await runLocalGenerationForWorkspace({
       organization,
@@ -801946,42 +802010,15 @@ async function runRulesOnDocsWorkspace({ workspace, rules, logger }) {
 }
 
 // pnp:/home/circleci/project/packages/cli/cli/src/commands/validate/validateDocsWorkspaceAndLogIssues.ts
-async function validateDocsWorkspaceAndLogIssues(workspace, context) {
+async function validateDocsWorkspaceAndLogIssues({
+  workspace,
+  context,
+  logWarnings
+}) {
   const violations = await validateDocsWorkspace(workspace, context.logger);
-  let violationsContainError = false;
-  for (const violation of violations) {
-    if (!violationsContainError && violation.severity === "error") {
-      violationsContainError = true;
-    }
-    context.logger.log(
-      getLogLevelForSeverity2(violation.severity),
-      formatLog({
-        breadcrumbs: [
-          violation.relativeFilepath,
-          ...violation.nodePath.map((nodePathItem) => {
-            let itemStr = typeof nodePathItem === "string" ? nodePathItem : nodePathItem.key;
-            if (typeof nodePathItem !== "string" && nodePathItem.arrayIndex != null) {
-              itemStr += `[${nodePathItem.arrayIndex}]`;
-            }
-            return itemStr;
-          })
-        ],
-        title: violation.message
-      })
-    );
-  }
-  if (violationsContainError) {
+  const { hasErrors } = logViolations({ violations, context, logWarnings });
+  if (hasErrors) {
     context.failAndThrow();
-  } else {
-    context.logger.info(source_default.green("\u2713 All checks passed"));
-  }
-}
-function getLogLevelForSeverity2(severity) {
-  switch (severity) {
-    case "error":
-      return LogLevel.Error;
-    case "warning":
-      return LogLevel.Warn;
   }
 }
 
@@ -802013,7 +802050,7 @@ async function generateDocsWorkspace({
     command: "fern generate --docs"
   });
   await cliContext.runTaskForWorkspace(docsWorkspace, async (context) => {
-    await validateDocsWorkspaceAndLogIssues(docsWorkspace, context);
+    await validateDocsWorkspaceAndLogIssues({ workspace: docsWorkspace, context, logWarnings: false });
     const fernWorkspaces = await Promise.all(
       project.apiWorkspaces.map(async (workspace) => {
         return workspace.type === "fern" ? workspace : await convertOpenApiWorkspaceToFernWorkspace(workspace, context);
@@ -802336,7 +802373,7 @@ async function previewDocsWorkspace({
     command: "fern preview --docs"
   });
   await cliContext.runTaskForWorkspace(docsWorkspace, async (context) => {
-    await validateDocsWorkspaceAndLogIssues(docsWorkspace, context);
+    await validateDocsWorkspaceAndLogIssues({ workspace: docsWorkspace, context, logWarnings: false });
     await runPreviewServer({
       docsWorkspace,
       context,
@@ -804552,12 +804589,13 @@ async function upgrade({
 // pnp:/home/circleci/project/packages/cli/cli/src/commands/validate/validateWorkspaces.ts
 async function validateWorkspaces({
   project,
-  cliContext
+  cliContext,
+  logWarnings
 }) {
   const docsWorkspace = project.docsWorkspaces;
   if (docsWorkspace != null) {
     await cliContext.runTaskForWorkspace(docsWorkspace, async (context) => {
-      await validateDocsWorkspaceAndLogIssues(docsWorkspace, context);
+      await validateDocsWorkspaceAndLogIssues({ workspace: docsWorkspace, context, logWarnings });
     });
   }
   await Promise.all(
@@ -804565,9 +804603,9 @@ async function validateWorkspaces({
       await cliContext.runTaskForWorkspace(workspace, async (context) => {
         if (workspace.type === "openapi") {
           const fernWorkspace = await convertOpenApiWorkspaceToFernWorkspace(workspace, context);
-          await validateAPIWorkspaceAndLogIssues(fernWorkspace, context);
+          await validateAPIWorkspaceAndLogIssues({ workspace: fernWorkspace, context, logWarnings });
         } else {
-          await validateAPIWorkspaceAndLogIssues(workspace, context);
+          await validateAPIWorkspaceAndLogIssues({ workspace, context, logWarnings });
         }
       });
     })
@@ -805075,10 +805113,14 @@ function addRegisterV2Command(cli, cliContext) {
 function addValidateCommand(cli, cliContext) {
   cli.command(
     "check",
-    "Validates your Fern Definition",
+    "Validates your Fern Definition. Logs errors.",
     (yargs) => yargs.option("api", {
       string: true,
       description: "Only run the command on the provided API"
+    }).option("warnings", {
+      boolean: true,
+      description: "Log warnings in addition to errors.",
+      default: false
     }),
     async (argv) => {
       await validateWorkspaces({
@@ -805086,7 +805128,8 @@ function addValidateCommand(cli, cliContext) {
           commandLineApiWorkspace: argv.api,
           defaultToAllApiWorkspaces: true
         }),
-        cliContext
+        cliContext,
+        logWarnings: argv.warnings
       });
     }
   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fern-api",
-  "version": "0.16.8",
+  "version": "0.16.9",
   "repository": {
     "type": "git",
     "url": "https://github.com/fern-api/fern.git",