feat(sdk): add fs module #4135

jianzs · 2023-09-10T13:46:28Z

Support fs module. All file paths are POSIX file paths, and will be normalized to the target platform when performing operations.

Checklist

Title matches Winglang's style guide
Description explains motivation and solution
Tests added (always)
Docs updated (only required for features)
Added pr/e2e-full label if this feature requires end-to-end testing

By submitting this pull request, I confirm that my contribution is made under the terms of the Wing Cloud Contribution License.

tsuf239

Great work!! just a few tiny adjustments (mostly to the js docs) and an addition of an example written in wing, and you're there! 💫

libs/wingsdk/src/fs/fs.ts

libs/wingsdk/test/fs/fs.test.ts

libs/wingsdk/src/fs/fs.ts

jianzs · 2023-09-16T12:49:10Z

Thank you all for your suggestions and comments, I will improve it as soon as possible

Signed-off-by: monada-bot[bot] <[email protected]>

eladb

Great job @jianzs 🙏 love the thoroughness and high quality code and testing. I love the batteries included, feel free to add more capabilities here as you see fit. I've always found fs libraries to be too puristy and I think having a rich standard library makes a difference.

Ideally but definitely not required right now, if you call these methods from preflight they will be sync, and calling them from inflight should be async.. it's not possible to do right now but putting this thought on @yoav-steinberg 's radar...

BTW, we need a process library if you'd like to take the design. (spawn, shell, etc).

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

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

libs/wingsdk/src/fs/fs.ts

tools/hangar/__snapshots__/invalid.ts.snap

Chriscbr · 2023-10-06T19:21:57Z

@jianzs Since we're introducing some functionality that deals with paths, I've added the pr/e2e-full label so that our continuous integration runs everything on Windows as well. It should take affect on any new commits added to the branch.

Signed-off-by: monada-bot[bot] <[email protected]>

libs/wingsdk/src/fs/fs.ts

libs/wingsdk/package.json

MarkMcCulloh

Really great work, last change needed

libs/wingsdk/src/fs/fs.ts

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

Signed-off-by: monada-bot[bot] <[email protected]>

MarkMcCulloh

🎉

Successful AWS test https://github.com/winglang/wing/actions/runs/6498630844/job/17650384065

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

libs/wingsdk/src/fs/fs.ts

Signed-off-by: monada-bot[bot] <[email protected]>

mergify · 2023-10-13T11:00:48Z

Thanks for contributing, @jianzs! This PR will now be added to the merge queue, or immediately merged if add_fs_module is up-to-date with main and the queue is empty.

monadabot · 2023-10-13T11:40:35Z

Congrats! 🚀 This was released in Wing 0.38.3.

Following #4135, there's no more need for a fs `extern` module. *By submitting this pull request, I confirm that my contribution is made under the terms of the [Wing Cloud Contribution License](https://github.com/winglang/wing/blob/main/CONTRIBUTION_LICENSE.md)*.

jianzs requested a review from a team as a code owner September 10, 2023 13:46

tsuf239 reviewed Sep 11, 2023

View reviewed changes

eladb reviewed Sep 11, 2023

View reviewed changes

libs/wingsdk/src/fs/fs.ts Outdated Show resolved Hide resolved

eladb reviewed Sep 11, 2023

View reviewed changes

libs/wingsdk/src/fs/fs.ts Outdated Show resolved Hide resolved

eladb reviewed Sep 12, 2023

View reviewed changes

libs/wingsdk/src/fs/fs.ts Outdated Show resolved Hide resolved

eladb requested changes Sep 12, 2023

View reviewed changes

libs/wingsdk/src/fs/fs.ts Outdated Show resolved Hide resolved

libs/wingsdk/src/fs/fs.ts Outdated Show resolved Hide resolved

libs/wingsdk/src/fs/fs.ts Outdated Show resolved Hide resolved

libs/wingsdk/src/fs/fs.ts Outdated Show resolved Hide resolved

Chriscbr reviewed Sep 12, 2023

View reviewed changes

libs/wingsdk/src/fs/fs.ts Outdated Show resolved Hide resolved

libs/wingsdk/src/fs/fs.ts Outdated Show resolved Hide resolved

jianzs requested review from ainvoner, polamoros, skyrpex and eladcon as code owners October 5, 2023 13:29

feat(sdk): add fs module

b0f5d5f

jianzs force-pushed the add_fs_module branch from 599b6a3 to b0f5d5f Compare October 5, 2023 14:56

monadabot and others added 2 commits October 5, 2023 22:02

Merge branch 'main' into add_fs_module

57d3753

chore: self mutation (e2e-2of2.diff)

c606ad7

Signed-off-by: monada-bot[bot] <[email protected]>

monadabot added the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Oct 5, 2023

eladb approved these changes Oct 5, 2023

View reviewed changes

add @throws docstrings

acff776

Chriscbr reviewed Oct 6, 2023

View reviewed changes

tools/hangar/__snapshots__/invalid.ts.snap Show resolved Hide resolved

Chriscbr added the 🧪 pr/e2e-full label Oct 6, 2023

Chriscbr approved these changes Oct 6, 2023

View reviewed changes

jianzs and others added 2 commits October 7, 2023 13:20

remove 'bring fs;' error from invalid/bring.test.w

2dd75cf

Merge branch 'main' into add_fs_module

4f2f6aa

eladb removed the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Oct 10, 2023

monadabot and others added 3 commits October 10, 2023 11:07

Merge branch 'main' into add_fs_module

07a028f

chore: self mutation (build.diff)

9818e03

Signed-off-by: monada-bot[bot] <[email protected]>

chore: self mutation (e2e-2of2.diff)

a3f7ee9

Signed-off-by: monada-bot[bot] <[email protected]>

monadabot added the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Oct 10, 2023

jianzs and others added 3 commits October 12, 2023 00:39

keep the drive in the Windows posix-like path

50d6ff9

Merge branch 'main' into add_fs_module

f60b3e9

chore: self mutation (build.diff)

4d66b1d

Signed-off-by: monada-bot[bot] <[email protected]>

MarkMcCulloh reviewed Oct 11, 2023

View reviewed changes

libs/wingsdk/src/fs/fs.ts Outdated Show resolved Hide resolved

remove localPath

4aa8d6d

MarkMcCulloh reviewed Oct 12, 2023

View reviewed changes

libs/wingsdk/package.json Outdated Show resolved Hide resolved

jianzs added 2 commits October 12, 2023 23:40

use yaml instead of js-yaml

0705be2

remove the @types/js-yaml dependency

b04b3be

MarkMcCulloh suggested changes Oct 12, 2023

View reviewed changes

libs/wingsdk/src/fs/fs.ts Outdated Show resolved Hide resolved

examples/tests/sdk_tests/fs/basic.main.w Outdated Show resolved Hide resolved

monadabot and others added 4 commits October 12, 2023 12:31

Merge branch 'main' into add_fs_module

f1be525

chore: self mutation (build.diff)

d9b4484

Signed-off-by: monada-bot[bot] <[email protected]>

return undefined when any operation fails in tryX

b01c184

test fs methods in /tmp dir

4151dda

MarkMcCulloh approved these changes Oct 12, 2023

View reviewed changes

MarkMcCulloh removed the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Oct 12, 2023

MarkMcCulloh reviewed Oct 12, 2023

View reviewed changes

examples/tests/sdk_tests/fs/basic.main.w Outdated Show resolved Hide resolved

MarkMcCulloh reviewed Oct 12, 2023

View reviewed changes

libs/wingsdk/src/fs/fs.ts Outdated Show resolved Hide resolved

jianzs and others added 5 commits October 13, 2023 13:23

set recursive default to true for mkdir

ced77ae

mkdtemp before test

7807946

Merge branch 'main' into add_fs_module

26059f7

chore: self mutation (e2e-1of2.diff)

b773835

Signed-off-by: monada-bot[bot] <[email protected]>

chore: self mutation (e2e-2of2.diff)

094ee5f

Signed-off-by: monada-bot[bot] <[email protected]>

monadabot added the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Oct 13, 2023

MarkMcCulloh removed the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Oct 13, 2023

mergify bot merged commit 94e3953 into winglang:main Oct 13, 2023
23 checks passed

garysassano mentioned this pull request Oct 14, 2023

chore(sdk): remove fs extern module #4542

Merged

staycoolcall911 mentioned this pull request Oct 18, 2023

Standard library: utility functions #3096

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(sdk): add fs module #4135

feat(sdk): add fs module #4135

jianzs commented Sep 10, 2023 •

edited

Loading

tsuf239 left a comment

jianzs commented Sep 16, 2023

eladb left a comment

Chriscbr commented Oct 6, 2023

MarkMcCulloh left a comment

MarkMcCulloh left a comment

mergify bot commented Oct 13, 2023

monadabot commented Oct 13, 2023

feat(sdk): add fs module #4135

feat(sdk): add fs module #4135

Conversation

jianzs commented Sep 10, 2023 • edited Loading

Checklist

tsuf239 left a comment

Choose a reason for hiding this comment

jianzs commented Sep 16, 2023

eladb left a comment

Choose a reason for hiding this comment

Chriscbr commented Oct 6, 2023

MarkMcCulloh left a comment

Choose a reason for hiding this comment

MarkMcCulloh left a comment

Choose a reason for hiding this comment

mergify bot commented Oct 13, 2023

monadabot commented Oct 13, 2023

jianzs commented Sep 10, 2023 •

edited

Loading