@eagleoutice/flowr 2.2.1 → 2.2.3

package/util/range.d.ts

@@ -1,9 +1,27 @@
+/**
+ * A source position in a file.
+ *
+ * Please note that some packages like `xmlparsedata` use their own start and end only to break ties
+ * (e.g., `xmlparsedata` calculates them on a max col width approximation)
+ */
 export type SourcePosition = [
     /** starts with 1 */
     line: number,
     /** starts with 1 */
     column: number
 ];
+/**
+ * Describe the start and end {@link SourcePosition|source position} of an element.
+ *
+ * @see {@link rangeFrom} - to create a range
+ * @see {@link mergeRanges} - to merge multiple ranges
+ * @see {@link getRangeStart} - to get the start of a range
+ * @see {@link getRangeEnd} - to get the end of a range
+ * @see {@link rangeStartsCompletelyBefore} - to check if one range starts before another
+ * @see {@link rangesOverlap} - to check if two ranges overlap
+ * @see {@link addRanges} - to add two ranges
+ * @see {@link rangeCompare} - to compare two ranges
+ */
 export type SourceRange = [
     /** inclusive start position */
     startLine: number,
@@ -36,6 +54,9 @@ export declare function rangeStartsCompletelyBefore([, , r1el, r1ec]: SourceRang
  * Checks if the two ranges overlap.
  */
 export declare function rangesOverlap([r1sl, r1sc, r1el, r1ec]: SourceRange, [r2sl, r2sc, r2el, r2ec]: SourceRange): boolean;
+/**
+ * Calculate the component-wise sum of two ranges
+ */
 export declare function addRanges([r1sl, r1sc, r1el, r1ec]: SourceRange, [r2sl, r2sc, r2el, r2ec]: SourceRange): SourceRange;
 /**
  * Provides a comparator for {@link SourceRange}s that sorts them in ascending order.

package/util/range.js

@@ -45,6 +45,9 @@ function rangeStartsCompletelyBefore([, , r1el, r1ec], [r2sl, r2sc, ,]) {
 function rangesOverlap([r1sl, r1sc, r1el, r1ec], [r2sl, r2sc, r2el, r2ec]) {
     return r1sl <= r2el && r2sl <= r1el && r1sc <= r2ec && r2sc <= r1ec;
 }
+/**
+ * Calculate the component-wise sum of two ranges
+ */
 function addRanges([r1sl, r1sc, r1el, r1ec], [r2sl, r2sc, r2el, r2ec]) {
     return [r1sl + r2sl, r1sc + r2sc, r1el + r2el, r1ec + r2ec];
 }

package/util/strings.d.ts

@@ -10,3 +10,12 @@ export declare function withoutWhitespace(output: string): string;
  * Find the longest common prefix in an array of strings
  */
 export declare function longestCommonPrefix(strings: string[]): string;
+/**
+ * Join a list of strings, but with special handling for the last element/scenarios in which the array contains exactly two elements.
+ * The goal is to create (partial) sentences like `a, b, and c` or `a and b`.
+ */
+export declare function joinWithLast(strs: readonly string[], { join, last, joinTwo }?: {
+    join?: string;
+    last?: string;
+    joinTwo?: string;
+}): string;

package/util/strings.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.startAndEndsWith = startAndEndsWith;
 exports.withoutWhitespace = withoutWhitespace;
 exports.longestCommonPrefix = longestCommonPrefix;
+exports.joinWithLast = joinWithLast;
 /**
  * Check if the given string starts and ends with the given letter
  */
@@ -37,4 +38,17 @@ function longestCommonPrefix(strings) {
     }
     return prefix;
 }
+/**
+ * Join a list of strings, but with special handling for the last element/scenarios in which the array contains exactly two elements.
+ * The goal is to create (partial) sentences like `a, b, and c` or `a and b`.
+ */
+function joinWithLast(strs, { join = ', ', last = ', and ', joinTwo = ' and ' } = {}) {
+    if (strs.length <= 1) {
+        return strs.join('');
+    }
+    else if (strs.length === 2) {
+        return strs.join(joinTwo);
+    }
+    return strs.slice(0, -1).join(join) + last + strs[strs.length - 1];
+}
 //# sourceMappingURL=strings.js.map

package/util/version.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.flowrVersion = flowrVersion;
 const semver_1 = require("semver");
 // this is automatically replaced with the current version by release-it
-const version = '2.2.1';
+const version = '2.2.3';
 function flowrVersion() {
     return new semver_1.SemVer(version);
 }