bare-script 3.0.15 → 3.2.0

package/lib/bare.js

@@ -1,10 +1,13 @@
 // Licensed under the MIT License
 // https://github.com/craigahobbs/bare-script/blob/main/LICENSE
 
+import {dirname, join} from 'path';
 import {parseExpression, parseScript} from './parser.js';
 import {evaluateExpression} from './runtime.js';
 import {executeScriptAsync} from './runtimeAsync.js';
+import {fileURLToPath} from 'url';
 import {lintScript} from './model.js';
+import {readFile} from 'fs/promises';
 import {urlFileRelative} from './options.js';
 import {valueBoolean} from './value.js';
 
@@ -51,8 +54,14 @@ export async function main(options) {
             globals[varName] = evaluateExpression(parseExpression(varExpr));
         }
 
+        // Get the scripts to run
+        let {scripts} = args;
+        if (args.markdownUp) {
+            scripts = [['code', 'include <markdownUp.bare>'], ...scripts];
+        }
+
         // Parse and execute all source files in order
-        for (const [scriptType, scriptValue] of args.scripts) {
+        for (const [scriptType, scriptValue] of scripts) {
             // Get the script source
             let scriptName;
             let scriptSource;
@@ -103,12 +112,14 @@ export async function main(options) {
 
             // Execute the script
             const timeBegin = performance.now();
+            const {fetchFn} = options;
+            const fetchIncludeFn = (fetchURL, fetchOptions) => fetchInclude(fetchFn, fetchURL, fetchOptions);
             const result = await executeScriptAsync(script, {
                 'debug': args.debug ?? false,
-                'fetchFn': options.fetchFn,
+                'fetchFn': fetchIncludeFn,
                 'globals': globals,
                 'logFn': options.logFn,
-                'systemPrefix': 'https://craigahobbs.github.io/markdown-up/include/',
+                'systemPrefix': fetchIncludePrefix,
                 'urlFn': scriptType === 'file' ? (url) => urlFileRelative(scriptName, url) : null
 
             });
@@ -141,6 +152,35 @@ export async function main(options) {
 }
 
 
+function fetchInclude(fetchFn, url, options) {
+    // Is this a bare system include?
+    if (url.startsWith(fetchIncludePrefix)) {
+        const includePath = url.slice(fetchIncludePrefixPrefix.length);
+
+        // Get the include file path
+        const packageDir = dirname(fileURLToPath(import.meta.url));
+        const packagePath = join(packageDir, includePath);
+
+        // Return the include fetch-like promise
+        return new Promise((resolve) => {
+            const response = {
+                'ok': true,
+                'status': 200,
+                'statusText': 'OK',
+                'text': () => readFile(packagePath, 'utf8')
+            };
+            resolve(response);
+        });
+    }
+
+    return fetchFn(url, options);
+}
+
+
+const fetchIncludePrefixPrefix = ':bare-include:/';
+const fetchIncludePrefix = `${fetchIncludePrefixPrefix}include/`;
+
+
 /**
  * Parse the BareScript command-line interface (CLI) arguments
  *
@@ -163,6 +203,8 @@ export function parseArgs(argv) {
             args.debug = true;
         } else if (arg === '-h' || arg === '--help') {
             args.help = true;
+        } else if (arg === '-m' || arg === '--markdown-up') {
+            args.markdownUp = true;
         } else if (arg === '-s' || arg === '--static') {
             args.static = true;
         } else if (arg === '-v' || arg === '--var') {
@@ -184,7 +226,7 @@ export function parseArgs(argv) {
 
 // The command-line interface (CLI) help text
 export const helpText = `\
-usage: bare [-h] [-c CODE] [-d] [-s] [-v VAR EXPR] [file ...]
+usage: bare [-h] [-c CODE] [-d] [-m] [-s] [-v VAR EXPR] [file ...]
 
 The BareScript command-line interface
 
@@ -195,5 +237,6 @@ options:
   -h, --help          show this help message and exit
   -c, --code CODE     execute the BareScript code
   -d, --debug         enable debug mode
+  -m, --markdown-up   run with MarkdownUp stubs
   -s, --static        perform static analysis
   -v, --var VAR EXPR  set a global variable to an expression value`;

package/lib/include/args.mds

@@ -0,0 +1,344 @@
+# Licensed under the MIT License
+# https://github.com/craigahobbs/markdown-up/blob/main/LICENSE
+
+
+# Include sentinel
+if systemGlobalGet('argsSentinel'):
+    return
+endif
+argsSentinel = true
+
+
+# The URL arguments model
+argsTypes = schemaParse( \
+    'group "Args"', \
+    '', \
+    '', \
+    '# An argument model list', \
+    'typedef ArgsArgument[len > 0] ArgsArguments', \
+    '', \
+    '', \
+    '# An argument model', \
+    'struct ArgsArgument', \
+    '', \
+    '    # The argument name', \
+    '    string(len > 0) name', \
+    '', \
+    '    # The argument type', \
+    '    optional ArgsType type', \
+    '', \
+    "    # The argument's global variable name", \
+    '    optional string(len > 0) global', \
+    '', \
+    '    # If true, the argument is explicit.', \
+    '    # An explicit argument is only included in the URL if it is in the arguments object.', \
+    '    optional bool explicit', \
+    '', \
+    '    # The default argument value', \
+    '    optional object default', \
+    '', \
+    '    # The argument description', \
+    '    optional string(len > 0) description', \
+    '', \
+    '', \
+    '# An argument value type', \
+    'enum ArgsType', \
+    '    bool', \
+    '    date', \
+    '    datetime', \
+    '    float', \
+    '    int', \
+    '    string' \
+)
+
+
+# $function: argsValidate
+# $group: args.mds
+# $doc: Validate an arguments model
+# $arg arguments: The [arguments model](includeModel.html#var.vName='ArgsArguments')
+# $return: The validated [arguments model](includeModel.html#var.vName='ArgsArguments') or null if validation fails
+function argsValidate(arguments):
+    validatedArguments = schemaValidate(argsTypes, 'ArgsArguments', arguments)
+
+    # Check for duplicate arguments
+    if validatedArguments != null:
+        argNames = objectNew()
+        for argument in arguments:
+            name = objectGet(argument, 'name')
+            if objectHas(argNames, name):
+                validatedArguments = null
+                systemLogDebug('MarkdownUp - args.mds: Duplicate argument "' + name + '"')
+            else:
+                objectSet(argNames, name, true)
+            endif
+        endfor
+    endif
+
+    return validatedArguments
+endfunction
+
+
+# $function: argsParse
+# $group: args.mds
+# $doc: Parse an [arguments model](includeModel.html#var.vName='ArgsArguments').
+# $doc: Argument globals are validated and added to the arguments object using the argument name.
+# $arg arguments: The [arguments model](includeModel.html#var.vName='ArgsArguments')
+# $return: The arguments object
+function argsParse(arguments):
+    # Create the arguments object
+    args = objectNew()
+    for argument in arguments:
+        # Get the argument value
+        global = argsGlobalName(argument)
+        value = argsValidateValue(systemGlobalGet(global), objectGet(argument, 'type'), global)
+
+        # Apply the default argument value, if any
+        if value == null:
+            value = objectGet(argument, 'default')
+        endif
+
+        # Set the argument value, if any
+        if value != null:
+            objectSet(args, objectGet(argument, 'name'), value)
+        endif
+    endfor
+
+    return args
+endfunction
+
+
+# $function: argsURL
+# $group: args.mds
+# $doc: Create a MarkdownUp application URL
+# $arg arguments: The [arguments model](includeModel.html#var.vName='ArgsArguments')
+# $arg args: Optional (default is null). The arguments object. Null argument values are excluded from the URL.
+# $arg explicit: Optional (default is false). If true, arguments are only included in the URL if they are in the arguments object.
+# $arg headerText: Optional (default is null). If non-null, the URL's header text.
+# $arg headerText: The special "_top" header ID scrolls to the top of the page.
+# $arg url: Optional (default is null). If non-null, the MarkdownUp URL hash parameter.
+# $return: The MarkdownUp application URL
+function argsURL(arguments, args, explicit, headerText, url):
+    # Get the URL variables
+    urlVars = arrayNew()
+    argNames = objectNew()
+    for argument in arguments:
+        name = objectGet(argument, 'name')
+        type = objectGet(argument, 'type')
+        global = argsGlobalName(argument)
+        default = objectGet(argument, 'default')
+
+        # Add the argument name (for unknown argument check below)
+        objectSet(argNames, name, null)
+
+        # Add the URL variable, if any
+        value = null
+        if args != null && objectHas(args, name):
+            value = argsValidateValue(objectGet(args, name), type, global)
+        elif !(explicit || objectGet(argument, 'explicit')):
+            value = argsValidateValue(systemGlobalGet(global), type, global, false)
+        endif
+
+        # Add the URL variable
+        if value != null && (default == null || !argsValuesEqual(value, default, type)):
+            arrayPush(urlVars, 'var.' + global + '=' + urlEncodeComponent(argsFormatValue(value, type)))
+        endif
+    endfor
+
+    # Sort the URL variables for general consistency
+    arraySort(urlVars)
+
+    # Check for unknown arguments
+    if args != null:
+        for name in objectKeys(args):
+            if !objectHas(argNames, name):
+                systemLogDebug('MarkdownUp - args.mds: Unknown argument "' + name + '"')
+            endif
+        endfor
+    endif
+
+    # Create the URL
+    return '#' + if(url != null, 'url=' + urlEncodeComponent(url) + '&', '') + \
+        if(arrayLength(urlVars), arrayJoin(urlVars, '&'), 'var=') + \
+        if(headerText != null, '&' + if(headerText == argsTopHeaderId, argsTopHeaderId, markdownHeaderId(headerText)), '')
+endfunction
+
+
+# The special "top" header ID
+argsTopHeaderId = '_top'
+
+
+# $function: argsLink
+# $group: args.mds
+# $doc: Create a Markdown link text to a MarkdownUp application URL
+# $arg arguments: The [arguments model](includeModel.html#var.vName='ArgsArguments')
+# $arg text: The link text
+# $arg args: Optional (default is null). The arguments object.
+# $arg explicit: Optional (default is false). If true, arguments are only included in the URL if they are in the arguments object.
+# $arg headerText: Optional (default is null). If non-null, the URL's header text.
+# $arg headerText: The special "_top" header ID scrolls to the top of the page.
+# $arg url: Optional (default is null). If non-null, the MarkdownUp URL hash parameter.
+# $return: The Markdown link text
+function argsLink(arguments, text, args, explicit, headerText, url):
+    return '[' + markdownEscape(text) + '](' + argsURL(arguments, args, explicit, headerText, url) + ')'
+endfunction
+
+
+# $function: argsHelp
+# $group: args.mds
+# $doc: Output the [arguments model's](includeModel.html#var.vName='ArgsArguments') help
+# $arg arguments: The [arguments model](includeModel.html#var.vName='ArgsArguments')
+function argsHelp(arguments):
+    # Create the help data
+    helpData = arrayNew()
+    anyDefault = false
+    anyExplicit = false
+    anyDescription = false
+    for argument in arguments:
+        type = objectGet(argument, 'type', 'string')
+        default = objectGet(argument, 'default')
+        explicit = objectGet(argument, 'explicit')
+        description = objectGet(argument, 'description')
+
+        # Add the help data row
+        arrayPush(helpData, objectNew( \
+            'Variable', argsGlobalName(argument), \
+            'Type', type, \
+            'Default', argsFormatValue(default, type), \
+            'Explicit', if(explicit, 'Yes', ''), \
+            'Description', if(description != null, description, '') \
+        ))
+
+        # Update the "any" field bools
+        anyDefault = anyDefault || (default != null)
+        anyExplicit = anyExplicit || explicit
+        anyDescription = anyDescription || (description != null)
+    endfor
+
+    # Render the help table
+    helpFields = arrayNew('Variable', 'Type')
+    if anyDefault:
+        arrayPush(helpFields, 'Default')
+    endif
+    if anyExplicit:
+        arrayPush(helpFields, 'Explicit')
+    endif
+    if anyDescription:
+        arrayPush(helpFields, 'Description')
+    endif
+    dataTable(helpData, objectNew('fields', helpFields))
+endfunction
+
+
+# Helper function to compute an argument's global name
+function argsGlobalName(argument):
+    global = objectGet(argument, 'global')
+    if global == null:
+        name = objectGet(argument, 'name')
+        global = 'v' + stringUpper(stringSlice(name, 0, 1)) + stringSlice(name, 1)
+    endif
+    return global
+endfunction
+
+
+# Helper function to format an argument value
+function argsFormatValue(value, type):
+    # No value?
+    if value == null:
+        return ''
+    endif
+
+    # Return the formatted value
+    if type == 'bool':
+        return if(value, 'true', 'false')
+    elif type == 'date':
+        return "'" + datetimeISOFormat(value, true) + "'"
+    elif type == 'datetime':
+        return "'" + datetimeISOFormat(value) + "'"
+    elif type == 'float':
+        return stringNew(value)
+    elif type == 'int':
+        return stringNew(value)
+    endif
+
+    # type == 'string'
+    return "'" + value + "'"
+endfunction
+
+
+# Helper function to validate an argument value's type
+function argsValidateValue(value, type, global, warn):
+    # No value?
+    if value == null:
+        return null
+    endif
+
+    # Validate the value's type
+    valueType = systemType(value)
+    if type == 'bool':
+        if valueType == 'number' && (value == 0 || value == 1):
+            value = !!value
+        elif valueType != 'boolean':
+            if warn != false:
+                systemLogDebug('MarkdownUp - args.mds: Invalid value ' + jsonStringify(value) + ' for URL argument "' + global + '"')
+            endif
+            value = null
+        endif
+    elif type == 'date':
+        valueOrig = value
+        if valueType == 'string':
+            value = datetimeISOParse(value)
+            valueType = systemType(value)
+        endif
+        if valueType != 'datetime' || datetimeHour(value) != 0 || datetimeMinute(value) != 0 || datetimeSecond(value) != 0:
+            if warn != false:
+                systemLogDebug('MarkdownUp - args.mds: Invalid value ' + jsonStringify(valueOrig) + ' for URL argument "' + global + '"')
+            endif
+            value = null
+        endif
+    elif type == 'datetime':
+        valueOrig = value
+        if valueType == 'string':
+            value = datetimeISOParse(value)
+            valueType = systemType(value)
+        endif
+        if valueType != 'datetime':
+            if warn != false:
+                systemLogDebug('MarkdownUp - args.mds: Invalid value ' + jsonStringify(valueOrig) + ' for URL argument "' + global + '"')
+            endif
+            value = null
+        endif
+    elif type == 'float':
+        if valueType != 'number':
+            if warn != false:
+                systemLogDebug('MarkdownUp - args.mds: Invalid value ' + jsonStringify(value) + ' for URL argument "' + global + '"')
+            endif
+            value = null
+        endif
+    elif type == 'int':
+        if valueType != 'number' || value != mathFloor(value):
+            if warn != false:
+                systemLogDebug('MarkdownUp - args.mds: Invalid value ' + jsonStringify(value) + ' for URL argument "' + global + '"')
+            endif
+            value = null
+        endif
+    else:
+        # type == 'string'
+        if valueType != 'string':
+            if warn != false:
+                systemLogDebug('MarkdownUp - args.mds: Invalid value ' + jsonStringify(value) + ' for URL argument "' + global + '"')
+            endif
+            value = null
+        endif
+    endif
+
+    return value
+endfunction
+
+
+# Helper function to determine if two values are equal
+function argsValuesEqual(value, valueOther, type):
+    if type == 'date' || type == 'datetime':
+        return (value - valueOther) == 0
+    endif
+    return value == valueOther
+endfunction

package/lib/include/forms.mds

@@ -0,0 +1,79 @@
+# Licensed under the MIT License
+# https://github.com/craigahobbs/markdown-up/blob/main/LICENSE
+
+
+# Include sentinel
+if systemGlobalGet('formsSentinel'):
+    return
+endif
+formsSentinel = true
+
+
+# $function: formsTextElements
+# $group: forms.mds
+# $doc: Create a text input [element model](https://github.com/craigahobbs/element-model#readme)
+# $arg id: The text input element ID
+# $arg text: The initial text of the text input element
+# $arg size: Optional (default is null). The size, in characters, of the text input element
+# $arg onEnter: Optional (default is null). The text input element on-enter event handler
+# $return: The text input [element model](https://github.com/craigahobbs/element-model#readme)
+function formsTextElements(id, text, size, onEnter):
+    return objectNew( \
+        'html', 'input', \
+        'attr', objectNew( \
+            'autocomplete', 'off', \
+            'id', id, \
+            'style', 'font-size: inherit; border: thin solid black; padding: 0.4em;', \
+            'type', 'text', \
+            'value', text, \
+            'size', size \
+        ), \
+        'callback', if(onEnter != null, objectNew('keyup', systemPartial(formsTextOnKeyup, onEnter))) \
+    )
+endfunction
+
+
+async function formsTextOnKeyup(onEnter, keyCode):
+    if keyCode == 13:
+        onEnter()
+    endif
+endfunction
+
+
+# $function: formsLinkButtonElements
+# $group: forms.mds
+# $doc: Create a link button [element model](https://github.com/craigahobbs/element-model#readme)
+# $arg text: The link button's text
+# $arg onClick: The link button's click event handler
+# $return: The link button [element model](https://github.com/craigahobbs/element-model#readme)
+function formsLinkButtonElements(text, onClick):
+    return objectNew( \
+        'html', 'a', \
+        'attr', objectNew('style', 'cursor: pointer; user-select: none;'), \
+        'elem', objectNew('text', text), \
+        'callback', objectNew('click', onClick) \
+    )
+endfunction
+
+
+# $function: formsLinkElements
+# $group: forms.mds
+# $doc: Create a link [element model](https://github.com/craigahobbs/element-model#readme)
+# $arg text: The link's text
+# $arg url: The link's URL. If null, the link is rendered as text.
+# $return: The link [element model](https://github.com/craigahobbs/element-model#readme)
+function formsLinkElements(text, url):
+    if url == null:
+        return objectNew( \
+            'html', 'span', \
+            'attr', objectNew('style', 'user-select: none;'), \
+            'elem', objectNew('text', text) \
+        )
+    endif
+
+    return objectNew( \
+        'html', 'a', \
+        'attr', objectNew('href', documentURL(url)), \
+        'elem', objectNew('text', text) \
+    )
+endfunction