feat(sdk): add fs module

examples/tests/invalid/bring.test.w

@@ -3,9 +3,7 @@ bring std;
 bring cloud;
 bring cloud;
 //    ^^^^^ "cloud" is already defined
-bring fs;
-//    ^^^^^ "fs" is not a built-in module
 bring ;
 //^^^^^ Expected module specification (see https://www.winglang.io/docs/libraries)
 bring c;
-//^^^^^^ "c" is not a built-in module
+//^^^^^^ "c" is not a built-in module

examples/tests/sdk_tests/fs/basic.main.w

@@ -0,0 +1,30 @@
+bring fs;
+
+let filename = "hello.txt";
+let data = "Hello, Wing!";
+
+fs.writeFile(filename, data);
+assert(fs.exists(filename) == true);
+
+let content = fs.readFile(filename);
+assert(content == data);
+
+fs.remove(filename);
+assert(fs.exists(filename) == false);
+
+let nilContent = fs.tryReadFile(filename);
+assert(nilContent == nil);
+
+test "inflight file basic operations" {
+    fs.writeFile(filename, data);
+    assert(fs.exists(filename) == true);
+
+    let content = fs.readFile(filename);
+    assert(content == data);
+
+    fs.remove(filename);
+    assert(fs.exists(filename) == false);
+
+    let nilContent = fs.tryReadFile(filename);
+    assert(nilContent == nil);
+}

examples/tests/sdk_tests/fs/directory.main.w

@@ -0,0 +1,45 @@
+bring fs;
+bring regex;
+
+let dirname = "wingdir";
+let filename = "temp.txt";
+
+fs.mkdir(dirname);
+assert(fs.exists(dirname) == true);
+
+try {
+    fs.mkdir(dirname);
+} catch e {
+    assert(regex.match("^EEXIST: file already exists", e) == true);
+}
+
+fs.writeFile(fs.join(dirname, filename), "");
+let files = fs.readdir(dirname);
+assert(files.length == 1);
+
+fs.remove(dirname, { recursive: true });
+assert(fs.exists(dirname) == false);
+
+let nilFiles = fs.tryReaddir(dirname);
+assert(nilFiles == nil);
+
+test "inflight create normal directory" {
+    fs.mkdir(dirname);
+    assert(fs.exists(dirname) == true);
+
+    try {
+        fs.mkdir(dirname);
+    } catch e {
+        assert(regex.match("^EEXIST: file already exists", e) == true);
+    }
+
+    fs.writeFile(fs.join(dirname, filename), "");
+    let files = fs.readdir(dirname);
+    assert(files.length == 1);
+
+    fs.remove(dirname, { recursive: true });
+    assert(fs.exists(dirname) == false);
+
+    let nilFiles = fs.tryReaddir(dirname);
+    assert(nilFiles == nil);
+}

examples/tests/sdk_tests/fs/json.main.w

@@ -0,0 +1,46 @@
+bring fs;
+bring regex;
+
+let filename = "test-json.json";
+let data = Json {
+    "foo": "bar", 
+    "arr": [1, 2, 3, "test", { "foo": "bar" }]
+};
+
+try {
+    fs.writeFile(filename, "invalid content");
+    fs.readJson(filename);
+} catch e {
+    assert(regex.match("^Unexpected token", e) == true);
+}
+
+fs.writeJson(filename, data);
+assert(fs.exists(filename) == true);
+
+let obj = fs.readJson(filename);
+assert(Json.stringify(obj) == Json.stringify(data));
+
+fs.remove(filename);
+assert(fs.exists(filename) == false);
+
+assert(fs.tryReadJson(filename) == nil);
+
+test "inflight json operations" {
+    try {
+        fs.writeFile(filename, "invalid content");
+        fs.readJson(filename);
+    } catch e {
+        assert(regex.match("^Unexpected token", e) == true);
+    }
+
+    fs.writeJson(filename, data);
+    assert(fs.exists(filename) == true);
+
+    let obj = fs.readJson(filename);
+    assert(Json.stringify(obj) == Json.stringify(data));
+
+    fs.remove(filename);
+    assert(fs.exists(filename) == false);
+
+    assert(fs.tryReadJson(filename) == nil);
+}

examples/tests/sdk_tests/fs/path.main.w

@@ -0,0 +1,37 @@
+bring fs;
+bring regex;
+
+let from = "/a/b/c/d";
+let to = "/a/b/e/f";
+
+let var result = fs.join(from, to);
+assert(result == "/a/b/c/d/a/b/e/f");
+
+result = fs.relative(from ,to);
+assert(result == "../../e/f");
+
+result = fs.dirname(from);
+assert(result == "/a/b/c");
+
+result = fs.basename(from);
+assert(result == "d");
+
+result = fs.resolve(from, to);
+assert(regex.match("/a/b/e/f", result));
+
+test "inflight path conversion" {
+    let var result = fs.join(from, to);
+    assert(result == "/a/b/c/d/a/b/e/f");
+
+    result = fs.relative(from ,to);
+    assert(result == "../../e/f");
+
+    result = fs.dirname(from);
+    assert(result == "/a/b/c");
+
+    result = fs.basename(from);
+    assert(result == "d");
+
+    result = fs.resolve(from, to);
+    assert(regex.match("/a/b/e/f", result));
+}

examples/tests/sdk_tests/fs/temp_dir.main.w

@@ -0,0 +1,15 @@
+bring fs;
+
+let tmpdir = fs.mkdtemp();
+assert(fs.exists(tmpdir) == true);
+
+fs.remove(tmpdir, { recursive: true });
+assert(fs.exists(tmpdir) == false);
+
+test "inflight create temporary directory" {
+    let tmpdir = fs.mkdtemp();
+    assert(fs.exists(tmpdir) == true);
+
+    fs.remove(tmpdir, { recursive: true });
+    assert(fs.exists(tmpdir) == false);
+}

examples/tests/sdk_tests/fs/yaml.main.w

@@ -0,0 +1,39 @@
+bring fs;
+bring regex;
+
+let filename = "test-yaml.yaml";
+let data = Json {
+    "foo": "bar", 
+    "arr": [1, 2, 3, "test", { "foo": "bar" }]
+};
+
+try {
+    fs.writeFile(filename, "invalid: {{ content }}, invalid");
+    fs.readYaml(filename);
+} catch e {
+    assert(regex.match("^bad indentation", e) == true);
+}
+
+fs.writeYaml(filename, data, data);
+assert(fs.exists(filename) == true);
+
+let objs = fs.readYaml(filename);
+assert(objs.length == 2);
+assert(Json.stringify(objs.at(0)) == Json.stringify(data));
+assert(Json.stringify(objs.at(1)) == Json.stringify(data));
+
+fs.remove(filename);
+assert(fs.exists(filename) == false);
+
+test "inflight yaml operations" {
+    fs.writeYaml(filename, data, data);
+    assert(fs.exists(filename) == true);
+
+    let objs = fs.readYaml(filename);
+    assert(objs.length == 2);
+    assert(Json.stringify(objs.at(0)) == Json.stringify(data));
+    assert(Json.stringify(objs.at(1)) == Json.stringify(data));
+
+    fs.remove(filename);
+    assert(fs.exists(filename) == false);
+}

libs/wingc/src/lib.rs

@@ -78,17 +78,19 @@ const WINGSDK_MATH_MODULE: &'static str = "math";
 const WINGSDK_AWS_MODULE: &'static str = "aws";
 const WINGSDK_EX_MODULE: &'static str = "ex";
 const WINGSDK_REGEX_MODULE: &'static str = "regex";
+const WINGSDK_FS_MODULE: &'static str = "fs";
 
 pub const UTIL_CLASS_NAME: &'static str = "Util";
 
-const WINGSDK_BRINGABLE_MODULES: [&'static str; 7] = [
+const WINGSDK_BRINGABLE_MODULES: [&'static str; 8] = [
 	WINGSDK_CLOUD_MODULE,
 	WINGSDK_UTIL_MODULE,
 	WINGSDK_HTTP_MODULE,
 	WINGSDK_MATH_MODULE,
 	WINGSDK_AWS_MODULE,
 	WINGSDK_EX_MODULE,
 	WINGSDK_REGEX_MODULE,
+	WINGSDK_FS_MODULE,
 ];
 
 const WINGSDK_DURATION: &'static str = "std.Duration";

libs/wingc/src/lsp/snapshots/completions/bring_suggestions.snap

@@ -10,6 +10,9 @@ source: libs/wingc/src/lsp/completions.rs
 - label: ex
   kind: 9
   sortText: kk|ex
+- label: fs
+  kind: 9
+  sortText: kk|fs
 - label: http
   kind: 9
   sortText: kk|http

libs/wingc/src/lsp/snapshots/completions/bring_suggestions_partial.snap

@@ -10,6 +10,9 @@ source: libs/wingc/src/lsp/completions.rs
 - label: ex
   kind: 9
   sortText: kk|ex
+- label: fs
+  kind: 9
+  sortText: kk|fs
 - label: http
   kind: 9
   sortText: kk|http

libs/wingsdk/.projenrc.ts

@@ -84,6 +84,8 @@ const project = new cdk.JsiiProject({
     // shared client dependencies
     "ioredis",
     "jsonschema",
+    // fs module dependency
+    "js-yaml@^4.1.0",
     "yaml",
   ],
   devDeps: [
@@ -102,6 +104,7 @@ const project = new cdk.JsiiProject({
     "vitest",
     "@types/uuid",
     "@vitest/coverage-v8",
+    "@types/js-yaml@^4.0.6",
     "nanoid", // for ESM import test in target-sim/function.test.ts
     ...JSII_DEPS,
   ],