Add path separator constants and utility function.

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v1.1.0 - 2024-04-01
+
+- Add `path_separator_unix` and `path_separator_windows` constants.
+- Add `path_separator()` function for returning the path separator
+  for the platform currently being run on.
+
 ## v1.0.0 - 2024-02-08
 
 - All existing functions now support Windows paths when run on Windows.

gleam.toml

@@ -1,5 +1,5 @@
 name = "filepath"
-version = "1.0.0"
+version = "1.1.0"
 description = "Work with file paths in Gleam!"
 licences = ["Apache-2.0"]
 repository = { type = "github", user = "lpil", repo = "filepath" }

src/filepath.gleam

@@ -20,6 +20,38 @@ import gleam/option.{type Option, None, Some}
 @external(javascript, "./filepath_ffi.mjs", "is_windows")
 fn is_windows() -> Bool
 
+/// Path separator for Unix platforms.
+pub const path_separator_unix = "/"
+
+/// Path separator for the Windows platform.
+pub const path_separator_windows = "\\"
+
+/// Returns the path separator for the operating system
+/// which it's currently being run on.
+///
+/// For Windows, this will be `\`.
+/// For any non-Windows platform, this will be `/`.
+///
+/// ## Examples
+///
+/// ```gleam
+/// path_separator()
+/// // -> "/"
+/// ```
+///
+/// ```gleam
+/// // Windows-only behavior:
+/// path_separator()
+/// // -> "\\"
+/// ```
+///
+pub fn path_separator() -> String {
+  case is_windows() {
+    True -> path_separator_windows
+    False -> path_separator_unix
+  }
+}
+
 /// Join two paths together.
 ///
 /// This function does not expand `..` or `.` segments, use the `expand`
@@ -59,12 +91,10 @@ fn remove_trailing_slash(path: String) -> String {
   }
 }
 
-// TODO: Windows support
 /// Split a path into its segments.
 ///
-/// When running on Windows both `/` and `\` are treated as path separators, and 
-/// if the path starts with a drive letter then the drive letter then it is
-/// lowercased.
+/// When running on Windows both `/` and `\` are treated as path separators, and
+/// if the path starts with a drive letter then the drive letter is lowercased.
 ///
 /// ## Examples
 ///
@@ -192,24 +222,24 @@ pub fn extension(path: String) -> Result(String, Nil) {
 }
 
 /// Remove the extension from a file, if it has any.
-/// 
+///
 /// ## Examples
-/// 
+///
 /// ```gleam
 /// strip_extension("src/main.gleam")
 /// // -> "src/main"
 /// ```
-/// 
+///
 /// ```gleam
 /// strip_extension("package.tar.gz")
 /// // -> "package.tar"
 /// ```
-/// 
+///
 /// ```gleam
 /// strip_extension("src/gleam")
 /// // -> "src/gleam"
 /// ```
-/// 
+///
 pub fn strip_extension(path: String) -> String {
   case extension(path) {
     Ok(extension) ->

test/filepath_test.gleam

@@ -20,6 +20,28 @@ fn windows_only(f: fn() -> whatever) -> Nil {
   }
 }
 
+fn non_windows_only(f: fn() -> whatever) -> Nil {
+  case is_windows() {
+    False -> {
+      f()
+      Nil
+    }
+    True -> Nil
+  }
+}
+
+pub fn path_separator_windows_0_test() {
+  use <- windows_only
+  filepath.path_separator()
+  |> should.equal(filepath.path_separator_windows)
+}
+
+pub fn path_separator_non_windows_0_test() {
+  use <- non_windows_only
+  filepath.path_separator()
+  |> should.equal(filepath.path_separator_unix)
+}
+
 pub fn split_0_test() {
   filepath.split("")
   |> should.equal([])