bare-script 2.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Craig A. Hobbs
+
+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/README.md

@@ -0,0 +1,132 @@
+# bare-script
+
+[![npm](https://img.shields.io/npm/v/bare-script)](https://www.npmjs.com/package/bare-script)
+[![GitHub](https://img.shields.io/github/license/craigahobbs/bare-script)](https://github.com/craigahobbs/bare-script/blob/main/LICENSE)
+
+The bare-script package is the JavaScript implementation of the
+[BareScript language](https://craigahobbs.github.io/bare-script/language/).
+
+
+## Links
+
+- [The BareScript Language](https://craigahobbs.github.io/bare-script/language/)
+- [The BareScript Library](https://craigahobbs.github.io/bare-script/library/)
+- [The BareScript Expression Library](https://craigahobbs.github.io/bare-script/library/expression.html)
+- [API Documentation](https://craigahobbs.github.io/bare-script/)
+- [Source code](https://github.com/craigahobbs/bare-script)
+
+
+## Executing BareScript Scripts
+
+To execute a BareScript script, parse the script using the
+[parseScript](https://craigahobbs.github.io/bare-script/module-lib_parser.html#.parseScript)
+function. Then execute the script using the
+[executeScript](https://craigahobbs.github.io/bare-script/module-lib_runtime.html#.executeScript)
+function or the
+[executeScriptAsync](https://craigahobbs.github.io/bare-script/module-lib_runtimeAsync.html#.executeScriptAsync)
+function. For example:
+
+~~~ javascript
+import {executeScript} from 'bare-script/lib/runtime.js';
+import {parseScript} from 'bare-script/lib/parser.js';
+
+// Parse the script
+const script = parseScript(`\
+# Double a number
+function double(n)
+    return n * 2
+endfunction
+
+return N + ' times 2 is ' + double(N)
+`);
+
+// Execute the script
+const globals = {'N': 10};
+console.log(executeScript(script, {'globals': globals}));
+~~~
+
+This outputs:
+
+~~~
+10 times 2 is 20
+~~~
+
+
+### The BareScript Library
+
+[The BareScript Library](https://craigahobbs.github.io/bare-script/library/) includes a set of
+built-in functions for mathematical operations, object manipulation, array manipulation, regular
+expressions, HTTP fetch and more. The following example demonstrates the use of the
+[httpFetch](https://craigahobbs.github.io/bare-script/library/#var.vName='httpFetch'),
+[objectGet](https://craigahobbs.github.io/bare-script/library/#var.vName='objectGet'), and
+[arrayLength](https://craigahobbs.github.io/bare-script/library/#var.vName='arrayLength') functions.
+
+~~~ javascript
+import {executeScriptAsync} from 'bare-script/lib/runtimeAsync.js';
+import {parseScript} from 'bare-script/lib/parser.js';
+
+// Parse the script
+const script = parseScript(`\
+# Fetch the BareScript library documentation JSON
+libraryDocs = httpFetch('https://craigahobbs.github.io/bare-script/library/library.json')
+
+# Return the number of library functions
+return 'The BareScript Library has ' + arrayLength(objectGet(libraryDocs, 'functions')) + ' functions'
+`);
+
+// Execute the script
+console.log(await executeScriptAsync(script, {'fetchFn': fetch}));
+~~~
+
+This outputs:
+
+~~~
+The BareScript Library has 86 functions
+~~~
+
+
+## Evaluating BareScript Expressions
+
+To evaluate a
+[BareScript expression](https://craigahobbs.github.io/bare-script/language/#expressions),
+parse the expression using the
+[parseExpression](https://craigahobbs.github.io/bare-script/module-lib_parser.html#.parseExpression)
+function. Then evaluate the expression using the
+[evaluateExpression](https://craigahobbs.github.io/bare-script/module-lib_runtime.html#.evaluateExpression)
+function or the
+[evaluateExpressionAsync](https://craigahobbs.github.io/bare-script/module-lib_runtimeAsync.html#.evaluateExpressionAsync)
+function.
+
+Expression evaluation includes the
+[BareScript Expression Library](https://craigahobbs.github.io/bare-script/library/expression.html),
+a set of built-in, spreadsheet-like functions.
+
+For example:
+
+~~~ javascript
+import {evaluateExpression} from 'bare-script/lib/runtime.js';
+import {parseExpression} from 'bare-script/lib/parser.js';
+
+// Parse the expression
+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
+~~~
+
+
+## Development
+
+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/bin/bareScriptDoc.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+// Licensed under the MIT License
+// https://github.com/craigahobbs/bare-script/blob/main/LICENSE
+
+import {argv, exit, stderr, stdout} from 'node:process';
+import {parseLibraryDoc} from '../lib/libraryDoc.js';
+import {readFileSync} from 'node:fs';
+
+try {
+    stdout.write(JSON.stringify(parseLibraryDoc(argv.slice(2).map((file) => [file, readFileSync(file, 'utf-8')])), null, 4));
+} catch (error) {
+    stderr.write(error.message);
+    stderr.write('\n');
+    exit(1);
+}