@rohal12/spindle 0.55.0 → 0.57.0

package/src/tooling.ts

@@ -19,6 +19,16 @@ export { formatDiagnostic } from './markup/validate';
 export type { MarkupDiagnostic, MarkupPassage } from './markup/validate';
 
 /** What tooling knows about a macro (see MacroMetadata). */
+/** Options for validating markup from tooling. */
+export interface ValidateMarkupOptions {
+  /**
+   * Whether passage names written out (links, quoted `passage` arguments)
+   * must name one of the passages given (default: true). Turn it off to
+   * validate only part of a story.
+   */
+  checkPassageNames?: boolean;
+}
+
 export interface ToolingMacro {
   name: string;
   block: boolean;
@@ -36,6 +46,7 @@ export interface ToolingMacro {
 export function validateStoryMarkup(
   passages: Iterable<MarkupPassage>,
   macros: Iterable<ToolingMacro>,
+  options: ValidateMarkupOptions = {},
 ): MarkupDiagnostic[] {
   const list = [...passages];
   const known = new Set<string>();
@@ -54,5 +65,6 @@ export function validateStoryMarkup(
     parametersOf: (name) => parameters.get(name),
     isBlockMacro: (name) =>
       blocks.has(name.toLowerCase()) || isBlockMacro(name),
+    checkPassageNames: options.checkPassageNames,
   });
 }

package/src/types-drift-check.ts

@@ -115,5 +115,5 @@ const _exampleMacro: PublishedMacroDefinition = {
 // metadata.
 declare const validateStoryMarkup: typeof SourceValidateStoryMarkup;
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-const _validateMarkup: typeof PublishedValidateMarkup = (passages) =>
-  validateStoryMarkup(passages, []);
+const _validateMarkup: typeof PublishedValidateMarkup = (passages, options) =>
+  validateStoryMarkup(passages, [], options);

package/types/tooling.d.ts

@@ -142,8 +142,19 @@ export interface MarkupDiagnostic {
  */
 export declare function validateMarkup(
   passages: Iterable<MarkupPassage>,
+  options?: ValidateMarkupOptions,
 ): MarkupDiagnostic[];
 
+/** Options for {@link validateMarkup}. */
+export interface ValidateMarkupOptions {
+  /**
+   * Whether passage names written out (links, quoted `passage` arguments)
+   * must name one of `passages` (default: true). Turn it off to validate
+   * only part of a story.
+   */
+  checkPassageNames?: boolean;
+}
+
 /**
  * A diagnostic as one line of text, as Spindle shows it:
  * `Passage "Start", line 3, column 5 (story.twee:12): Unclosed {if}: …`.