Merge branch 'main' into fix/language-es

Author: SrShelo

news/changelog-1.8.md

@@ -23,6 +23,7 @@ All changes included in 1.8:
 - ([#10983](https://github.com/quarto-dev/quarto-cli/issues/10983)): Fix spacing inconsistency between paras and first section headings.
 - ([#12259](https://github.com/quarto-dev/quarto-cli/issues/12259)): Fix conflict between `html-math-method: katex` and crossref popups (author: @benkeks).
 - ([#12341](https://github.com/quarto-dev/quarto-cli/issues/12341)): Enable light and dark logos for html formats (sidebar, navbar, dashboard).
+- ([#12643](https://github.com/quarto-dev/quarto-cli/issues/12643)): Ensure brand.yml logos using urls are rendered correctly by passing them through when resolving brand `processedData`, and not processing them as paths.
 - ([#12734](https://github.com/quarto-dev/quarto-cli/issues/12734)): `highlight-style` now correctly supports setting a different `light` and `dark`.
 - ([#12747](https://github.com/quarto-dev/quarto-cli/issues/12747)): Ensure `th` elements are properly restored when Quarto's HTML table processing is happening.
 - ([#12766](https://github.com/quarto-dev/quarto-cli/issues/12766)): Use consistent equation numbering display for `html-math-method` and `html-math-method.method` for MathJax and KaTeX (author: @mcanouil)
@@ -95,6 +96,10 @@ All changes included in 1.8:
 
 - ([#12965](https://github.com/quarto-dev/quarto-cli/issues/12965)): Prevent automatic opening of new editor sessions when creating projects in Posit Workbench context. The `--open` flag is now ignored in this environment to avoid issues with Workbench session management.
 
+## Extensions
+
+- ([#12559](https://github.com/quarto-dev/quarto-cli/issues/12559)): New extension type: `brand` for distributing [brand.yml](https://posit-dev.github.io/brand-yml/) configurations with associated assets.
+
 ## Engines
 
 - ([#13171](https://github.com/quarto-dev/quarto-cli/pull/13171/)): Provide execution information to all engines uniformly via QUARTO_EXECUTE_INFO environment variable. It points to a file on disk containing a JSON object describing the execution environment for code cells to use.

src/command/create/artifacts/extension.ts

@@ -41,6 +41,7 @@ const kExtensionTypes: Array<string | ExtensionType> = [
   { name: "journal format", value: "journal", openfiles: ["template.qmd"] },
   { name: "custom format", value: "format", openfiles: ["template.qmd"] },
   { name: "metadata", value: "metadata", openfiles: [] },
+  { name: "brand", value: "brand", openfiles: [] },
 ];
 
 const kExtensionSubtypes: Record<string, string[]> = {

src/command/render/project.ts

@@ -14,7 +14,6 @@ import {
 } from "../../deno_ral/fs.ts";
 import { dirname, isAbsolute, join, relative } from "../../deno_ral/path.ts";
 import { info, warning } from "../../deno_ral/log.ts";
-import { mergeProjectMetadata } from "../../config/metadata.ts";
 
 import * as colors from "fmt/colors";
 
@@ -80,7 +79,6 @@ import { Format } from "../../config/types.ts";
 import { fileExecutionEngine } from "../../execute/engine.ts";
 import { projectContextForDirectory } from "../../project/project-context.ts";
 import { ProjectType } from "../../project/types/types.ts";
-import { Zod } from "../../resources/types/zod/schema-types.ts";
 
 const noMutationValidations = (
   projType: ProjectType,
@@ -242,37 +240,11 @@ const getProjectRenderScripts = async (
   return { preRenderScripts, postRenderScripts };
 };
 
-const mergeExtensionMetadata = async (
-  context: ProjectContext,
-  pOptions: RenderOptions,
-) => {
-  // this will mutate context.config.project to merge
-  // in any project metadata from extensions
-  if (context.config) {
-    const extensions = await pOptions.services.extension.extensions(
-      undefined,
-      context.config,
-      context.isSingleFile ? undefined : context.dir,
-      { builtIn: false },
-    );
-    const projectMetadata = extensions.filter((extension) =>
-      extension.contributes.metadata?.project
-    ).map((extension) => {
-      return Zod.ProjectConfig.parse(extension.contributes.metadata!.project);
-    });
-    context.config.project = mergeProjectMetadata(
-      context.config.project,
-      ...projectMetadata,
-    );
-  }
-};
-
 export async function renderProject(
   context: ProjectContext,
   pOptions: RenderOptions,
   pFiles?: string[],
 ): Promise<RenderResult> {
-  await mergeExtensionMetadata(context, pOptions);
   const { preRenderScripts, postRenderScripts } = await getProjectRenderScripts(
     context,
   );

src/core/brand/brand.ts

@@ -32,7 +32,6 @@ import { InternalError } from "../lib/error.ts";
 import { join, relative } from "../../deno_ral/path.ts";
 import { warnOnce } from "../log.ts";
 import { isCssColorName } from "../css/color-names.ts";
-import { assert } from "testing/asserts";
 import {
   LogoLightDarkSpecifierPathOptional,
   LogoOptionsPathOptional,
@@ -246,11 +245,13 @@ export class Brand {
   resolvePath(entry: BrandLogoResource) {
     const pathPrefix = relative(this.projectDir, this.brandDir);
     if (typeof entry === "string") {
-      return { path: join(pathPrefix, entry) };
+      return { path: isExternalPath(entry) ? entry : join(pathPrefix, entry) };
     }
     return {
       ...entry,
-      path: join(pathPrefix, entry.path),
+      path: isExternalPath(entry.path)
+        ? entry.path
+        : join(pathPrefix, entry.path),
     };
   }
 
@@ -270,6 +271,10 @@ export class Brand {
   }
 }
 
+function isExternalPath(path: string) {
+  return /^\w+:/.test(path);
+}
+
 export type LightDarkBrand = {
   light?: Brand;
   dark?: Brand;

src/extension/extension.ts

@@ -17,6 +17,7 @@ import {
 } from "../project/types.ts";
 
 import {
+  basename,
   dirname,
   isAbsolute,
   join,
@@ -158,10 +159,13 @@ export function projectExtensionPathResolver(
   return (href: string, projectOffset: string) => {
     const projectRelativeHref = relative(projectOffset, href);
 
-    if (projectRelativeHref.startsWith("_extensions/")) {
+    if (
+      projectRelativeHref.startsWith("_extensions/") ||
+      projectRelativeHref.startsWith("_extensions\\")
+    ) {
       const projectTargetHref = projectRelativeHref.replace(
-        /^_extensions\//,
-        `${libDir}/quarto-contrib/quarto-project/`,
+        /^_extensions/,
+        `${libDir}/quarto-contrib/quarto-project`,
       );
 
       copyResourceFile(
@@ -791,7 +795,7 @@ async function readExtension(
   const metadata = contributes?.metadata as Record<string, unknown> | undefined;
 
   // resolve metadata/project pre- and post-render scripts to their full path
-  for (const key of ["pre-render", "post-render"]) {
+  for (const key of ["pre-render", "post-render", "brand"]) {
     for (const object of [metadata, project]) {
       if (!object?.project || typeof object.project !== "object") {
         continue;
@@ -808,8 +812,21 @@ async function readExtension(
           [],
         );
         if (resolved.include.length > 0) {
-          (object.project as Record<string, unknown>)[key] = resolved
-            .include;
+          if (key === "brand") {
+            let projectDir = extensionDir, last;
+            do {
+              last = basename(projectDir);
+              projectDir = dirname(projectDir);
+            } while (projectDir && last !== "_extensions");
+            if (projectDir) {
+              (object.project as Record<string, unknown>)[key] = relative(
+                projectDir,
+                resolved.include[0],
+              );
+            }
+          } else {
+            (object.project as Record<string, unknown>)[key] = resolved.include;
+          }
         }
       }
     }

src/project/project-context.ts

@@ -107,6 +107,32 @@ import { createTempContext } from "../core/temp.ts";
 
 import { onCleanup } from "../core/cleanup.ts";
 import { once } from "../core/once.ts";
+import { Zod } from "../resources/types/zod/schema-types.ts";
+
+const mergeExtensionMetadata = async (
+  context: ProjectContext,
+  pOptions: RenderOptions,
+) => {
+  // this will mutate context.config.project to merge
+  // in any project metadata from extensions
+  if (context.config) {
+    const extensions = await pOptions.services.extension.extensions(
+      undefined,
+      context.config,
+      context.isSingleFile ? undefined : context.dir,
+      { builtIn: false },
+    );
+    const projectMetadata = extensions.filter((extension) =>
+      extension.contributes.metadata?.project
+    ).map((extension) => {
+      return Zod.ProjectConfig.parse(extension.contributes.metadata!.project);
+    });
+    context.config.project = mergeProjectMetadata(
+      context.config.project,
+      ...projectMetadata,
+    );
+  }
+};
 
 export async function projectContext(
   path: string,
@@ -145,6 +171,16 @@ export async function projectContext(
     }
   };
 
+  const returnResult = async (
+    context: ProjectContext,
+  ) => {
+    if (renderOptions) {
+      await mergeExtensionMetadata(context, renderOptions);
+    }
+    onCleanup(context.cleanup);
+    return context;
+  };
+
   while (true) {
     // use the current resolver
     const resolver = configResolvers[0];
@@ -362,8 +398,7 @@ export async function projectContext(
           config: configFiles,
           configResources: projectConfigResources(dir, projectConfig, type),
         };
-        onCleanup(result.cleanup);
-        return result;
+        return await returnResult(result);
       } else {
         debug(`projectContext: Found Quarto project in ${dir}`);
         const temp = createTempContext({
@@ -431,8 +466,7 @@ export async function projectContext(
           config: configFiles,
           configResources: projectConfigResources(dir, projectConfig),
         };
-        onCleanup(result.cleanup);
-        return result;
+        return await returnResult(result);
       }
     } else {
       const nextDir = dirname(dir);
@@ -511,8 +545,7 @@ export async function projectContext(
             context.files.input = [input];
           }
           debug(`projectContext: Found Quarto project in ${originalDir}`);
-          onCleanup(context.cleanup);
-          return context;
+          return await returnResult(context);
         } else {
           return undefined;
         }

src/project/project-shared.ts

@@ -560,10 +560,14 @@ export async function projectResolveBrand(
     let fileNames = ["_brand.yml", "_brand.yaml"].map((file) =>
       join(project.dir, file)
     );
-    const brand = project?.config?.brand as boolean | string | {
-      light?: string;
-      dark?: string;
-    };
+    const brand = (project?.config?.brand ??
+      project?.config?.project.brand) as
+        | boolean
+        | string
+        | {
+          light?: string;
+          dark?: string;
+        };
     if (brand === false) {
       project.brandCache.brand = undefined;
       return project.brandCache.brand;

src/resources/create/extensions/brand/.gitignore

@@ -0,0 +1,4 @@
+*.html
+*.pdf
+*_files/
+/.quarto/

src/resources/create/extensions/brand/README.ejs.md

@@ -0,0 +1,22 @@
+# <%= title %> Extension For Quarto
+
+_TODO_: Add a short description of your extension.
+
+## Installing
+
+_TODO_: Replace the `<github-organization>` with your GitHub organization.
+
+```bash
+quarto add <github-organization>/<%= filesafename %>
+```
+
+This will install the extension under the `_extensions` subdirectory.
+If you're using version control, you will want to check in this directory.
+
+## Using
+
+This extension installs a [brand.yml](https://posit-dev.github.io/brand-yml/) configuration for _your organization name_.
+
+## Example
+
+Here is the source code for a minimal example: [example.qmd](example.qmd).

src/resources/create/extensions/brand/_extensions/qstart-filesafename-qend/_extension.ejs.yml

@@ -0,0 +1,8 @@
+title: <%= title %>
+author: <%= author %>
+version: <%= version %>
+quarto-required: ">=<%= quartoversion %>"
+contributes:
+  metadata:
+    project:
+      brand: brand.yml