bare-script 3.7.5 → 3.8.0

package/lib/bare.js

@@ -8,6 +8,7 @@ import {executeScriptAsync} from './runtimeAsync.js';
 import {fileURLToPath} from 'url';
 import {lintScript} from './model.js';
 import {readFile} from 'fs/promises';
+import {systemGlobalIncludesName} from './library.js';
 import {urlFileRelative} from './options.js';
 import {valueBoolean} from './value.js';
 
@@ -55,12 +56,20 @@ export async function main(options) {
 
         // Get the scripts to run
         let {scripts} = args;
+        let ixUserScript = 0;
         if (args.markdownUp) {
             scripts = [['code', 'include <markdownUp.bare>'], ...scripts];
+            ixUserScript = 1;
+
+            // Add unittest.bare argument globals
+            globals.vUnittestReport = true;
+            if (args.static) {
+                globals.vUnittestDisabled = true;
+            }
         }
 
         // Parse and execute all source files in order
-        for (const [scriptType, scriptValue] of scripts) {
+        for (const [ixScript, [scriptType, scriptValue]] of scripts.entries()) {
             // Get the script source
             let scriptName;
             let scriptSource;
@@ -80,16 +89,58 @@ export async function main(options) {
                 }
             } else {
                 inlineCount += 1;
-                scriptName = `<string${inlineCount > 1 ? inlineCount : ''}>`;
+                const inlineDisplay = inlineCount - ixUserScript;
+                scriptName = `<string${inlineDisplay > 1 ? inlineDisplay : ''}>`;
                 scriptSource = scriptValue;
             }
 
             // Parse the script source
             const script = parseScript(scriptSource, 1, scriptName);
 
+            // Execute?
+            let staticGlobals = null;
+            if (args.static !== 's') {
+                // Set the globals to use for static analysis (below)
+                if (!args.static || ixScript < ixUserScript) {
+                    staticGlobals = globals;
+                } else {
+                    // Copy global to keep each script as isolated as possible
+                    staticGlobals = {...globals};
+                    const globalIncludes = staticGlobals[systemGlobalIncludesName] ?? null;
+                    if (globalIncludes !== null && typeof globalIncludes === 'object') {
+                        staticGlobals[systemGlobalIncludesName] = {...globalIncludes};
+                    }
+                }
+
+                // 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': fetchIncludeFn,
+                    'globals': staticGlobals,
+                    'logFn': options.logFn,
+                    'systemPrefix': fetchIncludePrefix,
+                    'urlFn': scriptType === 'file' ? (url) => urlFileRelative(scriptName, url) : null
+
+                });
+                if (Number.isInteger(result) && result >= 0 && result <= 255) {
+                    statusCode = result || statusCode;
+                } else {
+                    statusCode = (valueBoolean(result) ? 1 : 0) || statusCode;
+                }
+
+                // Log script execution end with timing
+                if (args.debug && ixScript >= ixUserScript) {
+                    const timeEnd = performance.now();
+                    options.logFn(`BareScript executed in ${(timeEnd - timeBegin).toFixed(1)} milliseconds`);
+                }
+            }
+
             // Run the bare-script linter?
-            if (args.static || args.debug) {
-                const warnings = lintScript(script);
+            if (args.static && ixScript >= ixUserScript) {
+                const warnings = lintScript(script, staticGlobals);
                 if (warnings.length === 0) {
                     options.logFn(`BareScript static analysis "${scriptName}" ... OK`);
                 } else {
@@ -99,43 +150,12 @@ export async function main(options) {
                     for (const warning of warnings) {
                         options.logFn(warning);
                     }
-                    if (args.static) {
-                        statusCode = 1;
-                        break;
-                    }
+                    statusCode = 1;
                 }
             }
-            if (args.static) {
-                continue;
-            }
-
-            // 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': fetchIncludeFn,
-                'globals': globals,
-                'logFn': options.logFn,
-                'systemPrefix': fetchIncludePrefix,
-                'urlFn': scriptType === 'file' ? (url) => urlFileRelative(scriptName, url) : null
-
-            });
-            if (Number.isInteger(result) && result >= 0 && result <= 255) {
-                statusCode = result;
-            } else {
-                statusCode = valueBoolean(result) ? 1 : 0;
-            }
-
-            // Log script execution end with timing
-            if (args.debug) {
-                const timeEnd = performance.now();
-                options.logFn(`BareScript executed in ${(timeEnd - timeBegin).toFixed(1)} milliseconds`);
-            }
 
             // Stop on error status code
-            if (statusCode !== 0) {
+            if (statusCode !== 0 && !args.static) {
                 break;
             }
         }
@@ -202,7 +222,9 @@ export function parseArgs(argv) {
         } else if (arg === '-m' || arg === '--markdown-up') {
             args.markdownUp = true;
         } else if (arg === '-s' || arg === '--static') {
-            args.static = true;
+            args.static = 's';
+        } else if (arg === '-x' || arg === '--staticx') {
+            args.static = 'x';
         } else if (arg === '-v' || arg === '--var') {
             if (iArg + 2 >= argv.length) {
                 throw new Error('argument -v/--var: expected 2 arguments');
@@ -222,7 +244,7 @@ export function parseArgs(argv) {
 
 // The command-line interface (CLI) help text
 export const helpText = `\
-usage: bare [-h] [-c CODE] [-d] [-m] [-s] [-v VAR EXPR] [file ...]
+usage: bare [-h] [-c CODE] [-d] [-m] [-s] [-x] [-v VAR EXPR] [file ...]
 
 The BareScript command-line interface
 
@@ -235,4 +257,5 @@ options:
   -d, --debug         enable debug mode
   -m, --markdown-up   run with MarkdownUp stubs
   -s, --static        perform static analysis
+  -x, --staticx       perform static analysis with execution
   -v, --var VAR EXPR  set a global variable to an expression value`;

package/lib/include/args.bare

@@ -2,13 +2,6 @@
 # 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.bare"', \

package/lib/include/dataTable.bare

@@ -2,13 +2,6 @@
 # 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"', \

package/lib/include/diff.bare

@@ -2,13 +2,6 @@
 # https://github.com/craigahobbs/markdown-up/blob/main/LICENSE
 
 
-# Include sentinel
-if systemGlobalGet('diffSentinel'):
-    return
-endif
-diffSentinel = true
-
-
 # The text line difference model
 diffTypes = schemaParse( \
     'group "diff.bare"', \
@@ -104,7 +97,7 @@ function diffLines(left, right):
         endif
 
         # Look ahead to find next matching point
-        foundMatch = False
+        foundMatch = false
         ixLeftTmp = ixLeft
         while ixLeftTmp < leftLength:
             ixRightTmp = ixRight
@@ -152,4 +145,4 @@ endfunction
 
 
 # Regex for splitting lines
-diffRegexLineSplit = regexNew(stringFromCharCode(13) + '?' + stringFromCharCode(10))
+diffRegexLineSplit = regexNew('\r?\n')

package/lib/include/forms.bare

@@ -2,13 +2,6 @@
 # https://github.com/craigahobbs/markdown-up/blob/main/LICENSE
 
 
-# Include sentinel
-if systemGlobalGet('formsSentinel'):
-    return
-endif
-formsSentinel = true
-
-
 # $function: formsTextElements
 # $group: forms.bare
 # $doc: Create a text input [element model](https://github.com/craigahobbs/element-model#readme)

package/lib/include/markdownUp.bare

@@ -1,14 +1,6 @@
 # Licensed under the MIT License
 # https://github.com/craigahobbs/markdown-up/blob/main/LICENSE
 
-
-# Include sentinel
-if systemGlobalGet('markdownUpSentinel'):
-    return
-endif
-markdownUpSentinel = true
-
-
 include <dataTable.bare>
 
 

package/lib/include/pager.bare

@@ -2,13 +2,6 @@
 # https://github.com/craigahobbs/markdown-up/blob/main/LICENSE
 
 
-# Include sentinel
-if systemGlobalGet('pagerSentinel'):
-    return
-endif
-pagerSentinel = true
-
-
 include <args.bare>
 
 

package/lib/include/unittest.bare

@@ -2,69 +2,60 @@
 # https://github.com/craigahobbs/markdown-up/blob/main/LICENSE
 
 
-# Include sentinel
-if systemGlobalGet('unittestSentinel'):
-    return
-endif
-unittestSentinel = true
-
-
 include <args.bare>
 include <dataTable.bare>
 include <diff.bare>
 
 
-# Test statistics
-unittestTests = {}
-unittestWarnings = []
-
-
 # $function: unittestRunTest
 # $group: unittest.bare
 # $doc: Run a unit test
 # $arg testName: The test function name
 async function unittestRunTest(testName):
-    testFn = unittestRunTestHelper(testName)
-    if testFn:
-        testFn()
-        systemGlobalSet('unittestTestName', null)
+    # Tests disabled?
+    if systemGlobalGet('vUnittestDisabled'):
+        return
     endif
-endfunction
 
-
-# For backward compatibility
-async function unittestRunTestAsync(testName):
-    systemLogDebug('unittest.bare: unittestRunTestAsync is deprecated - use unittestRunTest')
-    return unittestRunTest(testName)
-endfunction
-
-
-# unittestRunTest helper function
-function unittestRunTestHelper(testName):
     # Single test argument?
+    vUnittestTest = systemGlobalGet('vUnittestTest')
     if vUnittestTest && vUnittestTest != testName:
-        return null
+        return
     endif
 
+    # Get the global unittest data
+    unittestData = unittestDataGet()
+    unittestTests = objectGet(unittestData, 'tests')
+    unittestWarnings = objectGet(unittestData, 'warnings')
+
     # Test run multiple times?
     if objectHas(unittestTests, testName):
         arrayPush(unittestWarnings, 'Test "' + testName + '" run multiple times')
-        return null
+        return
     endif
 
     # Get the test func
     testFn = systemGlobalGet(testName)
     if !testFn:
         arrayPush(unittestWarnings, 'Test "' + testName + '" not found')
-        return null
+        return
     endif
 
     # Add the unit test result array
     testFailures = []
     objectSet(unittestTests, testName, testFailures)
-    systemGlobalSet('unittestTestName', testName)
 
-    return testFn
+    # Run the test
+    objectSet(unittestData, 'current', testName)
+    testFn()
+    objectSet(unittestData, 'current', null)
+endfunction
+
+
+# For backward compatibility
+async function unittestRunTestAsync(testName):
+    systemLogDebug('unittest.bare: unittestRunTestAsync is deprecated - use unittestRunTest')
+    return unittestRunTest(testName)
 endfunction
 
 
@@ -79,8 +70,13 @@ function unittestEqual(actual, expected, description):
         return
     endif
 
+    # Get the global unittest data
+    unittestData = unittestDataGet()
+    unittestTests = objectGet(unittestData, 'tests')
+    unittestCurrent = objectGet(unittestData, 'current')
+    testFailures = objectGet(unittestTests, unittestCurrent)
+
     # Add the test failure error lines
-    testFailures = objectGet(unittestTests, unittestTestName)
     errorLines = [ \
         'Equal:', \
         '', \
@@ -143,8 +139,13 @@ function unittestDeepEqual(actual, expected, description):
         arrayPush(errorLines, '```')
     endif
 
+    # Get the global unittest data
+    unittestData = unittestDataGet()
+    unittestTests = objectGet(unittestData, 'tests')
+    unittestCurrent = objectGet(unittestData, 'current')
+    testFailures = objectGet(unittestTests, unittestCurrent)
+
     # Add the test failure error lines
-    testFailures = objectGet(unittestTests, unittestTestName)
     if description:
         arrayPush(testFailures, arrayExtend([markdownEscape(description), ''], errorLines))
     else:
@@ -153,6 +154,17 @@ function unittestDeepEqual(actual, expected, description):
 endfunction
 
 
+# Helper to get the global unittest data object
+function unittestDataGet():
+    unittestData = systemGlobalGet('unittestData')
+    if unittestData == null:
+        unittestData = {'tests': {}, 'warnings': [], 'current': null}
+        systemGlobalSet('unittestData', unittestData)
+    endif
+    return unittestData
+endfunction
+
+
 # $function: unittestReport
 # $group: unittest.bare
 # $doc: Render the unit test report
@@ -171,10 +183,16 @@ function unittestReport(options):
 
     # Parse arguments
     args = argsParse(unittestReportArguments)
-    testNameArg = objectGet(args, 'test')
-    scriptName = objectGet(args, 'script')
+    isDisabled = objectGet(args, 'disabled')
     hideTests = objectGet(args, 'hideTests')
     isReport = objectGet(args, 'report')
+    scriptName = objectGet(args, 'script')
+    testNameArg = objectGet(args, 'test')
+
+    # Disabled?
+    if isDisabled:
+        return 0
+    endif
 
     # Script coverage details page?
     if scriptName:
@@ -182,6 +200,11 @@ function unittestReport(options):
         return 0
     endif
 
+    # Get the global unittest data
+    unittestData = unittestDataGet()
+    unittestTests = objectGet(unittestData, 'tests')
+    unittestWarnings = objectGet(unittestData, 'warnings')
+
     # Compute test statistics
     testNames = arraySort(objectKeys(unittestTests))
     testCount = arrayLength(testNames)
@@ -318,10 +341,11 @@ endfunction
 
 # unittestReport application arguments
 unittestReportArguments = argsValidate([ \
-    {'name': 'test', 'global': 'vUnittestTest'}, \
-    {'name': 'script', 'global': 'vUnittestScript'}, \
+    {'name': 'disabled', 'global': 'vUnittestDisabled', 'type': 'bool', 'default': false}, \
     {'name': 'hideTests', 'global': 'vUnittestHideTests', 'type': 'bool', 'default': false}, \
-    {'name': 'report', 'global': 'vUnittestReport', 'type': 'bool', 'default': false} \
+    {'name': 'report', 'global': 'vUnittestReport', 'type': 'bool', 'default': false}, \
+    {'name': 'script', 'global': 'vUnittestScript'}, \
+    {'name': 'test', 'global': 'vUnittestTest'} \
 ])
 
 
@@ -393,7 +417,7 @@ endfunction
 
 function unittestReportScriptLines(codeLineElements, lines, color, noNewline):
     if lines:
-        linesStr = arrayJoin(lines, stringFromCharCode(10)) + if(noNewline, '', stringFromCharCode(10))
+        linesStr = arrayJoin(lines, '\n') + if(noNewline, '', '\n')
         if !color:
             arrayPush(codeLineElements, {'text': linesStr})
         else:

package/lib/include/unittestMock.bare

@@ -2,13 +2,6 @@
 # https://github.com/craigahobbs/markdown-up/blob/main/LICENSE
 
 
-# Include sentinel
-if systemGlobalGet('unittestMockSentinel'):
-    return
-endif
-unittestMockSentinel = true
-
-
 # Constants
 unittestMockPixelsPerPoint = 4 / 3
 unittestMockDefaultFontSizePx = 12 * unittestMockPixelsPerPoint

package/lib/library.js

@@ -1987,6 +1987,29 @@ struct SystemFetchRequest
 `);
 
 
+// System includes object global variable name
+export const systemGlobalIncludesName = '__bareScriptIncludes';
+
+
+// $function: systemGlobalIncludesGet
+// $group: System
+// $doc: Get the global system includes object
+// $return: The global system includes object
+function systemGlobalIncludesGet(unusedArgs, options) {
+    const globals = (options !== null ? (options.globals ?? null) : null);
+    return (globals !== null ? (globals[systemGlobalIncludesName] ?? null) : null);
+}
+
+
+// $function: systemGlobalIncludesName
+// $group: System
+// $doc: Get the system includes object global variable name
+// $return: The system includes object global variable name
+function systemGlobalIncludesNameFn() {
+    return systemGlobalIncludesName;
+}
+
+
 // $function: systemGlobalGet
 // $group: System
 // $doc: Get a global variable value
@@ -2248,6 +2271,8 @@ export const scriptFunctions = {
     systemCompare,
     systemFetch,
     systemGlobalGet,
+    systemGlobalIncludesGet,
+    'systemGlobalIncludesName': systemGlobalIncludesNameFn,
     systemGlobalSet,
     systemIs,
     systemLog,

package/lib/model.js

@@ -320,9 +320,10 @@ export function validateExpression(expr) {
  * Lint a BareScript script model
  *
  * @param {Object} script - The [BareScript model](./model/#var.vName='BareScript')
+ * @param {?Object} globals - The script global variables
  * @returns {string[]} The array of lint warnings
  */
-export function lintScript(script) {
+export function lintScript(script, globals = null) {
     const warnings = [];
     const {statements} = script;
 
@@ -341,6 +342,15 @@ export function lintScript(script) {
         }
     }
 
+    // Unknown global variable?
+    if (globals !== null) {
+        for (const varName of Object.keys(varUses).sort()) {
+            if (!(varName in varAssigns) && !(varName in globals) && !builtinGlobals.has(varName)) {
+                lintScriptWarning(warnings, script, statements[varUses[varName]], `Unknown global variable "${varName}"`);
+            }
+        }
+    }
+
     // Iterate global statements
     const functionsDefined = {};
     const labelsDefined = {};
@@ -361,7 +371,8 @@ export function lintScript(script) {
             const fnVarAssigns = {};
             const fnVarUses = {};
             const args = (statement.function.args ?? null);
-            getVariableAssignmentsAndUses(statement.function.statements, fnVarAssigns, fnVarUses);
+            const fnStatements = statement.function.statements;
+            getVariableAssignmentsAndUses(fnStatements, fnVarAssigns, fnVarUses);
             for (const varName of Object.keys(fnVarAssigns)) {
                 // Ignore re-assigned function arguments
                 if (args !== null && args.indexOf(varName) !== -1) {
@@ -369,7 +380,7 @@ export function lintScript(script) {
                 }
                 if (varName in fnVarUses && fnVarUses[varName] <= fnVarAssigns[varName]) {
                     lintScriptWarning(
-                        warnings, script, statement,
+                        warnings, script, fnStatements[fnVarUses[varName]],
                         `Variable "${varName}" of function "${statement.function.name}" used before assignment`
                     );
                 }
@@ -379,12 +390,24 @@ export function lintScript(script) {
             for (const varName of Object.keys(fnVarAssigns)) {
                 if (!(varName in fnVarUses)) {
                     lintScriptWarning(
-                        warnings, script, statement,
+                        warnings, script, fnStatements[fnVarAssigns[varName]],
                         `Unused variable "${varName}" defined in function "${statement.function.name}"`
                     );
                 }
             }
 
+            // Unknown global variable?
+            if (globals !== null) {
+                for (const varName of Object.keys(fnVarUses).sort()) {
+                    if (!(varName in fnVarAssigns) && (args === null || args.indexOf(varName) === -1) &&
+                        !(varName in globals) && !builtinGlobals.has(varName)) {
+                        lintScriptWarning(
+                            warnings, script, fnStatements[fnVarUses[varName]], `Unknown global variable "${varName}"`
+                        );
+                    }
+                }
+            }
+
             // Function argument checks
             if (args !== null) {
                 const argsDefined = new Set();
@@ -410,7 +433,7 @@ export function lintScript(script) {
             // Iterate function statements
             const fnLabelsDefined = {};
             const fnLabelsUsed = {};
-            for (const [ixFnStatement, fnStatement] of statement.function.statements.entries()) {
+            for (const [ixFnStatement, fnStatement] of fnStatements.entries()) {
                 const [fnStatementKey] = Object.keys(fnStatement);
 
                 // Function expression statement checks
@@ -498,6 +521,10 @@ export function lintScript(script) {
 }
 
 
+// Builtin global variable names
+const builtinGlobals = new Set(['false', 'if', 'null', 'true']);
+
+
 // Helper to format static analysis warnings
 function lintScriptWarning(warnings, script, statement, message) {
     const scriptName = script.scriptName ?? '';

package/lib/runtimeAsync.js

@@ -5,7 +5,7 @@
 
 import {BareScriptRuntimeError, evaluateExpression, recordStatementCoverage, scriptFunction} from './runtime.js';
 import {ValueArgsError, valueBoolean, valueCompare, valueString} from './value.js';
-import {coverageGlobalName, defaultMaxStatements, expressionFunctions, scriptFunctions} from './library.js';
+import {coverageGlobalName, defaultMaxStatements, expressionFunctions, scriptFunctions, systemGlobalIncludesName} from './library.js';
 import {lintScript} from './model.js';
 import {parseScript} from './parser.js';
 import {urlFileRelative} from './options.js';
@@ -123,9 +123,9 @@ async function executeScriptHelperAsync(script, statements, options, locals) {
 
         // Include?
         } else if (statementKey === 'include') {
-            // Fetch the include script text
+            // Compute the include script URLs
             const urlFn = options.urlFn ?? null;
-            const includeURLs = statement.include.includes.map(({url, system = false}) => {
+            const unfilteredIncludeURLs = statement.include.includes.map(({url, system = false}) => {
                 let includeURL;
                 if (system && 'systemPrefix' in options) {
                     includeURL = urlFileRelative(options.systemPrefix, url);
@@ -134,6 +134,21 @@ async function executeScriptHelperAsync(script, statements, options, locals) {
                 }
                 return {includeURL, 'systemInclude': system};
             });
+
+            // Filter already included
+            let globalIncludes = globals[systemGlobalIncludesName] ?? null;
+            if (globalIncludes === null || typeof globalIncludes !== 'object') {
+                globalIncludes = {};
+                globals[systemGlobalIncludesName] = globalIncludes;
+            }
+            const includeURLs = unfilteredIncludeURLs.filter(({includeURL}) => {
+                if (globalIncludes[includeURL]) {
+                    return false;
+                }
+                return true;
+            });
+
+            // Fetch the include script text
             const responses = await Promise.all(includeURLs.map(async ({includeURL, systemInclude}) => {
                 try {
                     const response = ('fetchFn' in options ? await options.fetchFn(includeURL) : null);
@@ -160,6 +175,12 @@ async function executeScriptHelperAsync(script, statements, options, locals) {
                     throw new BareScriptRuntimeError(script, statement, `Include of "${includeURL}" failed`);
                 }
 
+                // Mark as included. Check again if the URL is included.
+                if (globalIncludes[includeURL]) {
+                    continue;
+                }
+                globalIncludes[includeURL] = true;
+
                 // Parse the include script
                 const includeScript = parseScript(includeText, 1, includeURL);
                 if (systemInclude) {

package/package.json

@@ -1,7 +1,7 @@
 {
     "type": "module",
     "name": "bare-script",
-    "version": "3.7.5",
+    "version": "3.8.0",
     "description": "BareScript; a lightweight scripting and expression language",
     "keywords": [
         "expression",