@ptolemy2002/rgx 7.3.0 → 7.4.0

package/README.md

@@ -1113,7 +1113,9 @@ function rgx(flags?: string, multiline?: boolean): (strings: TemplateStringsArra
 
 Creates and returns a template tag function that constructs an `ExtRegExp` object from the provided template literal with the provided flags. The template literal can contain RGX tokens, which will be resolved and concatenated with the literal parts to form the final regex pattern. Before constructing the pattern, any convertible token that defines `rgxAcceptInsertion` is checked; if it returns `false` or a string, an `RGXInsertionRejectedError` is thrown with details about the reason and exactly where the rejection occurred.
 
-When `multiline` is `true` (the default), the literal string parts of the template are processed to strip newlines, trim leading whitespace from each line, and remove empty lines, then joined together. This allows you to write regex patterns across multiple lines in the source code for readability without the newlines and indentation becoming part of the pattern. Only the literal string parts between tokens are affected — interpolated values (tokens) are preserved as-is, including string tokens passed via `${"..."}`. When `multiline` is `false`, all literal string parts are preserved exactly as written, including newlines and whitespace.
+When `multiline` is `true` (the default), the literal string parts of the template are processed to strip newlines, trim leading whitespace from each line, and remove empty lines, then joined together. This allows you to write regex patterns across multiple lines in the source code for readability without the newlines and indentation becoming part of the pattern. Only the literal string parts between tokens are affected — interpolated values (tokens) are preserved as-is, including string tokens passed via `${"..."}`. Also, comments (denoted with `//`) ending a line or on a line by themselves are stripped. If a command ends a line, that line is also stripped of whitespace on the right side.
+
+When `multiline` is `false`, all literal string parts are preserved exactly as written, including newlines and whitespace.
 
 The provided `flags` are passed as `currentFlags` to the resolver, enabling inline modifier groups for any `RegExp` literal tokens whose localizable flags (`i`, `m`, `s`) differ from the parent flags. For example, embedding `/foo/i` in a no-flag context produces `(?i:foo)`, while embedding `/bar/` in an `i`-flag context produces `(?-i:bar)`.
 
@@ -1150,7 +1152,7 @@ const pattern6 = rgx()`
 #### Parameters
 **Direct**
   - `flags` (`string`, optional): The regex flags to apply to the resulting `ExtRegExp` object (e.g., 'g', 'i', 'm', or custom registered flags). If not provided, no flags will be applied. If provided and not valid regex flags (vanilla or registered custom), an `RGXInvalidRegexFlagsError` will be thrown.
-  - `multiline` (`boolean`, optional): Whether to strip newlines and trim leading whitespace from the literal string parts of the template. Defaults to `true`. When `true`, each literal string part is split by newlines, each line has its leading whitespace trimmed, empty lines are removed, and the remaining lines are joined together. Interpolated tokens (including string tokens via `${"..."}`) are not affected. When `false`, literal string parts are preserved exactly as written.
+  - `multiline` (`boolean`, optional): Whether to strip newlines and trim leading whitespace from the literal string parts of the template. Defaults to `true`. When `true`, each literal string part is split by newlines, each line has its leading whitespace trimmed, empty lines are removed, comments (denoted with `//`) ending a line or on a line by themselves are stripped, and the remaining lines are joined together. Interpolated tokens (including string tokens via `${"..."}`) are not affected. When `false`, literal string parts are preserved exactly as written.
 
 **Template Tag**
   - `strings` (`TemplateStringsArray`): The literal parts of the template string.
@@ -1182,7 +1184,7 @@ A helper function that creates an `RGXWalker` instance from an interpolation of
 #### Parameters
   - `source` (`string`): An arbitrary string value that will be included in the `source` property of the walker object.
   - `options` (`RGXWOptions<R>`, optional): Additional options for configuring the behavior of the resulting `RGXWalker`. This includes:
-    - `multiline` (`boolean`, optional): Whether to strip newlines and trim leading whitespace from the literal string parts of the template. Defaults to `true`. When `true`, each literal string part is split by newlines, each line has its leading whitespace trimmed, empty lines are removed, and the remaining lines are joined together. Interpolated tokens (including string tokens via `${"..."}`) are not affected. When `false`, literal string parts are preserved exactly as written.
+    - `multiline` (`boolean`, optional): Whether to strip newlines and trim leading whitespace from the literal string parts of the template. Defaults to `true`. When `true`, each literal string part is split by newlines, each line has its leading whitespace trimmed, empty lines are removed, comments (denoted with `//`) ending a line or on a line by themselves are stripped, and the remaining lines are joined together. Interpolated tokens (including string tokens via `${"..."}`) are not affected. When `false`, literal string parts are preserved exactly as written.
     - `reduced` (`R`, optional): An optional initial value for the walker's `reduced` property, which can be used to accumulate results across matches.
 
 #### Returns
@@ -1643,7 +1645,9 @@ Since these are defined as native tokens (strings), they are automatically wrapp
 | --- | --- | --- |
 | `"any"` | `.` | Matches any single character (except newline by default) |
 | `"start"` | `^` | Start of string anchor |
+| `"line-start"` | `^` (with `m` flag) | Start of line anchor |
 | `"end"` | `$` | End of string anchor |
+| `"line-end"` | `$` (with `m` flag) | End of line anchor |
 | `"word-bound"` | `\b` | Word boundary |
 | `"non-word-bound"` | `\B` | Non-word boundary |
 | `"word-bound-start"` | `(?<=\W)(?=\w)` | Start of a word |

package/dist/internal/taggedTemplateToArray.js

@@ -15,8 +15,22 @@ function taggedTemplateToArray(strings, tokens, multiline) {
                 array.push(string);
             }
             else {
-                // Remove all empty lines and trim whitespace from the start of each line.
-                let lines = string.split("\n").map(line => line.trimStart()).filter(line => line.length > 0).join("");
+                // Remove all empty lines, remove comments, and trim whitespace from the start of each line.
+                let lines = string
+                    .split("\n")
+                    .map(line => line.trimStart())
+                    // Remove comments both for the start of the line.
+                    .filter(line => !line.startsWith("//"))
+                    .filter(line => line.length > 0)
+                    // Remove comments at the end of the line.
+                    .map(line => {
+                    const commentIndex = line.indexOf("//");
+                    if (commentIndex !== -1) {
+                        return line.substring(0, commentIndex).trimEnd();
+                    }
+                    return line;
+                })
+                    .join("");
                 array.push(lines);
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ptolemy2002/rgx",
-    "version": "7.3.0",
+    "version": "7.4.0",
     "private": false,
     "main": "dist/index.js",
     "types": "dist/index.d.ts",