squiffy-compiler 6.0.0-alpha.1 → 6.0.0-alpha.17

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2024 Alex Warren, textadventures.co.uk and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/dist/compiler.d.ts

@@ -1,4 +1,3 @@
-export declare const SQUIFFY_VERSION = "6.0.0-alpha.0";
 export interface Output {
     story: OutputStory;
     js: string[][];
@@ -6,6 +5,7 @@ export interface Output {
 interface OutputStory {
     start: string;
     id: string | null;
+    uiJsIndex?: number;
     sections: Record<string, OutputSection>;
 }
 interface OutputSection {
@@ -23,10 +23,11 @@ interface OutputPassage {
     jsIndex?: number;
 }
 interface CompilerSettings {
-    scriptBaseFilename: string;
+    scriptBaseFilename?: string;
     script: string;
     onWarning?: (message: string) => void;
     externalFiles?: ExternalFiles;
+    globalJs?: boolean;
 }
 interface ExternalFiles {
     getMatchingFilenames(pattern: string): Promise<string[]>;
@@ -41,7 +42,7 @@ interface UiInfo {
 export interface CompileSuccess {
     success: true;
     output: Output;
-    getJs: () => Promise<string>;
+    getJs: (excludeHeader?: boolean) => Promise<string>;
     getUiInfo: () => UiInfo;
 }
 export interface CompileError {

package/dist/compiler.js

@@ -1,22 +1,33 @@
-import * as marked from 'marked';
-export const SQUIFFY_VERSION = '6.0.0-alpha.0';
+import pkg from "../package.json" with { type: "json" };
+const version = pkg.version;
 export async function compile(settings) {
     const story = new Story(settings.scriptBaseFilename);
     const errors = [];
-    async function getJs(storyData) {
+    let autoSectionCount = 0;
+    async function getJs(storyData, excludeHeader) {
         const outputJs = [];
-        outputJs.push(`// Created with Squiffy ${SQUIFFY_VERSION}`);
-        outputJs.push('// https://github.com/textadventures/squiffy');
-        outputJs.push('export const story = {};');
+        if (!excludeHeader) {
+            outputJs.push(`// Created with Squiffy ${version}`);
+            outputJs.push("// https://github.com/textadventures/squiffy");
+        }
+        if (settings.globalJs) {
+            outputJs.push("var story = {};");
+        }
+        else {
+            outputJs.push("export const story = {};");
+        }
         outputJs.push(`story.id = ${JSON.stringify(storyData.story.id, null, 4)};`);
+        if (storyData.story.uiJsIndex !== undefined) {
+            outputJs.push(`story.uiJsIndex = ${storyData.story.uiJsIndex};`);
+        }
         outputJs.push(`story.start = ${JSON.stringify(storyData.story.start, null, 4)};`);
         outputJs.push(`story.sections = ${JSON.stringify(storyData.story.sections, null, 4)};`);
-        outputJs.push('story.js = [');
+        outputJs.push("story.js = [");
         for (const js of storyData.js) {
             writeJs(outputJs, 1, js);
         }
-        outputJs.push('];');
-        return outputJs.join('\n');
+        outputJs.push("];");
+        return outputJs.join("\n");
     }
     async function getStoryData() {
         if (!story.start) {
@@ -30,6 +41,10 @@ export async function compile(settings) {
             },
             js: [],
         };
+        if (story.uiJs.length > 0) {
+            output.js.push(story.uiJs);
+            output.story.uiJsIndex = output.js.length - 1;
+        }
         for (const sectionName of Object.keys(story.sections)) {
             const section = story.sections[sectionName];
             const outputSection = {};
@@ -37,7 +52,7 @@ export async function compile(settings) {
             if (section.clear) {
                 outputSection.clear = true;
             }
-            outputSection.text = await processText(section.text.join('\n'), section, null);
+            outputSection.text = await processText(section.text.join("\n"), section, null);
             if (section.attributes.length > 0) {
                 outputSection.attributes = section.attributes;
             }
@@ -45,10 +60,10 @@ export async function compile(settings) {
                 output.js.push(section.js);
                 outputSection.jsIndex = output.js.length - 1;
             }
-            if ('@last' in section.passages) {
-                var passageCount = 0;
+            if ("@last" in section.passages) {
+                let passageCount = 0;
                 for (const passageName of Object.keys(section.passages)) {
-                    if (passageName.length > 0 && passageName?.substring(0, 1) !== '@') {
+                    if (passageName.length > 0 && passageName?.substring(0, 1) !== "@") {
                         passageCount++;
                     }
                 }
@@ -64,7 +79,7 @@ export async function compile(settings) {
                 if (passage.clear) {
                     outputPassage.clear = true;
                 }
-                outputPassage.text = await processText(passage.text.join('\n'), section, passage);
+                outputPassage.text = await processText(passage.text.join("\n"), section, passage);
                 if (passage.attributes.length > 0) {
                     outputPassage.attributes = passage.attributes;
                 }
@@ -76,7 +91,6 @@ export async function compile(settings) {
         }
         return output;
     }
-    ;
     const regexes = {
         section: /^\[\[(.*)\]\]:$/,
         passage: /^\[(.*)\]:$/,
@@ -87,28 +101,38 @@ export async function compile(settings) {
         unset: /^@unset (.*)$/,
         inc: /^@inc (\S+)(?: (\d+))?$/,
         dec: /^@dec (\S+)(?: (\d+))?$/,
-        replace: /^@replace (.*$)/,
         js: /^(\t| {4})(.*)$/,
         continue: /^\+\+\+(.*)$/,
+        ui: /^@ui (.*)$/,
     };
     async function processFileText(inputText, inputFilename, isFirst) {
-        var inputLines = inputText.replace(/\r/g, '').split('\n');
-        var lineCount = 0;
-        var autoSectionCount = 0;
-        var section = null;
-        var passage = null; // annotated differently to section, as a workaround for TypeScript "Property does not exist on type never"
-        var textStarted = false;
-        var ensureThisSectionExists = () => {
+        const inputLines = inputText.replace(/\r/g, "").split("\n");
+        let lineCount = 0;
+        let section = null;
+        let passage = null; // annotated differently to section, as a workaround for TypeScript "Property does not exist on type never"
+        let textStarted = false;
+        let inUiBlock = false;
+        const ensureThisSectionExists = () => {
             return ensureSectionExists(section, isFirst, inputFilename, lineCount);
         };
-        const secondPass = [];
+        const addAutoSection = () => {
+            autoSectionCount++;
+            const autoSectionName = `_continue${autoSectionCount}`;
+            section = story.addSection(autoSectionName, inputFilename, lineCount);
+            passage = null;
+            textStarted = false;
+            return autoSectionName;
+        };
         for (const line of inputLines) {
-            var stripLine = line.trim();
+            const stripLine = line.trim();
             lineCount++;
-            var match = {};
+            const match = {};
             for (const key of Object.keys(regexes)) {
                 const regex = regexes[key];
-                match[key] = key == 'js' ? regex.exec(line) : regex.exec(stripLine);
+                const result = key == "js" ? regex.exec(line) : regex.exec(stripLine);
+                if (result) {
+                    match[key] = result;
+                }
             }
             if (match.section) {
                 section = story.addSection(match.section[1], inputFilename, lineCount);
@@ -117,7 +141,7 @@ export async function compile(settings) {
             }
             else if (match.passage) {
                 if (!section) {
-                    errors.push(`ERROR: ${inputFilename} line ${lineCount}: Can\'t add passage "${match.passage[1]}" as no section has been created.`);
+                    errors.push(`ERROR: ${inputFilename} line ${lineCount}: Can't add passage "${match.passage[1]}" as no section has been created.`);
                     return false;
                 }
                 section = ensureThisSectionExists();
@@ -126,14 +150,29 @@ export async function compile(settings) {
             }
             else if (match.continue) {
                 section = ensureThisSectionExists();
-                autoSectionCount++;
-                var autoSectionName = `_continue${autoSectionCount}`;
-                section.addText(`[[${match.continue[1]}]](${autoSectionName})`);
-                section = story.addSection(autoSectionName, inputFilename, lineCount);
-                passage = null;
-                textStarted = false;
+                const previousSection = section;
+                const autoSectionName = addAutoSection();
+                const text = match.continue[1] || "Continue...";
+                previousSection.addText(`[[${text}]](${autoSectionName})`);
             }
-            else if (stripLine == '@clear') {
+            else if (stripLine == "---") {
+                inUiBlock = false;
+                if (!section) {
+                    // Just add the _default section if we haven't started yet
+                    ensureThisSectionExists();
+                }
+                else {
+                    addAutoSection();
+                }
+            }
+            else if (stripLine == "@ui") {
+                inUiBlock = true;
+            }
+            else if (match.ui && settings.externalFiles) {
+                const content = await settings.externalFiles.getContent(match.ui[1]);
+                story.addUiJs(content);
+            }
+            else if (stripLine == "@clear") {
                 if (!passage) {
                     section = ensureThisSectionExists();
                     section.clear = true;
@@ -149,18 +188,18 @@ export async function compile(settings) {
                 story.start = match.start[1];
             }
             else if (match.import && settings.externalFiles) {
-                var importFilenames = await settings.externalFiles.getMatchingFilenames(match.import[1]);
+                const importFilenames = await settings.externalFiles.getMatchingFilenames(match.import[1]);
                 for (const importFilename of importFilenames) {
-                    if (importFilename.endsWith('.squiffy')) {
+                    if (importFilename.endsWith(".squiffy")) {
                         const content = await settings.externalFiles.getContent(importFilename);
-                        var success = await processFileText(content, importFilename, false);
+                        const success = await processFileText(content, importFilename, false);
                         if (!success)
                             return false;
                     }
-                    else if (importFilename.endsWith('.js')) {
+                    else if (importFilename.endsWith(".js")) {
                         story.scripts.push(settings.externalFiles.getLocalFilename(importFilename));
                     }
-                    else if (importFilename.endsWith('.css')) {
+                    else if (importFilename.endsWith(".css")) {
                         story.stylesheets.push(settings.externalFiles.getLocalFilename(importFilename));
                     }
                 }
@@ -171,31 +210,21 @@ export async function compile(settings) {
             }
             else if (match.unset) {
                 section = ensureThisSectionExists();
-                section = addAttribute('not ' + match.unset[1], section, passage, isFirst, inputFilename, lineCount);
+                section = addAttribute("not " + match.unset[1], section, passage, isFirst, inputFilename, lineCount);
             }
             else if (match.inc) {
                 section = ensureThisSectionExists();
-                section = addAttribute(match.inc[1] + '+=' + (match.inc[2] === undefined ? '1' : match.inc[2]), section, passage, isFirst, inputFilename, lineCount);
+                section = addAttribute(match.inc[1] + "+=" + (match.inc[2] === undefined ? "1" : match.inc[2]), section, passage, isFirst, inputFilename, lineCount);
             }
             else if (match.dec) {
                 section = ensureThisSectionExists();
-                section = addAttribute(match.dec[1] + '-=' + (match.dec[2] === undefined ? '1' : match.dec[2]), section, passage, isFirst, inputFilename, lineCount);
-            }
-            else if (match.replace) {
-                const thisSection = ensureThisSectionExists();
-                const thisPassage = passage;
-                var replaceAttribute = match.replace[1];
-                var attributeMatch = /^(.*?)=(.*)$/.exec(replaceAttribute);
-                secondPass.push(async () => {
-                    // add this to secondPass functions, because processText might result in links to passages which have not been created yet
-                    if (attributeMatch) {
-                        replaceAttribute = attributeMatch[1] + '=' + await processText(attributeMatch[2], thisSection, null);
-                    }
-                    addAttribute('@replace ' + replaceAttribute, section, thisPassage, isFirst, inputFilename, lineCount);
-                });
+                section = addAttribute(match.dec[1] + "-=" + (match.dec[2] === undefined ? "1" : match.dec[2]), section, passage, isFirst, inputFilename, lineCount);
             }
             else if (!textStarted && match.js) {
-                if (!passage) {
+                if (inUiBlock) {
+                    story.addUiJs(match.js[2]);
+                }
+                else if (!passage) {
                     section = ensureThisSectionExists();
                     section.addJS(match.js[2]);
                 }
@@ -204,7 +233,10 @@ export async function compile(settings) {
                 }
             }
             else if (textStarted || stripLine.length > 0) {
-                if (!passage) {
+                if (inUiBlock) {
+                    errors.push(`ERROR: ${inputFilename} line ${lineCount}: Unexpected text in @ui block.`);
+                }
+                else if (!passage) {
                     section = ensureThisSectionExists();
                     if (section) {
                         section.addText(line);
@@ -217,19 +249,14 @@ export async function compile(settings) {
                 }
             }
         }
-        for (const fn of secondPass) {
-            await fn();
-        }
         return true;
     }
-    ;
     function ensureSectionExists(section, isFirst, inputFilename, lineCount) {
         if (!section && isFirst) {
-            section = story.addSection('_default', inputFilename, lineCount);
+            section = story.addSection("_default", inputFilename, lineCount);
         }
         return section;
     }
-    ;
     function addAttribute(attribute, section, passage, isFirst, inputFilename, lineCount) {
         if (!passage) {
             section = ensureSectionExists(section, isFirst, inputFilename, lineCount);
@@ -240,7 +267,24 @@ export async function compile(settings) {
         }
         return section;
     }
-    ;
+    function extractLinkFunctions(link) {
+        const fragments = link.split(",");
+        return {
+            target: fragments[0].trim(),
+            setters: fragments.slice(1).join(", ")
+        };
+    }
+    function getAdditionalLinkParameters(link) {
+        const functions = extractLinkFunctions(link);
+        let additionalParameters = "";
+        if (functions.setters.length > 0) {
+            additionalParameters += ` set="${functions.setters}"`;
+        }
+        return {
+            target: functions.target,
+            additionalParameters
+        };
+    }
     async function processText(input, section, passage) {
         // namedSectionLinkRegex matches:
         //   open [[
@@ -249,10 +293,13 @@ export async function compile(settings) {
         //   open bracket
         //   any text - the name of the section
         //   closing bracket
-        var namedSectionLinkRegex = /\[\[([^\]]*?)\]\]\((.*?)\)/g;
-        var links = allMatchesForGroup(input, namedSectionLinkRegex, 2);
+        const namedSectionLinkRegex = /\[\[([^\]]*?)\]\]\((.*?)\)/g;
+        let links = allMatchesForGroup(input, namedSectionLinkRegex, 2);
         checkSectionLinks(links, section, passage);
-        input = input.replace(namedSectionLinkRegex, '<a class="squiffy-link link-section" data-section="$2" role="link" tabindex="0">$1</a>');
+        input = input.replace(namedSectionLinkRegex, (_match, text /* $1 */, name /* $2 */) => {
+            const parsedName = getAdditionalLinkParameters(name);
+            return `{{section "${parsedName.target}" text="${text}"${parsedName.additionalParameters}}}`;
+        });
         // namedPassageLinkRegex matches:
         //   open [
         //   any text - the link text
@@ -260,68 +307,61 @@ export async function compile(settings) {
         //   open bracket, but not http(s):// after it
         //   any text - the name of the passage
         //   closing bracket
-        var namedPassageLinkRegex = /\[([^\]]*?)\]\(((?!https?:\/\/).*?)\)/g;
+        const namedPassageLinkRegex = /\[([^\]]*?)\]\(((?!https?:\/\/).*?)\)/g;
         links = allMatchesForGroup(input, namedPassageLinkRegex, 2);
         checkPassageLinks(links, section, passage);
-        input = input.replace(namedPassageLinkRegex, '<a class="squiffy-link link-passage" data-passage="$2" role="link" tabindex="0">$1</a>');
+        input = input.replace(namedPassageLinkRegex, (_match, text /* $1 */, name /* $2 */) => {
+            const parsedName = getAdditionalLinkParameters(name);
+            return `{{passage "${parsedName.target}" text="${text}"${parsedName.additionalParameters}}}`;
+        });
         // unnamedSectionLinkRegex matches:
         //   open [[
         //   any text - the link text
         //   closing ]]
-        var unnamedSectionLinkRegex = /\[\[(.*?)\]\]/g;
+        const unnamedSectionLinkRegex = /\[\[(.*?)\]\]/g;
         links = allMatchesForGroup(input, unnamedSectionLinkRegex, 1);
         checkSectionLinks(links, section, passage);
-        input = input.replace(unnamedSectionLinkRegex, '<a class="squiffy-link link-section" data-section="$1" role="link" tabindex="0">$1</a>');
+        input = input.replace(unnamedSectionLinkRegex, '{{section "$1"}}');
         // unnamedPassageLinkRegex matches:
         //   open [
         //   any text - the link text
         //   closing ]
         //   no bracket after
-        var unnamedPassageLinkRegex = /\[(.*?)\]([^\(]|$)/g;
+        const unnamedPassageLinkRegex = /\[(.*?)\]([^(]|$)/g;
         links = allMatchesForGroup(input, unnamedPassageLinkRegex, 1);
         checkPassageLinks(links, section, passage);
-        input = input.replace(unnamedPassageLinkRegex, '<a class="squiffy-link link-passage" data-passage="$1" role="link" tabindex="0">$1</a>$2');
-        return (await marked.parse(input)).trim();
+        input = input.replace(unnamedPassageLinkRegex, '{{passage "$1"}}$2');
+        return input;
     }
-    ;
     function allMatchesForGroup(input, regex, groupNumber) {
-        var result = [];
-        var match;
-        while (!!(match = regex.exec(input))) {
+        const result = [];
+        let match;
+        while ((match = regex.exec(input))) {
             result.push(match[groupNumber]);
         }
         return result;
     }
-    ;
     function checkSectionLinks(links, section, passage) {
-        var badLinks = links.filter(m => !linkDestinationExists(m, story.sections));
-        showBadLinksWarning(badLinks, 'section', '[[', ']]', section, passage);
+        const badLinks = links.filter(m => !linkDestinationExists(m, story.sections));
+        showBadLinksWarning(badLinks, "section", "[[", "]]", section, passage);
     }
-    ;
     function checkPassageLinks(links, section, passage) {
-        var badLinks = links.filter(m => !linkDestinationExists(m, section.passages));
-        showBadLinksWarning(badLinks, 'passage', '[', ']', section, passage);
+        const badLinks = links.filter(m => !linkDestinationExists(m, section.passages));
+        showBadLinksWarning(badLinks, "passage", "[", "]", section, passage);
     }
-    ;
     function linkDestinationExists(link, keys) {
         // Link destination data may look like:
         //   passageName
         //   passageName, my_attribute=2
-        //   passageName, @replace 1=new text, some_attribute=5
-        //   @replace 2=some words
         // We're only interested in checking if the named passage or section exists.
-        var linkDestination = link.split(',')[0];
-        if (linkDestination.substring(0, 1) == '@') {
-            return true;
-        }
+        const linkDestination = link.split(",")[0];
         return Object.keys(keys).includes(linkDestination);
     }
-    ;
     function showBadLinksWarning(badLinks, linkTo, before, after, section, passage) {
         if (!settings.onWarning)
             return;
         for (const badLink of badLinks) {
-            var warning;
+            let warning;
             if (!passage) {
                 warning = `${section.filename} line ${section.line}: In section '${section.name}'`;
             }
@@ -331,24 +371,25 @@ export async function compile(settings) {
             settings.onWarning(`WARNING: ${warning} there is a link to a ${linkTo} called ${before}${badLink}${after}, which doesn't exist`);
         }
     }
-    ;
     function writeJs(outputJsFile, tabCount, js) {
-        var tabs = new Array(tabCount + 1).join('\t');
-        outputJsFile.push(`${tabs}function() {\n`);
+        const tabs = new Array(tabCount + 1).join("\t");
+        outputJsFile.push(`${tabs}(squiffy, get, set) => {`);
         for (const jsLine of js) {
-            outputJsFile.push(`${tabs}\t${jsLine}\n`);
+            outputJsFile.push(`${tabs}\t${jsLine}`);
         }
-        outputJsFile.push(`${tabs}},\n`);
+        outputJsFile.push(`${tabs}},`);
     }
-    ;
     const success = await processFileText(settings.script, settings.scriptBaseFilename, true);
     if (success) {
+        if (!Object.keys(story.sections).length) {
+            ensureSectionExists(null, true, settings.scriptBaseFilename, 0);
+        }
         const storyData = await getStoryData();
         return {
             success: true,
             output: storyData,
-            getJs: () => {
-                return getJs(storyData);
+            getJs: (excludeHeader) => {
+                return getJs(storyData, excludeHeader || false);
             },
             getUiInfo: () => {
                 return {
@@ -378,7 +419,7 @@ class Story {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: ''
+            value: ""
         });
         Object.defineProperty(this, "scripts", {
             enumerable: true,
@@ -396,7 +437,7 @@ class Story {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: ''
+            value: ""
         });
         Object.defineProperty(this, "id", {
             enumerable: true,
@@ -404,6 +445,12 @@ class Story {
             writable: true,
             value: null
         });
+        Object.defineProperty(this, "uiJs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: []
+        });
         this.id = inputFilename || null;
     }
     addSection(name, filename, line) {
@@ -411,7 +458,9 @@ class Story {
         this.sections[name] = section;
         return section;
     }
-    ;
+    addUiJs(text) {
+        this.uiJs.push(text);
+    }
 }
 class Section {
     constructor(name, filename, line) {
@@ -468,23 +517,19 @@ class Section {
         this.line = line;
     }
     addPassage(name, line) {
-        var passage = new Passage(name, line);
+        const passage = new Passage(name, line);
         this.passages[name] = passage;
         return passage;
     }
-    ;
     addText(text) {
         this.text.push(text);
     }
-    ;
     addJS(text) {
         this.js.push(text);
     }
-    ;
     addAttribute(text) {
         this.attributes.push(text);
     }
-    ;
 }
 class Passage {
     constructor(name, line) {
@@ -530,13 +575,10 @@ class Passage {
     addText(text) {
         this.text.push(text);
     }
-    ;
     addJS(text) {
         this.js.push(text);
     }
-    ;
     addAttribute(text) {
         this.attributes.push(text);
     }
-    ;
 }

package/package.json

@@ -1,10 +1,7 @@
 {
   "name": "squiffy-compiler",
-  "version": "6.0.0-alpha.1",
+  "version": "6.0.0-alpha.17",
   "description": "A tool for creating multiple-choice interactive stories",
-  "dependencies": {
-    "marked": "^13.0.2"
-  },
   "author": "Alex Warren",
   "contributors": [
     "CrisisSDK",
@@ -18,19 +15,21 @@
   "license": "MIT",
   "preferGlobal": true,
   "devDependencies": {
-    "@types/node": "^22.5.5",
-    "glob": "^11.0.0",
-    "typescript": "^5.6.2",
-    "vitest": "^2.1.1"
+    "@types/node": "^24.3.0",
+    "glob": "^11.0.3",
+    "typescript": "^5.9.2",
+    "vitest": "^3.2.4"
   },
   "scripts": {
-    "test": "vitest",
-    "build": "tsc"
+    "test": "vitest --run",
+    "build": "tsc",
+    "prepublishOnly": "npm run build && npm run test"
   },
   "main": "dist/compiler.js",
   "types": "dist/compiler.d.ts",
   "files": [
     "dist"
   ],
-  "type": "module"
+  "type": "module",
+  "gitHead": "59e410271573c741dbc7c6031b7aab5619d9d1c7"
 }