@grain/stdlib 0.6.5 → 0.7.0

package/path.gr

@@ -722,6 +722,54 @@ provide let extension = (path: Path) => {
   }
 }
 
+/**
+ * Removes the extension from a path, if there is no extension, returns the path as is.
+ *
+ * @param path: The path to modify
+ * @returns The path with the extension removed
+ *
+ * @example removeExtension(fromString("file.txt")) == fromString("file")
+ * @example removeExtension(fromString(".gitignore")) == fromString(".gitignore")
+ * @example removeExtension(fromString("./dir/file")) == fromString("dir/file")
+ * @example removeExtension(fromString("./dir/")) == fromString("dir/")
+ *
+ * @since v7.0.0
+ */
+provide let removeExtension = (path: Path) => {
+  match (pathInfo(path)) {
+    (base, File, [name, ...rest]) as pathInfo => {
+      let (name, _) = stemExtHelper(pathInfo)
+      toPath((base, File, [name, ...rest]))
+    },
+    _ => path,
+  }
+}
+
+/**
+ * Updates the file extension of the given path.
+ *
+ * @param path: The path to modify
+ * @param extension: The new extension
+ * @returns The modified path
+ *
+ * @example updateExtension(fromString("file.txt"), "ext") == fromString("file.ext")
+ * @example updateExtension(fromString("file.txt"), "") == fromString("file.")
+ * @example updateExtension(fromString(".gitignore"), "ext") == fromString(".gitignore.ext")
+ * @example updateExtension(fromString("./dir/file"), "ext") == fromString("dir/file.ext")
+ * @example updateExtension(fromString("./dir/"), "ext") == fromString("dir/")
+ *
+ * @since v7.0.0
+ */
+provide let updateExtension = (path: Path, extension: String) => {
+  match (pathInfo(path)) {
+    (base, File, [name, ...rest]) as pathInfo => {
+      let (name, _) = stemExtHelper(pathInfo)
+      toPath((base, File, [name ++ "." ++ extension, ...rest]))
+    },
+    _ => path,
+  }
+}
+
 // should only be used on absolute paths
 let rootHelper = (path: PathInfo) => match (path) {
   (Abs(root), _, _) => root,

package/path.md

@@ -184,7 +184,7 @@ Functions and constants included in the Path module.
 </details>
 
 ```grain
-fromString : (pathStr: String, ?platform: Platform) => Path
+fromString: (pathStr: String, ?platform: Platform) => Path
 ```
 
 Parses a path string into a `Path` using the path separators appropriate to
@@ -238,7 +238,7 @@ fromString("C:\\file.txt", Windows) // a relative Path referencing the file C:\f
 </details>
 
 ```grain
-toString : (path: Path, ?platform: Platform) => String
+toString: (path: Path, ?platform: Platform) => String
 ```
 
 Converts the given `Path` into a string, using the canonical path separator
@@ -280,7 +280,7 @@ No other changes yet.
 </details>
 
 ```grain
-isDirectory : (path: Path) => Bool
+isDirectory: (path: Path) => Bool
 ```
 
 Determines whether the path is a directory path.
@@ -310,7 +310,7 @@ isDirectory(fromString("/bin/")) == true
 ### Path.**isAbsolute**
 
 ```grain
-isAbsolute : (path: Path) => Bool
+isAbsolute: (path: Path) => Bool
 ```
 
 Determines whether the path is an absolute path.
@@ -345,7 +345,7 @@ No other changes yet.
 </details>
 
 ```grain
-append : (path: Path, toAppend: Path) => Result<Path, AppendError>
+append: (path: Path, toAppend: Path) => Result<Path, AppendError>
 ```
 
 Creates a new path by appending a relative path segment to a directory path.
@@ -385,7 +385,7 @@ No other changes yet.
 </details>
 
 ```grain
-relativeTo : (source: Path, dest: Path) => Result<Path, RelativizationError>
+relativeTo: (source: Path, dest: Path) => Result<Path, RelativizationError>
 ```
 
 Attempts to construct a new relative path which will lead to the destination
@@ -444,7 +444,7 @@ No other changes yet.
 </details>
 
 ```grain
-ancestry :
+ancestry:
   (base: Path, path: Path) => Result<AncestryStatus, IncompatibilityError>
 ```
 
@@ -489,7 +489,7 @@ No other changes yet.
 </details>
 
 ```grain
-parent : (path: Path) => Path
+parent: (path: Path) => Path
 ```
 
 Retrieves the path corresponding to the parent directory of the given path.
@@ -524,7 +524,7 @@ No other changes yet.
 </details>
 
 ```grain
-basename : (path: Path) => Option<String>
+basename: (path: Path) => Option<String>
 ```
 
 Retrieves the basename (named final segment) of a path.
@@ -559,7 +559,7 @@ No other changes yet.
 </details>
 
 ```grain
-stem : (path: Path) => Result<String, PathOperationError>
+stem: (path: Path) => Result<String, PathOperationError>
 ```
 
 Retrieves the basename of a file path without the extension.
@@ -602,7 +602,7 @@ No other changes yet.
 </details>
 
 ```grain
-extension : (path: Path) => Result<String, PathOperationError>
+extension: (path: Path) => Result<String, PathOperationError>
 ```
 
 Retrieves the extension on the basename of a file path.
@@ -637,6 +637,97 @@ extension(fromString(".a.tar.gz")) == Ok(".tar.gz")
 extension(fromString("/dir/")) == Err(IncompatiblePathType) // can only take extension of a file path
 ```
 
+### Path.**removeExtension**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+removeExtension: (path: Path) => Path
+```
+
+Removes the extension from a path, if there is no extension, returns the path as is.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`path`|`Path`|The path to modify|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Path`|The path with the extension removed|
+
+Examples:
+
+```grain
+removeExtension(fromString("file.txt")) == fromString("file")
+```
+
+```grain
+removeExtension(fromString(".gitignore")) == fromString(".gitignore")
+```
+
+```grain
+removeExtension(fromString("./dir/file")) == fromString("dir/file")
+```
+
+```grain
+removeExtension(fromString("./dir/")) == fromString("dir/")
+```
+
+### Path.**updateExtension**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+updateExtension: (path: Path, extension: String) => Path
+```
+
+Updates the file extension of the given path.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`path`|`Path`|The path to modify|
+|`extension`|`String`|The new extension|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Path`|The modified path|
+
+Examples:
+
+```grain
+updateExtension(fromString("file.txt"), "ext") == fromString("file.ext")
+```
+
+```grain
+updateExtension(fromString("file.txt"), "") == fromString("file.")
+```
+
+```grain
+updateExtension(fromString(".gitignore"), "ext") == fromString(".gitignore.ext")
+```
+
+```grain
+updateExtension(fromString("./dir/file"), "ext") == fromString("dir/file.ext")
+```
+
+```grain
+updateExtension(fromString("./dir/"), "ext") == fromString("dir/")
+```
+
 ### Path.**root**
 
 <details disabled>
@@ -645,7 +736,7 @@ No other changes yet.
 </details>
 
 ```grain
-root : (path: Path) => Result<AbsoluteRoot, PathOperationError>
+root: (path: Path) => Result<AbsoluteRoot, PathOperationError>
 ```
 
 Retrieves the root of the absolute path.

package/pervasives.gr

@@ -236,7 +236,7 @@ provide primitive unbox = "@unbox"
 primitive elideTypeInfo = "@meta.elide_type_info"
 @unsafe
 let setupExceptions = () => {
-  Exception.dangerouslyRegisterPrinter(e => {
+  Exception.registerPrinter(e => {
     match (e) {
       Failure(msg) => Some("Failure: " ++ msg),
       InvalidArgument(msg) => Some("Invalid argument: " ++ msg),
@@ -247,7 +247,7 @@ let setupExceptions = () => {
   // If type information is elided, remove dependency on toString as
   // it will have no effect on exceptions
   if (!elideTypeInfo) {
-    Exception.dangerouslyRegisterBasePrinter(e => Some(toString(e)))
+    Exception.registerBasePrinter(e => toString(e))
   }
 }
 

package/pervasives.md

@@ -25,7 +25,7 @@ No other changes yet.
 </details>
 
 ```grain
-(!) : (bool: Bool) => Bool
+(!): (bool: Bool) => Bool
 ```
 
 Computes the logical NOT (`!`) of the given operand.
@@ -61,7 +61,7 @@ No other changes yet.
 </details>
 
 ```grain
-(&&) : (left: Bool, right: Bool) => Bool
+(&&): (left: Bool, right: Bool) => Bool
 ```
 
 Computes the logical AND (`&&`) of the given operands.
@@ -90,7 +90,7 @@ No other changes yet.
 </details>
 
 ```grain
-(||) : (left: Bool, right: Bool) => Bool
+(||): (left: Bool, right: Bool) => Bool
 ```
 
 Computes the logical OR `||` of the given operands.
@@ -119,7 +119,7 @@ No other changes yet.
 </details>
 
 ```grain
-(==) : (value1: a, value2: a) => Bool
+(==): (value1: a, value2: a) => Bool
 ```
 
 Check that two values are equal. This checks for structural equality,
@@ -146,7 +146,7 @@ No other changes yet.
 </details>
 
 ```grain
-(!=) : (value1: a, value2: a) => Bool
+(!=): (value1: a, value2: a) => Bool
 ```
 
 Check that two values are **not** equal. This checks for structural equality,
@@ -173,7 +173,7 @@ No other changes yet.
 </details>
 
 ```grain
-is : (left: a, right: a) => Bool
+is: (left: a, right: a) => Bool
 ```
 
 Checks that two values are physically equal.
@@ -200,7 +200,7 @@ No other changes yet.
 </details>
 
 ```grain
-isnt : (value1: a, value2: a) => Bool
+isnt: (value1: a, value2: a) => Bool
 ```
 
 Checks that two values are **not** physically equal.
@@ -227,7 +227,7 @@ No other changes yet.
 </details>
 
 ```grain
-(<) : (num1: Number, num2: Number) => Bool
+(<): (num1: Number, num2: Number) => Bool
 ```
 
 Checks if the first operand is less than the second operand.
@@ -253,7 +253,7 @@ No other changes yet.
 </details>
 
 ```grain
-(>) : (num1: Number, num2: Number) => Bool
+(>): (num1: Number, num2: Number) => Bool
 ```
 
 Checks if the first operand is greater than the second operand.
@@ -279,7 +279,7 @@ No other changes yet.
 </details>
 
 ```grain
-(<=) : (num1: Number, num2: Number) => Bool
+(<=): (num1: Number, num2: Number) => Bool
 ```
 
 Checks if the first operand is less than or equal to the second operand.
@@ -305,7 +305,7 @@ No other changes yet.
 </details>
 
 ```grain
-(>=) : (num1: Number, num2: Number) => Bool
+(>=): (num1: Number, num2: Number) => Bool
 ```
 
 Checks if the first operand is greater than or equal to the second operand.
@@ -331,7 +331,7 @@ No other changes yet.
 </details>
 
 ```grain
-compare : (num1: a, num2: a) => Number
+compare: (num1: a, num2: a) => Number
 ```
 
 Compares the first argument to the second argument and produces an integer result.
@@ -359,7 +359,7 @@ No other changes yet.
 </details>
 
 ```grain
-(+) : (num1: Number, num2: Number) => Number
+(+): (num1: Number, num2: Number) => Number
 ```
 
 Computes the sum of its operands.
@@ -385,7 +385,7 @@ No other changes yet.
 </details>
 
 ```grain
-(-) : (num1: Number, num2: Number) => Number
+(-): (num1: Number, num2: Number) => Number
 ```
 
 Computes the difference of its operands.
@@ -411,7 +411,7 @@ No other changes yet.
 </details>
 
 ```grain
-(*) : (num1: Number, num2: Number) => Number
+(*): (num1: Number, num2: Number) => Number
 ```
 
 Computes the product of its operands.
@@ -437,7 +437,7 @@ No other changes yet.
 </details>
 
 ```grain
-(/) : (num1: Number, num2: Number) => Number
+(/): (num1: Number, num2: Number) => Number
 ```
 
 Computes the quotient of its operands.
@@ -463,7 +463,7 @@ No other changes yet.
 </details>
 
 ```grain
-(%) : (num1: Number, num2: Number) => Number
+(%): (num1: Number, num2: Number) => Number
 ```
 
 Computes the remainder of the division of the first operand by the second.
@@ -497,7 +497,7 @@ Returns:
 </details>
 
 ```grain
-(**) : (base: Number, power: Number) => Number
+(**): (base: Number, power: Number) => Number
 ```
 
 Computes the exponentiation of the given base and power.
@@ -523,7 +523,7 @@ No other changes yet.
 </details>
 
 ```grain
-incr : (value: Number) => Number
+incr: (value: Number) => Number
 ```
 
 Increments the value by one.
@@ -548,7 +548,7 @@ No other changes yet.
 </details>
 
 ```grain
-decr : (value: Number) => Number
+decr: (value: Number) => Number
 ```
 
 Decrements the value by one.
@@ -573,7 +573,7 @@ No other changes yet.
 </details>
 
 ```grain
-(++) : (str1: String, str2: String) => String
+(++): (str1: String, str2: String) => String
 ```
 
 Concatenate two strings.
@@ -605,7 +605,7 @@ No other changes yet.
 </details>
 
 ```grain
-lnot : (value: Number) => Number
+lnot: (value: Number) => Number
 ```
 
 Computes the bitwise NOT of the operand.
@@ -638,7 +638,7 @@ Returns:
 </details>
 
 ```grain
-(&) : (value1: Number, value2: Number) => Number
+(&): (value1: Number, value2: Number) => Number
 ```
 
 Computes the bitwise AND (`&`) on the given operands.
@@ -672,7 +672,7 @@ Returns:
 </details>
 
 ```grain
-(|) : (value1: Number, value2: Number) => Number
+(|): (value1: Number, value2: Number) => Number
 ```
 
 Computes the bitwise OR (`|`) on the given operands.
@@ -707,7 +707,7 @@ Returns:
 </details>
 
 ```grain
-(^) : (value1: Number, value2: Number) => Number
+(^): (value1: Number, value2: Number) => Number
 ```
 
 Computes the bitwise XOR (`^`) on the given operands.
@@ -741,7 +741,7 @@ Returns:
 </details>
 
 ```grain
-(<<) : (value: Number, amount: Number) => Number
+(<<): (value: Number, amount: Number) => Number
 ```
 
 Shifts the bits of the value left by the given number of bits.
@@ -775,7 +775,7 @@ Returns:
 </details>
 
 ```grain
-(>>>) : (value: Number, amount: Number) => Number
+(>>>): (value: Number, amount: Number) => Number
 ```
 
 Shifts the bits of the value right by the given number of bits, preserving the sign bit.
@@ -809,7 +809,7 @@ Returns:
 </details>
 
 ```grain
-(>>) : (value: Number, amount: Number) => Number
+(>>): (value: Number, amount: Number) => Number
 ```
 
 Shifts the bits of the value right by the given number of bits.
@@ -835,7 +835,7 @@ No other changes yet.
 </details>
 
 ```grain
-toString : (value: a) => String
+toString: (value: a) => String
 ```
 
 Converts the given operand to a string.
@@ -868,7 +868,7 @@ Returns:
 </details>
 
 ```grain
-print : (value: a, ?suffix: String) => Void
+print: (value: a, ?suffix: String) => Void
 ```
 
 Prints the given operand to the console. Works for any type. Internally, calls `toString`
@@ -890,7 +890,7 @@ No other changes yet.
 </details>
 
 ```grain
-ignore : (value: a) => Void
+ignore: (value: a) => Void
 ```
 
 Accepts any value and always returns `void`.
@@ -909,7 +909,7 @@ No other changes yet.
 </details>
 
 ```grain
-assert : (condition: Bool) => Void
+assert: (condition: Bool) => Void
 ```
 
 Assert that the given Boolean condition is `true`.
@@ -944,7 +944,7 @@ No other changes yet.
 </details>
 
 ```grain
-throw : (exn: Exception) => a
+throw: (exn: Exception) => a
 ```
 
 Throw an exception. Currently, exceptions cannot be caught and will crash your program.
@@ -964,7 +964,7 @@ Returns:
 ### Pervasives.**fail**
 
 ```grain
-fail : (message: String) => a
+fail: (message: String) => a
 ```
 
 Unconditionally throw a `Failure` exception with a message.
@@ -990,7 +990,7 @@ No other changes yet.
 </details>
 
 ```grain
-identity : (value: a) => a
+identity: (value: a) => a
 ```
 
 Provides the operand untouched.
@@ -1015,7 +1015,7 @@ No other changes yet.
 </details>
 
 ```grain
-box : (value: a) => Box<a>
+box: (value: a) => Box<a>
 ```
 
 Creates a box containing the given initial value.
@@ -1042,7 +1042,7 @@ No other changes yet.
 </details>
 
 ```grain
-unbox : (value: Box<a>) => a
+unbox: (value: Box<a>) => a
 ```
 
 Retrieves the current value from a box.

package/priorityqueue.gr

@@ -31,9 +31,9 @@ let swap = (i1, i2, array) => {
 
 let get = (array, i) =>
   Option.expect(
-    "Impossible: " ++
-      toString(i) ++
-      " in PriorityQueue's inner storage array is None",
+    "Impossible: "
+      ++ toString(i)
+      ++ " in PriorityQueue's inner storage array is None",
     array[i]
   )
 
@@ -47,8 +47,8 @@ let rec siftDown = (i, pq) => {
     swapWithI = leftI
   }
   if (
-    rightI < pq.size &&
-    pq.comp(get(pq.array, rightI), get(pq.array, swapWithI)) < 0
+    rightI < pq.size
+    && pq.comp(get(pq.array, rightI), get(pq.array, swapWithI)) < 0
   ) {
     swapWithI = rightI
   }
@@ -340,8 +340,8 @@ provide module Immutable {
         children: [newNode, node2, ...node1.children],
       }
     } else if (
-      comp(node2.val, newNode.val) <= 0 &&
-      comp(node2.val, node1.val) <= 0
+      comp(node2.val, newNode.val) <= 0
+      && comp(node2.val, node1.val) <= 0
     ) {
       {
         val: node2.val,