astro-lilypond 0.15.0 → 0.16.0

package/dist/index.d.ts

@@ -31,7 +31,7 @@ export interface RenderOptions {
     format?: "svg" | "png";
     /**
      * Crop `Score` to a single tightly-fit image instead of full pages.
-     * @default resolved from the integration's `defaults.crop`
+     * @default false
      */
     crop?: boolean;
     /**
@@ -54,11 +54,38 @@ export interface RenderResult {
     meta: LilypondMetadata;
     raw: string;
 }
+interface ScoreImageProps {
+    pageLimit?: number;
+    class?: string;
+    style?: string;
+    alt?: string;
+}
 /**
  * Renders a `LilypondScore` (from a `.ly`/`.ily`/`.lilypond` import,
  * or a `lilypondLoader()` entry) to a renderable `<Score />` component.
  */
 export declare function render(score: LilypondScore, options?: RenderOptions): Promise<RenderResult>;
+export interface ScoreProps extends ScoreImageProps {
+    /**
+     * A `LilypondScore` from a `.ly`/`.ily`/`.lilypond` import
+     * or a `lilypondLoader()` entry.
+     */
+    content: LilypondScore;
+    /**
+     * @default "svg"
+     */
+    format?: "svg" | "png";
+    /**
+     * @default false
+     */
+    crop?: boolean;
+}
+/**
+ * Renders a `LilypondScore` directly, for the common case where none of
+ * `render()`'s `pageCount`, `meta`, `raw`, or `pdf` are needed. Use
+ * `render()` instead when you need those.
+ */
+export declare const Score: AstroComponentFactory;
 export declare function renderAll(scores: LilypondScore[], options?: RenderOptions): Promise<RenderResult[]>;
 export interface LilypondOptions extends PluginOptions {
     /**

package/dist/index.js

@@ -1,7 +1,7 @@
-import { createComponent, renderTemplate, unescapeHTML, } from "astro/runtime/server/index.js";
+import { createComponent, renderComponent, renderTemplate, unescapeHTML, } from "astro/runtime/server/index.js";
 import emitAssetIntegration from "astro-emit-asset";
 import { rehypePlugin, remarkPlugin, satteriPlugin, } from "./plugins/index.js";
-import { render as renderScore, resolveCrop, } from "./render.js";
+import { render as renderScore } from "./render.js";
 import { getRenderState, resolveAndSetRenderState } from "./renderState.js";
 import { altTextFor, emitLilypondAsset, emitLilypondPdfAsset, includePathsFor, lyTypeDeclarationsFor, parseLyHeaderFields, prependVersion, renderedHtml, resolveDefaults, sourceNameFor, titleFor, toLilypondMetadata, } from "./utils/index.js";
 export const LY_EXTENSIONS = [".ly", ".lilypond", ".ily"];
@@ -22,9 +22,9 @@ function createScoreComponent(content) {
  */
 export async function render(score, options = {}) {
     const state = getRenderState();
-    const { resolution, crop: cropSetting, cropScale, } = resolveDefaults(state.defaults);
+    const { resolution, cropScale } = resolveDefaults(state.defaults);
     const format = options.format ?? "svg";
-    const crop = options.crop ?? resolveCrop(cropSetting, "component");
+    const crop = options.crop ?? false;
     const [{ Score, pageCount }, pdf] = await Promise.all([
         (async () => {
             const pages = await emitLilypondAsset({
@@ -69,6 +69,16 @@ export async function render(score, options = {}) {
     ]);
     return { Score, pageCount, pdf, meta: score.meta, raw: score.source };
 }
+/**
+ * Renders a `LilypondScore` directly, for the common case where none of
+ * `render()`'s `pageCount`, `meta`, `raw`, or `pdf` are needed. Use
+ * `render()` instead when you need those.
+ */
+export const Score = createComponent(async (result, props) => {
+    const { content, format, crop, ...imageProps } = props;
+    const { Score: ContentScore } = await render(content, { format, crop });
+    return renderTemplate `${renderComponent(result, "Score", ContentScore, imageProps)}`;
+});
 export async function renderAll(scores, options = {}) {
     return Promise.all(scores.map((score) => render(score, options)));
 }

package/dist/plugins/rehype.js

@@ -1,5 +1,5 @@
 import { visit } from "unist-util-visit";
-import { defaultOptions, render, resolveCrop } from "../render.js";
+import { defaultOptions, render } from "../render.js";
 import { altTextForBlock, emitLilypondAsset, includePathsFor, isLilypondLang, prependVersion, renderedHtml, resolveDefaults, sourceNameFor, titleFor, } from "../utils/index.js";
 // Typed loosely so it's assignable to both RehypePlugin and the unified
 // Plugin generic regardless of which @types/hast version the host project pins.
@@ -30,22 +30,21 @@ export function rehypePlugin(options) {
                 .filter((c) => c.type === "text")
                 .map((c) => c.value)
                 .join("");
-            const { version, resolution, crop: cropSetting, cropScale, } = resolveDefaults(options.defaults);
+            const { version, resolution, cropScale } = resolveDefaults(options.defaults);
             const source = version ? prependVersion(raw, version) : raw;
             const format = options.format ?? defaultOptions.format;
-            const crop = resolveCrop(cropSetting, "markdown");
             const alt = altTextForBlock(codeNode.data?.meta, raw);
             const promise = emitLilypondAsset({
                 title,
                 format,
                 source,
                 resolution,
-                crop,
-                sizeScale: crop ? cropScale : 1,
+                crop: true,
+                sizeScale: cropScale,
                 binaryPath: options.binaryPath,
                 render: () => render(source, {
                     format,
-                    crop,
+                    crop: true,
                     defaults: options.defaults,
                     timeout: options.timeout,
                     binaryPath: options.binaryPath,

package/dist/plugins/remark.js

@@ -1,5 +1,5 @@
 import { visit } from "unist-util-visit";
-import { defaultOptions, render, resolveCrop } from "../render.js";
+import { defaultOptions, render } from "../render.js";
 import { altTextForBlock, emitLilypondAsset, includePathsFor, isLilypondLang, prependVersion, renderedHtml, resolveDefaults, sourceNameFor, titleFor, } from "../utils/index.js";
 export const remarkPlugin = (options) => {
     return async (tree, file) => {
@@ -10,22 +10,21 @@ export const remarkPlugin = (options) => {
         visit(tree, "code", (node, index, parent) => {
             if (!isLilypondLang(node.lang) || index === undefined || !parent)
                 return;
-            const { version, resolution, crop: cropSetting, cropScale, } = resolveDefaults(options.defaults);
+            const { version, resolution, cropScale } = resolveDefaults(options.defaults);
             const source = version ? prependVersion(node.value, version) : node.value;
             const format = options.format ?? defaultOptions.format;
-            const crop = resolveCrop(cropSetting, "markdown");
             const alt = altTextForBlock(node.meta, node.value);
             const promise = emitLilypondAsset({
                 title,
                 format,
                 source,
                 resolution,
-                crop,
-                sizeScale: crop ? cropScale : 1,
+                crop: true,
+                sizeScale: cropScale,
                 binaryPath: options.binaryPath,
                 render: () => render(source, {
                     format,
-                    crop,
+                    crop: true,
                     defaults: options.defaults,
                     timeout: options.timeout,
                     binaryPath: options.binaryPath,

package/dist/plugins/satteri.js

@@ -1,4 +1,4 @@
-import { defaultOptions, render, resolveCrop } from "../render.js";
+import { defaultOptions, render } from "../render.js";
 import { altTextForBlock, emitLilypondAsset, includePathsFor, isLilypondLang, prependVersion, renderedHtml, resolveDefaults, sourceNameFor, titleFor, } from "../utils/index.js";
 export function satteriPlugin(options) {
     return {
@@ -9,25 +9,24 @@ export function satteriPlugin(options) {
         async code(node, ctx) {
             if (!isLilypondLang(node.lang))
                 return undefined;
-            const { version, resolution, crop: cropSetting, cropScale, } = resolveDefaults(options.defaults);
+            const { version, resolution, cropScale } = resolveDefaults(options.defaults);
             const source = version ? prependVersion(node.value, version) : node.value;
             const format = options.format ?? defaultOptions.format;
             const includePaths = includePathsFor(ctx.fileURL);
             const sourceName = sourceNameFor(ctx.fileURL);
             const title = titleFor(sourceName);
-            const crop = resolveCrop(cropSetting, "markdown");
             const alt = altTextForBlock(node.meta, node.value);
             const pages = await emitLilypondAsset({
                 title,
                 format,
                 source,
                 resolution,
-                crop,
-                sizeScale: crop ? cropScale : 1,
+                crop: true,
+                sizeScale: cropScale,
                 binaryPath: options.binaryPath,
                 render: () => render(source, {
                     format,
-                    crop,
+                    crop: true,
                     defaults: options.defaults,
                     timeout: options.timeout,
                     binaryPath: options.binaryPath,

package/dist/render.d.ts

@@ -1,22 +1,6 @@
 import type { LilypondVersion } from "./types/lilypondVersion.js";
 export declare const FORMATS: readonly ["png", "svg", "pdf"];
 export type Format = (typeof FORMATS)[number];
-/**
- * Controls whether rendered output is cropped tightly to the content
- * bounding box, or left as full, potentially multi-page, output.
- *
- * - `true` — crop everywhere
- * - `false` — never crop by default
- * - `"markdown-only"` — crop Markdown fences, but leave `render()` uncropped by default
- */
-export type CropSetting = boolean | "markdown-only";
-/** Which kind of consumer is resolving a `CropSetting` — see `resolveCrop`. */
-export type CropContext = "markdown" | "component";
-/**
- * Resolves the three-way `CropSetting` into the plain boolean a given
- * consumer needs, per the semantics documented on `CropSetting`.
- */
-export declare function resolveCrop(cropSetting: CropSetting, context: CropContext): boolean;
 /**
  * Defaults passed to each score for rendering.
  */
@@ -32,12 +16,6 @@ export interface LilypondDefaults {
      * @default 144
      */
     resolution?: number;
-    /**
-     * Crop the output tightly to the content bounding box, producing one
-     * continuous image instead of paginated output.
-     * @default "markdown-only"
-     */
-    crop?: CropSetting;
     /**
      * Multiplies the `width`/`height` on a cropped score's `<img>` tag.
      * Helps compensate for LilyPond's internal size units (points/mm)
@@ -50,10 +28,10 @@ export interface LilypondDefaults {
 }
 /**
  * The subset of `LilypondDefaults` that `render()` itself reads. `version`
- * and `crop` are resolved by the caller before reaching `render()`
- * (`version` by prepending it to source text, `crop` via `resolveCrop`).
+ * is resolved by the caller before reaching `render()`, by prepending it to
+ * source text.
  */
-export type RenderDefaults = Omit<LilypondDefaults, "version" | "crop">;
+export type RenderDefaults = Omit<LilypondDefaults, "version">;
 export interface RenderOptions {
     /**
      * Output format.

package/dist/render.js

@@ -5,13 +5,6 @@ import { execLilyPond } from "./execLilyPond.js";
 import { readOutputFile, safeInputFileName } from "./readOutputFile.js";
 import { resolveDefaults } from "./utils/resolveDefaults.js";
 export const FORMATS = ["png", "svg", "pdf"];
-/**
- * Resolves the three-way `CropSetting` into the plain boolean a given
- * consumer needs, per the semantics documented on `CropSetting`.
- */
-export function resolveCrop(cropSetting, context) {
-    return context === "markdown" ? cropSetting !== false : cropSetting === true;
-}
 export const defaultOptions = {
     format: "svg",
     crop: true,
@@ -20,7 +13,6 @@ export const defaultOptions = {
     defaults: {
         version: "2.26.0",
         resolution: 144,
-        crop: "markdown-only",
         cropScale: 1.5,
     },
 };

package/dist/utils/{emitLilypondAsset.fake.d.ts → __tests__/emitLilypondAsset.fake.d.ts}

@@ -1,5 +1,5 @@
 import type { vi } from "vitest";
-import type { emitLilypondAsset } from "./emitLilypondAsset.js";
+import type { emitLilypondAsset } from "../emitLilypondAsset.js";
 type EmitLilypondAssetMock = ReturnType<typeof vi.mocked<typeof emitLilypondAsset>>;
 export declare function fakeEmitLilypondAsset(mock: EmitLilypondAssetMock, urlBase?: string): void;
 export declare function fakeEmitLilypondAssetPropagatingRenderErrors(mock: EmitLilypondAssetMock): void;

package/dist/utils/{emitLilypondPdfAsset.fake.d.ts → __tests__/emitLilypondPdfAsset.fake.d.ts}

@@ -1,5 +1,5 @@
 import type { vi } from "vitest";
-import type { emitLilypondPdfAsset } from "./emitLilypondPdfAsset.js";
+import type { emitLilypondPdfAsset } from "../emitLilypondPdfAsset.js";
 type EmitLilypondPdfAssetMock = ReturnType<typeof vi.mocked<typeof emitLilypondPdfAsset>>;
 export declare function fakeEmitLilypondPdfAsset(mock: EmitLilypondPdfAssetMock, urlBase?: string): void;
 export {};

package/dist/utils/parseLyHeader.js

@@ -209,9 +209,8 @@ function parseFieldValue(body, start) {
             i++;
         if (body[i] !== "{")
             return null;
+        // body is itself a properly-nested brace sequence (see allHeaderBodies), so this `{` always has a matching `}`.
         const end = matchBalancedBraces(body, i);
-        if (end === -1)
-            return null;
         const value = extractMarkupText(body.slice(i + 1, end));
         return value ? { value, end: end + 1 } : null;
     }

package/dist/utils/resolveDefaults.js

@@ -1,11 +1,10 @@
 import { defaultOptions } from "../render.js";
 /** Fills in any `defaults` fields left unset with `render.ts`'s own defaults. */
 export function resolveDefaults(defaults) {
-    const { version, resolution, crop, cropScale } = defaultOptions.defaults;
+    const { version, resolution, cropScale } = defaultOptions.defaults;
     return {
         version: defaults?.version ?? version,
         resolution: defaults?.resolution ?? resolution,
-        crop: defaults?.crop ?? crop,
         cropScale: defaults?.cropScale ?? cropScale,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-lilypond",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "An Astro integration for rendering Lilypond markup to music notation.",
   "homepage": "https://lilypond.ky.fyi",
   "author": "Ky Decker",
@@ -54,6 +54,7 @@
     "@astrojs/markdown-satteri": "^0.3.4",
     "@types/mdast": "^4.0.4",
     "@types/node": "^26.1.1",
+    "@vitest/coverage-v8": "^4.1.10",
     "astro": "^7.0.8",
     "satteri": "^0.9.5",
     "typescript": "^7.0.2",
@@ -64,6 +65,7 @@
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
     "test": "vitest --project unit",
+    "test:coverage": "vitest run --project unit --coverage",
     "test:integration": "vitest run --project integration"
   }
 }