bare-script 2.2.13 → 2.2.14

package/lib/bareDoc.js

@@ -121,34 +121,46 @@ export function parseBareDoc(files) {
                     func = {'name': textTrim};
                     funcs[textTrim] = func;
                 }
-            } else {
-                // arg keyword?
-                const matchArg = line.match(rArg);
-                if (matchArg !== null) {
-                    const {name, text} = matchArg.groups;
-                    const textTrim = text.trim();
-
-                    // Keyword used outside of function?
-                    if (func === null) {
-                        errors.push(`${file}:${ixLine + 1}: Function argument "${name}" outside function`);
-                        continue;
-                    }
 
-                    // Add the function arg documentation line - don't add leading blank lines
-                    let args = func.args ?? null;
-                    let arg = (args !== null ? args.find((argFind) => argFind.name === name) : null) ?? null;
-                    if (arg !== null || textTrim !== '') {
-                        if (args === null) {
-                            args = [];
-                            func.args = args;
-                        }
-                        if (arg === null) {
-                            arg = {'name': name, 'doc': []};
-                            args.push(arg);
-                        }
-                        arg.doc.push(text);
+                continue;
+            }
+
+            // arg keyword?
+            const matchArg = line.match(rArg);
+            if (matchArg !== null) {
+                const {name, text} = matchArg.groups;
+                const textTrim = text.trim();
+
+                // Keyword used outside of function?
+                if (func === null) {
+                    errors.push(`${file}:${ixLine + 1}: Function argument "${name}" outside function`);
+                    continue;
+                }
+
+                // Add the function arg documentation line - don't add leading blank lines
+                let args = func.args ?? null;
+                let arg = (args !== null ? args.find((argFind) => argFind.name === name) : null) ?? null;
+                if (arg !== null || textTrim !== '') {
+                    if (args === null) {
+                        args = [];
+                        func.args = args;
                     }
+                    if (arg === null) {
+                        arg = {'name': name, 'doc': []};
+                        args.push(arg);
+                    }
+                    arg.doc.push(text);
                 }
+
+                continue;
+            }
+
+            // Unknown documentation comment?
+            const matchUnknown = line.match(rUnknown);
+            if (matchUnknown !== null) {
+                const {unknown} = matchUnknown.groups;
+                errors.push(`${file}:${ixLine + 1}: Invalid documentation comment "${unknown}"`);
+                continue;
             }
         }
     }
@@ -185,5 +197,6 @@ export function parseBareDoc(files) {
 
 // Library documentation regular expressions
 const rKey = /^\s*(?:\/\/|#)\s*\$(?<key>function|group|doc|return):\s?(?<text>.*)$/;
-const rArg = /^\s*(?:\/\/|#)\s*\$arg\s+(?<name>[A-Za-z_][A-Za-z0-9_]*):\s?(?<text>.*)$/;
+const rArg = /^\s*(?:\/\/|#)\s*\$arg\s+(?<name>[A-Za-z_][A-Za-z0-9_]*(?:\.\.\.)?):\s?(?<text>.*)$/;
+const rUnknown = /^\s*(?:\/\/|#)\s*\$(?<unknown>[^:]+):/;
 const rSplit = /\r?\n/;

package/lib/library.js

@@ -89,9 +89,9 @@ export const scriptFunctions = {
     // $function: arrayNew
     // $group: Array
     // $doc: Create a new array
-    // $arg args: The new array's values
+    // $arg values...: The new array's values
     // $return: The new array
-    'arrayNew': (args) => args,
+    'arrayNew': (values) => values,
 
     // $function: arrayNewSize
     // $group: Array
@@ -112,7 +112,7 @@ export const scriptFunctions = {
     // $group: Array
     // $doc: Add one or more values to the end of the array
     // $arg array: The array
-    // $arg values: The values to add to the end of the array
+    // $arg values...: The values to add to the end of the array
     // $return: The array
     'arrayPush': ([array, ...values]) => {
         if (Array.isArray(array)) {
@@ -213,7 +213,7 @@ export const scriptFunctions = {
     // $function: dataParseCSV
     // $group: Data
     // $doc: Parse CSV text to a data array
-    // $arg text: The CSV text
+    // $arg text...: The CSV text
     // $return: The data array
     'dataParseCSV': (text) => {
         const data = parseCSV(text);
@@ -481,15 +481,15 @@ export const scriptFunctions = {
 
     // $function: mathMax
     // $group: Math
-    // $doc: Compute the maximum value of all arguments
-    // $arg values: All arguments
+    // $doc: Compute the maximum value
+    // $arg values...: The values
     // $return: The maximum value
     'mathMax': (values) => Math.max(...values),
 
     // $function: mathMin
     // $group: Math
-    // $doc: Compute the minimum value of all arguments
-    // $arg values: All arguments
+    // $doc: Compute the minimum value
+    // $arg values...: The values
     // $return: The minimum value
     'mathMin': (values) => Math.min(...values),
 
@@ -648,7 +648,7 @@ export const scriptFunctions = {
     // $function: objectNew
     // $group: Object
     // $doc: Create a new object
-    // $arg keyValues: The object's initial key and value arguments
+    // $arg keyValues...: The object's initial key and value pairs
     // $return: The new object
     'objectNew': (keyValues) => {
         const object = {};
@@ -729,8 +729,8 @@ export const scriptFunctions = {
     // $function: schemaParse
     // $group: Schema
     // $doc: Parse the [Schema Markdown](https://craigahobbs.github.io/schema-markdown-js/language/) text
-    // $arg lines: The [Schema Markdown](https://craigahobbs.github.io/schema-markdown-js/language/)
-    // $arg lines: text lines (may contain nested arrays of un-split lines)
+    // $arg lines...: The [Schema Markdown](https://craigahobbs.github.io/schema-markdown-js/language/)
+    // $arg lines...: text lines (may contain nested arrays of un-split lines)
     // $return: The schema's [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
     'schemaParse': (lines) => parseSchemaMarkdown(lines),
 
@@ -789,9 +789,9 @@ export const scriptFunctions = {
 
     // $function: stringFromCharCode
     // $group: String
-    // $doc: Create a string from the character code arguments
-    // $arg charCodes: The character codes
-    // $return: The new string
+    // $doc: Create a string of characters from character codes
+    // $arg charCodes...: The character codes
+    // $return: The string of characters
     'stringFromCharCode': (charCodes) => String.fromCharCode(...charCodes),
 
     // $function: stringIndexOf
@@ -991,7 +991,7 @@ export const scriptFunctions = {
     // $doc: Return a new function which behaves like "func" called with "args".
     // $doc: If additional arguments are passed to the returned function, they are appended to "args".
     // $arg func: The function
-    // $arg args: The function arguments
+    // $arg args...: The function arguments
     // $return: The new function called with "args"
     'systemPartial': ([func, ...args]) => (argsExtra, options) => func([...args, ...argsExtra], options),
 

package/package.json

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