@rohal12/spindle 0.55.0 → 0.56.0

package/dist/pkg/headless.js

@@ -17735,7 +17735,7 @@ function validateMarkup(passages, options) {
 		for (const piece of codeAndText(src, tokens, parametersOf)) {
 			const at = base + piece.offset;
 			if (piece.kind === "passage") {
-				if (!passageNames.has(piece.name)) {
+				if (options.checkPassageNames !== false && !passageNames.has(piece.name)) {
 					const hint = didYouMean(piece.name, passageNames, JSON.stringify);
 					report(passage, at, `${where}No passage named ${JSON.stringify(piece.name)} in ${piece.label}.${hint}`);
 				}

package/dist/pkg/story-variables.js

@@ -10285,7 +10285,7 @@ function validateMarkup(passages, options) {
 		for (const piece of codeAndText(src, tokens, parametersOf)) {
 			const at = base + piece.offset;
 			if (piece.kind === "passage") {
-				if (!passageNames.has(piece.name)) {
+				if (options.checkPassageNames !== false && !passageNames.has(piece.name)) {
 					const hint = didYouMean(piece.name, passageNames, JSON.stringify);
 					report(passage, at, `${where}No passage named ${JSON.stringify(piece.name)} in ${piece.label}.${hint}`);
 				}
@@ -10473,7 +10473,7 @@ new NameMap();
 * markup, unknown macros and syntax errors in code, with their passage, line
 * and column.
 */
-function validateStoryMarkup(passages, macros) {
+function validateStoryMarkup(passages, macros, options = {}) {
 	const list = [...passages];
 	const known = /* @__PURE__ */ new Set();
 	const parameters = /* @__PURE__ */ new Map();
@@ -10489,7 +10489,8 @@ function validateStoryMarkup(passages, macros) {
 		isKnownMacro: (name) => known.has(name),
 		macroNames: known,
 		parametersOf: (name) => parameters.get(name),
-		isBlockMacro: (name) => blocks.has(name.toLowerCase()) || isBlockMacro(name)
+		isBlockMacro: (name) => blocks.has(name.toLowerCase()) || isBlockMacro(name),
+		checkPassageNames: options.checkPassageNames
 	});
 }
 //#endregion

package/dist/pkg/tooling.js

@@ -55,6 +55,6 @@ export function getMacroRegistry() {
  * macros and those registered with defineMacro), with passage, line and
  * column.
  */
-export function validateMarkup(passages) {
-  return validateStoryMarkup(passages, metadata.values());
+export function validateMarkup(passages, options) {
+  return validateStoryMarkup(passages, metadata.values(), options);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rohal12/spindle",
-  "version": "0.55.0",
+  "version": "0.56.0",
   "type": "module",
   "description": "A Preact-based story format for Twine 2.",
   "license": "Unlicense",

package/src/markup/validate.ts

@@ -52,6 +52,11 @@ export interface MarkupValidationOptions {
    * others are still read for the widgets they define.
    */
   only?(passage: MarkupPassage): boolean;
+  /**
+   * Whether passage names written out must name one of the passages
+   * (default: true). Off when only part of a story is validated.
+   */
+  checkPassageNames?: boolean;
   /**
    * The declared parameters of a macro, whose `expression` and `statements`
    * arguments are checked as code and whose `text` and `string` arguments
@@ -232,7 +237,10 @@ export function validateMarkup(
     for (const piece of codeAndText(src, tokens, parametersOf)) {
       const at = base + piece.offset;
       if (piece.kind === 'passage') {
-        if (!passageNames.has(piece.name)) {
+        if (
+          options.checkPassageNames !== false &&
+          !passageNames.has(piece.name)
+        ) {
           const hint = didYouMean(piece.name, passageNames, JSON.stringify);
           report(
             passage,

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}: …`.