bare-script 3.5.5 → 3.7.0

package/README.md

@@ -36,7 +36,7 @@ function or the
 [executeScriptAsync](https://craigahobbs.github.io/bare-script/module-lib_runtimeAsync.html#.executeScriptAsync)
 function. For example:
 
-~~~ javascript
+``` javascript
 import {executeScript} from 'bare-script/lib/runtime.js';
 import {parseScript} from 'bare-script/lib/parser.js';
 
@@ -53,13 +53,13 @@ return N + ' times 2 is ' + double(N)
 // Execute the script
 const globals = {'N': 10};
 console.log(executeScript(script, {globals}));
-~~~
+```
 
 This outputs:
 
-~~~
+```
 10 times 2 is 20
-~~~
+```
 
 
 ### The BareScript Library
@@ -73,7 +73,7 @@ of the
 [arrayLength](https://craigahobbs.github.io/bare-script/library/#var.vGroup='Array'&arraylength)
 functions.
 
-~~~ javascript
+``` javascript
 import {executeScriptAsync} from 'bare-script/lib/runtimeAsync.js';
 import {parseScript} from 'bare-script/lib/parser.js';
 
@@ -88,13 +88,13 @@ return 'The BareScript Library has ' + arrayLength(objectGet(docs, 'functions'))
 
 // Execute the script
 console.log(await executeScriptAsync(script, {'fetchFn': fetch}));
-~~~
+```
 
 This outputs:
 
-~~~
+```
 The BareScript Library has 105 functions
-~~~
+```
 
 
 ## Evaluating BareScript Expressions
@@ -115,7 +115,7 @@ a set of built-in, spreadsheet-like functions.
 
 For example:
 
-~~~ javascript
+``` javascript
 import {evaluateExpression} from 'bare-script/lib/runtime.js';
 import {parseExpression} from 'bare-script/lib/parser.js';
 
@@ -125,13 +125,13 @@ const expr = parseExpression('2 * max(a, b, c)');
 // Evaluate the expression
 const variables = {'a': 1, 'b': 2, 'c': 3};
 console.log(evaluateExpression(expr, null, variables))
-~~~
+```
 
 This outputs:
 
-~~~
+```
 6
-~~~
+```
 
 
 ## The BareScript Command-Line Interface (CLI)
@@ -139,9 +139,9 @@ This outputs:
 You can run BareScript from the command line using the BareScript CLI, "bare". BareScript script
 files use the ".bare" file extension.
 
-~~~
+```
 bare script.bare
-~~~
+```
 
 **Note:** In the BareScript CLI, import statements and the
 [systemFetch](https://craigahobbs.github.io/bare-script/library/#var.vGroup='System'&systemfetch)
@@ -163,15 +163,15 @@ with functions for dynamically rendering Markdown text, drawing SVG images, etc.
 
 For example:
 
-```
+~~~
 # Markdown Application
 
 This is a Markdown document with embedded BareScript:
 
-~~~ markdown-script
+``` markdown-script
 markdownPrint('Hello, Markdown!')
-~~~
 ```
+~~~
 
 
 ## Development
@@ -179,6 +179,6 @@ markdownPrint('Hello, Markdown!')
 This package is developed using [javascript-build](https://github.com/craigahobbs/javascript-build#readme).
 It was started using [javascript-template](https://github.com/craigahobbs/javascript-template#readme) as follows:
 
-~~~
+```
 template-specialize javascript-template/template/ bare-script/ -k package bare-script -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapp 1
-~~~
+```

package/lib/bare.js

@@ -46,7 +46,6 @@ export async function main(options) {
 
     let statusCode = 0;
     let inlineCount = 0;
-    let errorName = null;
     try {
         // Evaluate the global variable expression arguments
         const globals = {};
@@ -81,22 +80,22 @@ export async function main(options) {
                 }
             } else {
                 inlineCount += 1;
-                scriptName = `-c ${inlineCount}`;
+                scriptName = `<string${inlineCount > 1 ? inlineCount : ''}>`;
                 scriptSource = scriptValue;
             }
 
             // Parse the script source
-            errorName = scriptName;
-            const script = parseScript(scriptSource);
+            const script = parseScript(scriptSource, 1, scriptName);
 
             // Run the bare-script linter?
             if (args.static || args.debug) {
                 const warnings = lintScript(script);
-                const warningPrefix = `BareScript: Static analysis "${scriptName}" ...`;
                 if (warnings.length === 0) {
-                    options.logFn(`${warningPrefix} OK`);
+                    options.logFn(`BareScript: Static analysis "${scriptName}" ... OK`);
                 } else {
-                    options.logFn(`${warningPrefix} ${warnings.length} warning${warnings.length > 1 ? 's' : ''}:`);
+                    options.logFn(
+                        `BareScript: Static analysis "${scriptName}" ... ${warnings.length} warning${warnings.length > 1 ? 's' : ''}:`
+                    );
                     for (const warning of warnings) {
                         options.logFn(`BareScript:     ${warning}`);
                     }
@@ -141,9 +140,6 @@ export async function main(options) {
             }
         }
     } catch ({message}) {
-        if (errorName !== null) {
-            options.logFn(`${errorName}:`);
-        }
         options.logFn(message);
         statusCode = 1;
     }

package/lib/include/args.bare

@@ -67,7 +67,7 @@ function argsValidate(arguments):
             name = objectGet(argument, 'name')
             if objectHas(argNames, name):
                 validatedArguments = null
-                systemLogDebug('MarkdownUp - args.bare: Duplicate argument "' + name + '"')
+                systemLogDebug('args.bare: Duplicate argument "' + name + '"')
             else:
                 objectSet(argNames, name, true)
             endif
@@ -151,7 +151,7 @@ function argsURL(arguments, args, explicit, headerText, url):
     if args != null:
         for name in objectKeys(args):
             if !objectHas(argNames, name):
-                systemLogDebug('MarkdownUp - args.bare: Unknown argument "' + name + '"')
+                systemLogDebug('args.bare: Unknown argument "' + name + '"')
             endif
         endfor
     endif
@@ -279,7 +279,7 @@ function argsValidateValue(value, type, global, warn):
             value = !!value
         elif valueType != 'boolean':
             if warn != false:
-                systemLogDebug('MarkdownUp - args.bare: Invalid value ' + jsonStringify(value) + ' for URL argument "' + global + '"')
+                systemLogDebug('args.bare: Invalid value ' + jsonStringify(value) + ' for URL argument "' + global + '"')
             endif
             value = null
         endif
@@ -291,7 +291,7 @@ function argsValidateValue(value, type, global, warn):
         endif
         if valueType != 'datetime' || datetimeHour(value) != 0 || datetimeMinute(value) != 0 || datetimeSecond(value) != 0:
             if warn != false:
-                systemLogDebug('MarkdownUp - args.bare: Invalid value ' + jsonStringify(valueOrig) + ' for URL argument "' + global + '"')
+                systemLogDebug('args.bare: Invalid value ' + jsonStringify(valueOrig) + ' for URL argument "' + global + '"')
             endif
             value = null
         endif
@@ -303,21 +303,21 @@ function argsValidateValue(value, type, global, warn):
         endif
         if valueType != 'datetime':
             if warn != false:
-                systemLogDebug('MarkdownUp - args.bare: Invalid value ' + jsonStringify(valueOrig) + ' for URL argument "' + global + '"')
+                systemLogDebug('args.bare: Invalid value ' + jsonStringify(valueOrig) + ' for URL argument "' + global + '"')
             endif
             value = null
         endif
     elif type == 'float':
         if valueType != 'number':
             if warn != false:
-                systemLogDebug('MarkdownUp - args.bare: Invalid value ' + jsonStringify(value) + ' for URL argument "' + global + '"')
+                systemLogDebug('args.bare: 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.bare: Invalid value ' + jsonStringify(value) + ' for URL argument "' + global + '"')
+                systemLogDebug('args.bare: Invalid value ' + jsonStringify(value) + ' for URL argument "' + global + '"')
             endif
             value = null
         endif
@@ -325,7 +325,7 @@ function argsValidateValue(value, type, global, warn):
         # type == 'string'
         if valueType != 'string':
             if warn != false:
-                systemLogDebug('MarkdownUp - args.bare: Invalid value ' + jsonStringify(value) + ' for URL argument "' + global + '"')
+                systemLogDebug('args.bare: Invalid value ' + jsonStringify(value) + ' for URL argument "' + global + '"')
             endif
             value = null
         endif

package/lib/include/dataTable.bare

@@ -0,0 +1,211 @@
+# Licensed under the MIT License
+# https://github.com/craigahobbs/markdown-up/blob/main/LICENSE
+
+
+# Include sentinel
+if systemGlobalGet('dataTableSentinel'):
+    return
+endif
+dataTableSentinel = true
+
+
+# The data table model's Schema Markdown
+dataTableTypes = schemaParse( \
+    'group "Data Table"', \
+    '', \
+    '', \
+    '# A data table model', \
+    'struct DataTable', \
+    '', \
+    "    # The table's fields", \
+    '    optional string[len > 0] fields', \
+    '', \
+    "    # The table's category fields", \
+    '    optional string[len > 0] categories', \
+    '', \
+    '    # The field formatting for "categories" and "fields"', \
+    '    optional DataTableFieldFormat{len > 0} formats', \
+    '', \
+    '    # The numeric formatting precision (default is 2)', \
+    '    optional int(>= 0) precision', \
+    '', \
+    '    # The datetime format', \
+    '    optional DataTableDatetimeFormat datetime', \
+    '', \
+    '    # If true, trim formatted values (default is true)', \
+    '    optional bool trim', \
+    '', \
+    '', \
+    '# A data table field formatting model', \
+    'struct DataTableFieldFormat', \
+    '', \
+    '    # The field alignment', \
+    '    optional DataTableFieldAlignment align', \
+    '', \
+    "    # If true, don't wrap text", \
+    '    optional bool nowrap', \
+    '', \
+    '    # If true, format the field as Markdown', \
+    '    optional bool markdown', \
+    '', \
+    '    # The field header (default is the field name)', \
+    '    optional string header', \
+    '', \
+    '', \
+    '# A field alignment', \
+    'enum DataTableFieldAlignment', \
+    '    left', \
+    '    right', \
+    '    center', \
+    '', \
+    '', \
+    '# A datetime format', \
+    'enum DataTableDatetimeFormat', \
+    '', \
+    '    # ISO datetime year format', \
+    '    year', \
+    '', \
+    '    # ISO datetime month format', \
+    '    month', \
+    '', \
+    '    # ISO datetime day format', \
+    '    day' \
+)
+
+
+# $function: dataTableMarkdown
+# $group: dataTable.bare
+# $doc: Create the array of Markdown table line strings
+# $arg data: The array of row objects
+# $arg model: The [data table model](includeModel.html#var.vName='DataTable')
+# $return: The array of Markdown table line strings
+function dataTableMarkdown(data, model):
+    # Validate the data
+    data = dataValidate(data)
+    if data == null:
+        return null
+    endif
+
+    # Validate the table model
+    if model != null && !schemaValidate(dataTableTypes, 'DataTable', model):
+        return null
+    endif
+
+    # Determine the table fields
+    fields = arrayNew()
+    modelFields = if(model != null, objectGet(model, 'fields'))
+    modelCategories = if(model != null, objectGet(model, 'categories'))
+    if modelFields != null || modelCategories != null:
+        if modelCategories != null:
+            arrayExtend(fields, modelCategories)
+        endif
+        if modelFields != null:
+            arrayExtend(fields, modelFields)
+        endif
+    elif arrayLength(data) > 0:
+        arrayExtend(fields, objectKeys(arrayGet(data, 0)))
+    endif
+    if !arrayLength(fields):
+        return null
+    endif
+
+    # Get precision and formatting
+    precisionDatetime = if(model != null, objectGet(model, 'datetime'))
+    precisionNumber = if(model != null, objectGet(model, 'precision', 2), 2)
+    precisionTrim = if(model != null, objectGet(model, 'trim', true), true)
+    formats = if(model != null, objectGet(model, 'formats'))
+
+    # Compute the field header widths
+    widths = objectNew()
+    for field in fields:
+        fieldWidth = stringLength(field)
+        if !objectHas(widths, field) || fieldWidth > objectGet(widths, field):
+            objectSet(widths, field, fieldWidth)
+        endif
+    endfor
+
+    # Compute the formatted field value strings and widths
+    dataFormat = arrayNew()
+    for row in data:
+        rowFormat = objectNew()
+        arrayPush(dataFormat, rowFormat)
+        for field in fields:
+            # Format the value
+            value = objectGet(row, field)
+            valueType = systemType(value)
+            if valueType == 'string':
+                valueFormat = value
+            elif valueType == 'number':
+                valueFormat = numberToFixed(value, precisionNumber, precisionTrim)
+            elif valueType == 'datetime':
+                valueFormat = datetimeISOFormat(value, precisionDatetime != null)
+            else:
+                valueFormat = stringNew(value)
+            endif
+            objectSet(rowFormat, field, valueFormat)
+
+            # Update the field width
+            valueWidth = stringLength(valueFormat)
+            if !objectHas(widths, field) || valueWidth > objectGet(widths, field):
+                objectSet(widths, field, valueWidth)
+            endif
+        endfor
+    endfor
+
+    # Compute the field header separator
+    headerSeparator = ''
+    for field in fields:
+        width = objectGet(widths, field)
+        format = if(formats != null, objectGet(formats, field))
+        align = if(format != null, objectGet(format, 'align'))
+        alignLeft = if(align == 'center', ':', '-')
+        alignRight = if(align == 'center' || align == 'right', ':', '-')
+        headerSeparator = headerSeparator + '|' + alignLeft + dataTableMarkdownField('', width, align, '-') + alignRight
+    endfor
+    headerSeparator = headerSeparator + '|'
+
+    # Compute the table header fields
+    headerFields = ''
+    for field in fields:
+        width = objectGet(widths, field)
+        format = if(formats != null, objectGet(formats, field))
+        align = if(format != null, objectGet(format, 'align'))
+        header = if(format != null, objectGet(format, 'header', field), field)
+        headerFields = headerFields + '| ' + dataTableMarkdownField(header, width, align, ' ') + ' '
+    endfor
+    headerFields = headerFields + '|'
+
+    # Output the table header
+    lines = arrayNew()
+    arrayPush(lines, headerFields)
+    arrayPush(lines, headerSeparator)
+
+    # Output each row
+    for row in dataFormat:
+        line = ''
+        for field in fields:
+            width = objectGet(widths, field)
+            format = if(formats != null, objectGet(formats, field))
+            align = if(format != null, objectGet(format, 'align'))
+            line = line + '| ' + dataTableMarkdownField(objectGet(row, field), width, align, ' ') + ' '
+        endfor
+        line = line + '|'
+        arrayPush(lines, line)
+    endfor
+
+    return lines
+endfunction
+
+
+# Helper to generate the Markdown field text
+function dataTableMarkdownField(value, width, align, fill):
+    spaces = width - stringLength(value)
+    if align == 'right':
+        return stringRepeat(fill, spaces) + value
+    elif align == 'center':
+        spacesLeft = mathFloor(spaces / 2)
+        spacesRight = spaces - spacesLeft
+        return stringRepeat(fill, spacesLeft) + value + stringRepeat(fill, spacesRight)
+    endif
+    return value + stringRepeat(fill, spaces)
+endfunction

package/lib/include/diff.bare

@@ -99,7 +99,7 @@ function diffLines(left, right):
             ixRight = ixRight + 1
         endwhile
         if identicalLines:
-            arrayPush(objectdiffs, objectNew('type', 'Identical', 'lines', identicalLines))
+            arrayPush(diffs, objectNew('type', 'Identical', 'lines', identicalLines))
             continue
         endif
 

package/lib/include/markdownUp.bare

@@ -9,6 +9,9 @@ endif
 markdownUpSentinel = true
 
 
+include <dataTable.bare>
+
+
 # Constants
 markdownUpPixelsPerPoint = 4 / 3
 markdownUpDefaultFontSizePx = 12 * markdownUpPixelsPerPoint
@@ -43,124 +46,12 @@ endfunction
 
 
 function dataTable(data, model):
-    # Validate the data
-    data = dataValidate(data)
-    if data == null:
-        return
-    endif
-
-    # Determine the table fields
-    fields = arrayNew()
-    modelFields = if(model != null, objectGet(model, 'fields'))
-    modelCategories = if(model != null, objectGet(model, 'categories'))
-    if modelFields != null || modelCategories != null:
-        arrayExtend(fields, modelCategories)
-        arrayExtend(fields, modelFields)
-    elif arrayLength(data) > 0:
-        arrayExtend(fields, objectKeys(arrayGet(data, 0)))
-    endif
-    if !arrayLength(fields):
-        return
-    endif
-
-    # Get precision and formatting
-    precisionDatetime = if(model != null, objectGet(model, 'datetime'))
-    precisionNumber = if(model != null, objectGet(model, 'precision', 2), 2)
-    precisionTrim = if(model != null, objectGet(model, 'trim', true), true)
-    formats = if(model != null, objectGet(model, 'formats'))
-
-    # Compute the field header widths
-    widths = objectNew()
-    for field in fields:
-        fieldWidth = stringLength(field)
-        if !objectHas(widths, field) || fieldWidth > objectGet(widths, field):
-            objectSet(widths, field, fieldWidth)
-        endif
-    endfor
-
-    # Compute the formatted field value strings and widths
-    dataFormat = arrayNew()
-    for row in data:
-        rowFormat = objectNew()
-        arrayPush(dataFormat, rowFormat)
-        for field in fields:
-            # Format the value
-            value = objectGet(row, field)
-            valueType = systemType(value)
-            if valueType == 'string':
-                valueFormat = value
-            elif valueType == 'number':
-                valueFormat = numberToFixed(value, precisionNumber, precisionTrim)
-            elif valueType == 'datetime':
-                valueFormat = datetimeISOFormat(value, precisionDatetime != null)
-            else:
-                valueFormat = stringNew(value)
-            endif
-            objectSet(rowFormat, field, valueFormat)
-
-            # Update the field width
-            valueWidth = stringLength(valueFormat)
-            if !objectHas(widths, field) || valueWidth > objectGet(widths, field):
-                objectSet(widths, field, valueWidth)
-            endif
-        endfor
-    endfor
-
-    # Compute the field header separator
-    headerSeparator = ''
-    for field in fields:
-        width = objectGet(widths, field)
-        format = if(formats != null, objectGet(formats, field))
-        align = if(format != null, objectGet(format, 'align'))
-        headerSeparator = headerSeparator + '+=' + markdownUpValueField('', width, align, '=') + '='
-    endfor
-    headerSeparator = headerSeparator + '+'
-
-    # Compute the table header fields
-    headerFields = ''
-    for field in fields:
-        width = objectGet(widths, field)
-        format = if(formats != null, objectGet(formats, field))
-        align = if(format != null, objectGet(format, 'align'))
-        header = if(format != null, objectGet(format, 'header', field), field)
-        headerFields = headerFields + '| ' + markdownUpValueField(header, width, align, ' ') + ' '
-    endfor
-    headerFields = headerFields + '|'
-
-    # Output the table header
-    systemLog('')
-    systemLog(headerSeparator)
-    systemLog(headerFields)
-    systemLog(headerSeparator)
-
-    # Output each row
-    for row in dataFormat:
-        line = ''
-        for field in fields:
-            width = objectGet(widths, field)
-            format = if(formats != null, objectGet(formats, field))
-            align = if(format != null, objectGet(format, 'align'))
-            line = line + '| ' + markdownUpValueField(objectGet(row, field), width, align, ' ') + ' '
+    lines = dataTableMarkdown(data, model)
+    if lines:
+        for line in lines:
+            systemLog(line)
         endfor
-        line = line + '|'
-        systemLog(line)
-    endfor
-
-    # Output the table footer
-    systemLog(headerSeparator)
-endfunction
-
-
-function markdownUpValueField(value, width, align, fill):
-    spaces = width - stringLength(value)
-    if align == 'right':
-        return stringRepeat(fill, spaces) + value
-    elif align == 'center':
-        spacesLeft = mathFloor(spaces / 2)
-        spacesRight = spaces - spacesLeft
-        return stringRepeat(fill, spacesLeft) + value + stringRepeat(fill, spacesRight)
     endif
-    return value + stringRepeat(fill, spaces)
 endfunction
 
 
@@ -368,7 +259,7 @@ function markdownUp_markdownPrintHelper(lines):
     for line in lines:
         if systemType(line) == 'array':
             markdownUp_markdownPrintHelper(line)
-        else:
+        elif line != null:
             systemLog(line)
         endif
     endfor

package/lib/include/pager.bare

@@ -9,7 +9,7 @@ endif
 pagerSentinel = true
 
 
-include 'args.bare'
+include <args.bare>
 
 
 # The pager model
@@ -139,11 +139,11 @@ async function pagerMain(pagerModel, options):
         endif
     endfor
     if startPageName == null:
-        systemLogDebug('MarkdownUp - pager.bare: No visible and navigable pages')
+        systemLogDebug('pager.bare: No visible and navigable pages')
         return
     endif
     if optionStart && !startPageExplicit:
-        systemLogDebug('MarkdownUp - pager.bare: Unknown start page "' + optionStart + '"')
+        systemLogDebug('pager.bare: Unknown start page "' + optionStart + '"')
         return
     endif