astro-lilypond 1.0.0 → 1.1.0

package/README.md

@@ -9,42 +9,12 @@ An [Astro](https://astro.build) integration for rendering [LilyPond](https://lil
 - Use the content loader to pass in a folder full of `.ly` files and get back an Astro content collection.
 - Works with all LilyPond syntax.
 
-Read the docs: https://lilypond.ky.fyi
-
-## Quick Start
-
-### 1. Install `astro-lilypond`
+## Quick start
 
 ```sh
-pnpm add astro-lilypond
-```
-
-### 2. Add the integration to your Astro config
-
-```js
-// astro.config.mjs
-import { defineConfig } from 'astro/config';
-import lilypond from 'astro-lilypond';
-
-export default defineConfig({
-  integrations: [lilypond()]
-});
+npx astro add astro-lilypond
 ```
 
-### 3. Write your music
-
-Write LilyPond code within fenced code blocks with the `lilypond`, `ly`, or `ily` language tag.
-
-````md
-```lilypond
-  \\score ...
-```
-````
-
-Your score will be built to `.svg` or `.png` and display alongside the rest of your content.
-
----
-
 For more info, refer to the docs: https://lilypond.ky.fyi
 
 Happy notating!

package/dist/index.d.ts

@@ -94,5 +94,11 @@ export interface LilypondOptions extends PluginOptions {
      * @default true
      */
     autoInstall?: boolean | AutoInstallOptions;
+    /**
+     * Extra directories to search for `\include`d files, in addition to each
+     * score's own directory. Relative paths resolve against the project root.
+     * @default []
+     */
+    includePaths?: string[];
 }
 export default function lilypond(options?: LilypondOptions): AstroIntegration;

package/dist/index.js

@@ -1,3 +1,4 @@
+import { fileURLToPath } from "node:url";
 import { createComponent, renderComponent, renderTemplate, unescapeHTML, } from "astro/runtime/server/index.js";
 import emitAssetIntegration from "astro-emit-asset";
 import { resolveAutoInstallOption, resolveLilypondBinary, } from "./binary/index.js";
@@ -114,7 +115,7 @@ function lyFilePlugin(options) {
                 return;
             const { version } = resolveDefaults(options.defaults);
             const src = version ? prependVersion(source, version) : source;
-            const includePaths = includePathsFor(id);
+            const includePaths = includePathsFor(id, options.includePaths);
             const sourceName = sourceNameFor(id);
             const assetTitle = titleFor(sourceName);
             const meta = toLilypondMetadata(parseLyHeaderFields(source));
@@ -147,12 +148,15 @@ export default function lilypond(options = {}) {
                     warn: (message) => logger.warn(message),
                 });
                 options.binaryPath = binaryPath;
+                const includePaths = (options.includePaths ?? []).map((path) => fileURLToPath(new URL(path, config.root)));
+                options.includePaths = includePaths;
                 setLilypondState({
                     binaryPath,
                     defaults: options.defaults,
                     timeout: options.timeout,
                     isDev,
                     logger,
+                    includePaths,
                 });
                 updateConfig({
                     integrations: [emitAssetIntegration()],

package/dist/loader.js

@@ -80,7 +80,7 @@ export function lilypondLoader({ pattern = DEFAULT_PATTERN, base, generateId = d
                 const id = generateId({ entry, base: baseUrl, header: headerFields });
                 const digest = generateDigest(source);
                 const src = prependVersion(source, version);
-                const includePaths = includePathsFor(filePath);
+                const includePaths = includePathsFor(filePath, getLilypondState().includePaths);
                 const sourceName = sourceNameFor(filePath);
                 const assetTitle = titleFor(sourceName);
                 const meta = toLilypondMetadata(headerFields);

package/dist/plugins/remark.js

@@ -9,7 +9,7 @@ export const remarkPlugin = (options) => {
     const renderOptions = { ...options, logger };
     return async (tree, file) => {
         const promises = [];
-        const includePaths = includePathsFor(file?.path);
+        const includePaths = includePathsFor(file?.path, options.includePaths);
         const sourceName = sourceNameFor(file?.path);
         const title = titleFor(sourceName);
         visit(tree, "code", (node, index, parent) => {

package/dist/plugins/satteri.js

@@ -16,7 +16,7 @@ export function satteriPlugin(options) {
                 title: titleFor(sourceName),
                 value: node.value,
                 meta: node.meta,
-                includePaths: includePathsFor(ctx.fileURL),
+                includePaths: includePathsFor(ctx.fileURL, options.includePaths),
                 sourceName,
             });
             return { rawHtml };

package/dist/plugins/types.d.ts

@@ -6,4 +6,5 @@ export interface PluginOptions {
     binaryPath?: string;
     isDev?: boolean;
     logger?: Pick<AstroIntegrationLogger, "warn" | "error">;
+    includePaths?: string[];
 }

package/dist/state.d.ts

@@ -6,6 +6,7 @@ export interface LilypondState {
     timeout: number | undefined;
     isDev: boolean;
     logger: Pick<AstroIntegrationLogger, "warn" | "error">;
+    includePaths: string[];
 }
 export declare function setLilypondState(state: LilypondState): void;
 export declare function getLilypondState(): LilypondState;

package/dist/utils/includePathsFor.d.ts

@@ -1,6 +1,7 @@
 /**
- * Derives `render()`'s `includePaths` from the source file's path or URL, so
- * `\include`d sibling files resolve even though rendering happens in a temp
- * directory. Returns `[]` when the source location is unknown.
+ * Make sure that any `\include` definitions resolve correctly when
+ * LilyPond compiles the score. `source` is the current directory or URL
+ * of the .ly file; `extra` is for user-defined locations from the
+ * config setting `includePaths`.
  */
-export declare function includePathsFor(source: string | URL | null | undefined): string[];
+export declare function includePathsFor(source: string | URL | null | undefined, extra?: string[]): string[];

package/dist/utils/includePathsFor.js

@@ -1,13 +1,14 @@
 import { dirname } from "node:path";
 import { fileURLToPath } from "node:url";
 /**
- * Derives `render()`'s `includePaths` from the source file's path or URL, so
- * `\include`d sibling files resolve even though rendering happens in a temp
- * directory. Returns `[]` when the source location is unknown.
+ * Make sure that any `\include` definitions resolve correctly when
+ * LilyPond compiles the score. `source` is the current directory or URL
+ * of the .ly file; `extra` is for user-defined locations from the
+ * config setting `includePaths`.
  */
-export function includePathsFor(source) {
+export function includePathsFor(source, extra = []) {
     if (!source)
-        return [];
+        return extra;
     const path = typeof source === "string" ? source : fileURLToPath(source);
-    return [dirname(path)];
+    return [dirname(path), ...extra];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-lilypond",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "An Astro integration for rendering Lilypond markup to music notation.",
   "homepage": "https://lilypond.ky.fyi",
   "author": "Ky Decker",