squiffy-compiler 6.0.0-alpha.0 → 6.0.0-alpha.2

package/dist/compiler.d.ts

@@ -1,3 +1,4 @@
+export declare const SQUIFFY_VERSION = "6.0.0-alpha.2";
 export interface Output {
     story: OutputStory;
     js: string[][];
@@ -40,7 +41,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,12 +1,14 @@
 import * as marked from 'marked';
-import { SQUIFFY_VERSION } from './version.js';
+export const SQUIFFY_VERSION = '6.0.0-alpha.2';
 export async function compile(settings) {
     const story = new Story(settings.scriptBaseFilename);
     const errors = [];
-    async function getJs(storyData) {
+    async function getJs(storyData, excludeHeader) {
         const outputJs = [];
-        outputJs.push(`// Created with Squiffy ${SQUIFFY_VERSION}`);
-        outputJs.push('// https://github.com/textadventures/squiffy');
+        if (!excludeHeader) {
+            outputJs.push(`// Created with Squiffy ${SQUIFFY_VERSION}`);
+            outputJs.push('// https://github.com/textadventures/squiffy');
+        }
         outputJs.push('export const story = {};');
         outputJs.push(`story.id = ${JSON.stringify(storyData.story.id, null, 4)};`);
         outputJs.push(`story.start = ${JSON.stringify(storyData.story.start, null, 4)};`);
@@ -334,11 +336,11 @@ export async function compile(settings) {
     ;
     function writeJs(outputJsFile, tabCount, js) {
         var tabs = new Array(tabCount + 1).join('\t');
-        outputJsFile.push(`${tabs}function() {\n`);
+        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);
@@ -347,8 +349,8 @@ export async function compile(settings) {
         return {
             success: true,
             output: storyData,
-            getJs: () => {
-                return getJs(storyData);
+            getJs: (excludeHeader) => {
+                return getJs(storyData, excludeHeader || false);
             },
             getUiInfo: () => {
                 return {

package/package.json

@@ -1,14 +1,9 @@
 {
   "name": "squiffy-compiler",
-  "version": "6.0.0-alpha.0",
+  "version": "6.0.0-alpha.2",
   "description": "A tool for creating multiple-choice interactive stories",
   "dependencies": {
-    "finalhandler": "^1.3.1",
-    "glob": "^11.0.0",
-    "jszip": "^3.9.1",
-    "marked": "^13.0.2",
-    "serve-static": "^1.16.2",
-    "yargs": "^17.7.2"
+    "marked": "^13.0.2"
   },
   "author": "Alex Warren",
   "contributors": [
@@ -21,26 +16,21 @@
     "url": "git+https://github.com/textadventures/squiffy.git"
   },
   "license": "MIT",
-  "bin": {
-    "squiffy": "squiffy.js"
-  },
   "preferGlobal": true,
   "devDependencies": {
-    "@types/finalhandler": "^1.2.3",
     "@types/node": "^22.5.5",
-    "@types/serve-static": "^1.15.7",
-    "@types/yargs": "^17.0.33",
-    "shx": "^0.3.4",
-    "tsx": "^4.19.1",
+    "glob": "^11.0.0",
     "typescript": "^5.6.2",
     "vitest": "^2.1.1"
   },
   "scripts": {
     "test": "vitest",
-    "build": "tsc && shx cp src/index.template.html ./dist/ && shx cp src/squiffy.runtime.js ./dist/ && shx cp src/style.template.css ./dist/",
-    "dev": "tsc --project tsconfig.runtime.json && tsx src/squiffy.ts"
+    "build": "tsc"
   },
   "main": "dist/compiler.js",
   "types": "dist/compiler.d.ts",
+  "files": [
+    "dist"
+  ],
   "type": "module"
 }

package/dist/compiler.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/compiler.test.js

@@ -1,73 +0,0 @@
-import { expect, test } from 'vitest';
-import * as fs from 'fs';
-import path from 'path';
-import { compile } from './compiler.js';
-import { externalFiles } from './external-files.js';
-function assertSuccess(obj) {
-    if (!obj || typeof obj !== 'object' || !('success' in obj) || !obj.success) {
-        throw new Error('Expected success');
-    }
-}
-test('"Hello world" should compile', async () => {
-    const result = await compile({
-        scriptBaseFilename: "filename.squiffy",
-        script: "hello world",
-    });
-    assertSuccess(result);
-    expect(result.output.story.start).toBe("_default");
-    expect(Object.keys(result.output.story.sections).length).toBe(1);
-    expect(result.output.story.sections._default.text).toBe("<p>hello world</p>");
-});
-const examples = [
-    "attributes/attributes.squiffy",
-    "clearscreen/clearscreen.squiffy",
-    "continue/continue.squiffy",
-    "helloworld/helloworld.squiffy",
-    "import/test.squiffy",
-    "last/last.squiffy",
-    "master/master.squiffy",
-    "replace/replace.squiffy",
-    "rotate/rotate.squiffy",
-    "sectiontrack/sectiontrack.squiffy",
-    "start/start.squiffy",
-    "test/example.squiffy",
-    "textprocessor/textprocessor.squiffy",
-    "transitions/transitions.squiffy",
-    "turncount/turncount.squiffy",
-];
-for (const example of examples) {
-    test(example, async () => {
-        const script = fs.readFileSync(`examples/${example}`, 'utf8');
-        const filename = path.basename(example);
-        const warnings = [];
-        const result = await compile({
-            scriptBaseFilename: filename,
-            script: script,
-            onWarning: (message) => {
-                console.warn(message);
-                warnings.push(message);
-            },
-            externalFiles: externalFiles(`examples/${example}`)
-        });
-        assertSuccess(result);
-        expect(result.output).toMatchSnapshot();
-        expect(warnings.length).toBe(0);
-    });
-}
-const warningExamples = [
-    "warnings/warnings.squiffy",
-    "warnings/warnings2.squiffy",
-];
-for (const example of warningExamples) {
-    test(example, async () => {
-        const script = fs.readFileSync(`examples/${example}`, 'utf8');
-        const filename = path.basename(example);
-        const warnings = [];
-        await compile({
-            scriptBaseFilename: filename,
-            script: script,
-            onWarning: (message) => warnings.push(message)
-        });
-        expect(warnings).toMatchSnapshot();
-    });
-}

package/dist/external-files.d.ts

@@ -1,5 +0,0 @@
-export declare const externalFiles: (inputFilename: string) => {
-    getMatchingFilenames: (pattern: string) => Promise<string[]>;
-    getContent: (filename: string) => Promise<string>;
-    getLocalFilename(filename: string): string;
-};

package/dist/external-files.js

@@ -1,21 +0,0 @@
-import { glob } from "glob";
-import path from "path";
-import fs from "fs/promises";
-export const externalFiles = (inputFilename) => {
-    const includedFiles = [path.resolve(inputFilename)];
-    const basePath = path.resolve(path.dirname(inputFilename));
-    return {
-        getMatchingFilenames: async (pattern) => {
-            const filenames = path.join(basePath, pattern);
-            const result = await glob(filenames);
-            return result.filter((filename) => !includedFiles.includes(filename));
-        },
-        getContent: async (filename) => {
-            includedFiles.push(filename);
-            return (await fs.readFile(filename)).toString();
-        },
-        getLocalFilename(filename) {
-            return path.relative(basePath, filename);
-        }
-    };
-};

package/dist/index.template.html

@@ -1,39 +0,0 @@
-<!DOCTYPE html>
-<html>
-<!-- INFO -->
-	<head>
-		<title><!-- TITLE --></title>
-		<meta name="viewport" content="width=device-width, initial-scale=1">
-		<!-- SCRIPTS -->
-		<script type="module">
-			import { init } from './squiffy.runtime.js';
-			import { story } from './story.js';
-
-			document.addEventListener('DOMContentLoaded', function() {
-				const squiffyApi = init({
-					element: document.getElementById('squiffy'),
-					story: story,
-					persist: true,
-				});
-
-				const restartButton = document.getElementById('restart');
-				restartButton.addEventListener('click', function() {
-					if (confirm('Are you sure you want to restart?')) {
-						squiffyApi.restart();
-					}
-				});
-			});
-		</script>
-		<link rel="stylesheet" href="style.css"/>
-		<!-- STYLESHEETS -->
-	</head>
-	<body>
-		<div id="squiffy-container">
-			<div id="squiffy-header">
-				<button class="squiffy-header-button" id="restart" tabindex="0">Restart</button>
-			</div>
-			<div id="squiffy">
-			</div>
-		</div>
-	</body>
-</html>

package/dist/packager.d.ts

@@ -1 +0,0 @@
-export declare const createPackage: (inputFilename: string) => Promise<string | undefined>;

package/dist/packager.js

@@ -1,78 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import { compile } from './compiler.js';
-import { SQUIFFY_VERSION } from './version.js';
-import { externalFiles } from './external-files.js';
-export const createPackage = async (inputFilename) => {
-    return await generate(inputFilename);
-};
-async function generate(inputFilename) {
-    console.log('Loading ' + inputFilename);
-    var inputFile = fs.readFileSync(inputFilename);
-    var inputText = inputFile.toString();
-    const result = await compile({
-        scriptBaseFilename: path.basename(inputFilename),
-        script: inputText,
-        onWarning: console.warn,
-        externalFiles: externalFiles(inputFilename)
-    });
-    if (!result.success) {
-        console.log('Failed.');
-        return;
-    }
-    var storyJsName = /* typeof options.scriptOnly === 'string' ? options.scriptOnly : */ 'story.js';
-    console.log('Writing ' + storyJsName);
-    var storyJs = await result.getJs();
-    var outputPath = path.resolve(path.dirname(inputFilename));
-    fs.writeFileSync(path.join(outputPath, storyJsName), storyJs);
-    const uiInfo = result.getUiInfo();
-    console.log('Writing squiffy.runtime.js');
-    fs.copyFileSync(path.join(import.meta.dirname, 'squiffy.runtime.js'), path.join(outputPath, 'squiffy.runtime.js'));
-    var cssTemplateFile = fs.readFileSync(findFile('style.template.css', outputPath /*, sourcePath */));
-    var cssData = cssTemplateFile.toString();
-    fs.writeFileSync(path.join(outputPath, 'style.css'), cssData);
-    console.log('Writing index.html');
-    var htmlTemplateFile = fs.readFileSync(findFile('index.template.html', outputPath /*, sourcePath */));
-    var htmlData = htmlTemplateFile.toString();
-    htmlData = htmlData.replace('<!-- INFO -->', `<!--\n\nCreated with Squiffy ${SQUIFFY_VERSION}\n\n\nhttps://github.com/textadventures/squiffy\n\n-->`);
-    htmlData = htmlData.replace('<!-- TITLE -->', uiInfo.title);
-    var scriptData = uiInfo.externalScripts.map(script => `<script src="${script}"></script>`).join('\n');
-    htmlData = htmlData.replace('<!-- SCRIPTS -->', scriptData);
-    var stylesheetData = uiInfo.externalStylesheets.map(sheet => `<link rel="stylesheet" href="${sheet}"/>`).join('\n');
-    htmlData = htmlData.replace('<!-- STYLESHEETS -->', stylesheetData);
-    fs.writeFileSync(path.join(outputPath, 'index.html'), htmlData);
-    console.log('Writing style.css');
-    var cssTemplateFile = fs.readFileSync(findFile('style.template.css', outputPath /*, sourcePath */));
-    var cssData = cssTemplateFile.toString();
-    fs.writeFileSync(path.join(outputPath, 'style.css'), cssData);
-    // if (options.zip) {
-    //     console.log('Creating zip file');
-    //     var JSZip = require('jszip');
-    //     var zip = new JSZip();
-    //     zip.file(storyJsName, storyJs);
-    //     zip.file('index.html', htmlData);
-    //     zip.file('style.css', cssData);
-    //     var buffer = zip.generate({
-    //         type: 'nodebuffer'
-    //     });
-    //     if (options.write) {
-    //         fs.writeFileSync(path.join(outputPath, 'output.zip'), buffer);
-    //     }
-    //     else {
-    //         return buffer;
-    //     }
-    // }
-    console.log('Done.');
-    return outputPath;
-}
-;
-function findFile(filename, outputPath /*, sourcePath: string */) {
-    if (outputPath) {
-        var outputPathFile = path.join(outputPath, filename);
-        if (fs.existsSync(outputPathFile)) {
-            return outputPathFile;
-        }
-    }
-    return path.join(import.meta.dirname, filename);
-}
-;

package/dist/server.d.ts

@@ -1 +0,0 @@
-export declare const serve: (directory: string, port: number) => void;

package/dist/server.js

@@ -1,15 +0,0 @@
-import finalhandler from 'finalhandler';
-import * as http from 'http';
-import serveStatic from 'serve-static';
-function startServer(dir, port) {
-    var serve = serveStatic(dir, { index: ['index.html'] });
-    var server = http.createServer(function (req, res) {
-        var done = finalhandler(req, res);
-        serve(req, res, done);
-    });
-    server.listen(port);
-}
-export const serve = (directory, port) => {
-    startServer(directory, port);
-    console.log('Started http://localhost:' + port + '/');
-};

package/dist/squiffy.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/squiffy.js

@@ -1,29 +0,0 @@
-import yargs from 'yargs';
-import { hideBin } from 'yargs/helpers';
-import { SQUIFFY_VERSION } from './version.js';
-import { createPackage } from './packager.js';
-import { serve } from './server.js';
-const argv = yargs(hideBin(process.argv))
-    .usage(`Usage: $0 filename.squiffy [options]`)
-    .demand(1)
-    .alias('s', 'serve')
-    .alias('p', 'port')
-    .describe('s', 'Start HTTP server after compiling')
-    .describe('p', 'Port for HTTP server (only with --serve)')
-    .describe('scriptonly', 'Only generate JavaScript file (and optionally specify a name)')
-    .describe('zip', 'Create zip file')
-    .parseSync();
-console.log('Squiffy ' + SQUIFFY_VERSION);
-var options = {
-    serve: argv.s,
-    scriptOnly: argv.scriptonly,
-    pluginName: argv.pluginname,
-    zip: argv.zip,
-    write: true,
-};
-const inputFilename = argv._[0];
-var result = await createPackage(inputFilename);
-if (result && options.serve) {
-    var port = argv.p || 8282;
-    serve(result, port);
-}

package/dist/squiffy.runtime.d.ts

@@ -1,34 +0,0 @@
-interface SquiffyInitOptions {
-    element: HTMLElement;
-    story: Story;
-    scroll?: string;
-    persist?: boolean;
-    onSet?: (attribute: string, value: any) => void;
-}
-interface SquiffyApi {
-    restart: () => void;
-    get: (attribute: string) => any;
-    set: (attribute: string, value: any) => void;
-}
-interface Story {
-    js: (() => void)[];
-    start: string;
-    id?: string | null;
-    sections: Record<string, Section>;
-}
-interface Section {
-    text?: string;
-    clear?: boolean;
-    attributes?: string[];
-    jsIndex?: number;
-    passages?: Record<string, Passage>;
-    passageCount?: number;
-}
-interface Passage {
-    text?: string;
-    clear?: boolean;
-    attributes?: string[];
-    jsIndex?: number;
-}
-export declare const init: (options: SquiffyInitOptions) => SquiffyApi;
-export {};

package/dist/squiffy.template.d.ts

@@ -1,29 +0,0 @@
-interface SquiffyInitOptions {
-    element: HTMLElement;
-}
-interface SquiffySettings {
-    scroll: string;
-    persist: boolean;
-    restartPrompt: boolean;
-    onSet: (attribute: string, value: any) => void;
-}
-interface Squiffy {
-    init: (options: SquiffyInitOptions) => void;
-    story: any;
-    ui: {
-        output: HTMLElement;
-        settings: SquiffySettings;
-        processText: (text: string) => string;
-        write: (text: string) => void;
-        clearScreen: () => void;
-        scrollToEnd: () => void;
-        transition: (f: any) => void;
-    };
-    storageFallback: any;
-    set: (attribute: string, value: any) => void;
-    get: (attribute: string) => any;
-}
-export declare const squiffy: Squiffy;
-export declare const get: (attribute: string) => any;
-export declare const set: (attribute: string, value: any) => void;
-export {};