wing icon indicating copy to clipboard operation
wing copied to clipboard

Repo organization: move tests out of `examples`

Open eladb opened this issue 1 year ago • 11 comments

Currently all of our tests are under /examples/tests. That's a bit weird.

Can we just move them to /tests ?

eladb avatar Mar 19 '24 08:03 eladb

Adding on an idea - I think it would be nice if all packages (including TypeScript-based and Rust-based ones) were in the same directory, /packages, instead of split between /apps and /libs. (2 cents)

Chriscbr avatar Mar 19 '24 20:03 Chriscbr

If we move the tests folder out, I would also just get rid of the examples folder. The "proposed" folder can just be deleted, and the "fixture" projects can either moved inside tests or just put alongside other projects.

all packages (including TypeScript-based and Rust-based ones) were in the same directory, /packages

I'm cool with this, If we combine everything we could also start respecting the convention of a hierarchy the matches the package name. i.e. wingsdk would be in /packages/@winglang/sdk

MarkMcCulloh avatar Mar 19 '24 21:03 MarkMcCulloh

The "proposed" folder can just be deleted

Agree, I think we can gracefully archive them to git history (or keep them as a fun historical artifact somewhere on the contributing docsite)

Chriscbr avatar Mar 19 '24 21:03 Chriscbr

+1 on /packages/@winglang/sdk, /test, ~/examples~

eladb avatar Mar 19 '24 21:03 eladb

Summarizing the actions specified in this issue, for any happy contributor out there who wants to pick this up:

  1. Move all of our tests one dir up. From /examples/tests to /tests.
  2. Move the 3 fixture packages under /tests. From /examples/*-fixture to /tests/*-fixture.
  3. Delete /examples (the only thing left at this point would be /examples/proposed).
  4. Combine /apps and /libs to /packages.

staycoolcall911 avatar Mar 20 '24 16:03 staycoolcall911

Can I work on this?

govindplal avatar May 03 '24 09:05 govindplal

But of course @govindplal :) Let us know if you have any questions, either here or in Slack #dev channel: https://t.winglang.io/slack

staycoolcall911 avatar May 03 '24 09:05 staycoolcall911

This is what I understood is to be done : Move /tests outside /examples Move /jsii-fixture, /ts-fixture, /js-fixture to /tests Create a new /packages and move all the elements of /apps and /libs into /packages Update necessary paths if required. Delete /examples, /apps, /libs.

@staycoolcall911 Can someone confirm this

govindplal avatar May 03 '24 10:05 govindplal

Yes indeed @govindplal - you got it right

staycoolcall911 avatar May 03 '24 11:05 staycoolcall911

also, please take a look at where we use examples/tests (or any other path) in the code, docs, gh workflows and configuration files, and package.json :) I would advise to do it incrementally- moving out one or two directories in each PR

tsuf239 avatar May 05 '24 07:05 tsuf239

also, please take a look at where we use examples/tests (or any other path) in the code, docs, gh workflows and configuration files, and package.json :) I would advise to do it incrementally- moving out one or two directories in each PR

Yeah, sure. Got held up with something else for the past days. I'm working on it!

govindplal avatar May 07 '24 02:05 govindplal

Hi @govindplal I am trying to reach out through Discord - I could not see you there, do you want to join to we can continue the discussion there? https://t.winglang.io/discord

revitalbarletz avatar May 21 '24 08:05 revitalbarletz

Hi,

This issue hasn't seen activity in 90 days. Therefore, we are marking this issue as stale for now. It will be closed after 7 days. Feel free to re-open this issue when there's an update or relevant information to be added. Thanks!

github-actions[bot] avatar Sep 02 '24 06:09 github-actions[bot]

Congrats! :rocket: This was released in Wing 0.83.11.

monadabot avatar Sep 03 '24 22:09 monadabot