Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: move configuration, script and contract files into dedicated dev folder #460

Closed
wants to merge 5 commits into from

Conversation

Raiden1411
Copy link
Contributor

@Raiden1411 Raiden1411 commented May 8, 2023

PR-Codex overview

This PR updates and moves config files into a dedicated dev directory. Notable changes include:

  • New dev directory with updated file paths
  • Added .vscode and .idea directories
  • Added cache and out directories
  • Added lib/ds-test submodule
  • Updated file paths in various configuration files
  • Added new contracts and libraries, including CompilationTest, CompilationScript, and StdError

The following files were skipped due to too many changes: dev/contracts/lib/forge-std/src/StdError.sol, src/_test/utils.ts, dev/contracts/lib/forge-std/src/Test.sol, dev/contracts/lib/forge-std/LICENSE-MIT, dev/contracts/lib/forge-std/src/StdMath.sol, dev/scripts/utils/utils.ts, dev/contracts/lib/forge-std/src/Base.sol, dev/contracts/lib/forge-std/src/interfaces/IMulticall3.sol, dev/contracts/lib/forge-std/src/interfaces/IERC20.sol, dev/contracts/lib/forge-std/.github/workflows/ci.yml, dev/contracts/lib/forge-std/test/StdError.t.sol, dev/scripts/utils/caller.ts, dev/contracts/lib/forge-std/src/StdInvariant.sol, package.json, dev/contracts/lib/forge-std/src/StdJson.sol, dev/contracts/lib/forge-std/lib/ds-test/demo/demo.sol, dev/contracts/lib/forge-std/test/StdChains.t.sol, dev/contracts/lib/forge-std/test/StdMath.t.sol, dev/scripts/utils/getCurrentLine.ts, dev/contracts/lib/forge-std/src/interfaces/IERC1155.sol, dev/contracts/lib/forge-std/README.md, dev/contracts/lib/forge-std/src/interfaces/IERC721.sol, dev/contracts/lib/forge-std/src/StdUtils.sol, dev/contracts/lib/forge-std/src/StdChains.sol, dev/contracts/lib/forge-std/test/StdStorage.t.sol, dev/contracts/lib/forge-std/src/StdAssertions.sol, dev/contracts/lib/forge-std/src/StdStorage.sol, dev/contracts/lib/forge-std/test/fixtures/broadcast.log.json, dev/contracts/lib/forge-std/test/StdCheats.t.sol, dev/contracts/lib/forge-std/LICENSE-APACHE, dev/contracts/lib/forge-std/test/StdUtils.t.sol, dev/contracts/lib/forge-std/src/interfaces/IERC4626.sol, dev/contracts/lib/forge-std/lib/ds-test/src/test.sol, dev/contracts/lib/forge-std/src/StdCheats.sol, dev/contracts/lib/forge-std/src/Vm.sol, dev/contracts/lib/forge-std/test/StdAssertions.t.sol, dev/contracts/lib/forge-std/lib/ds-test/LICENSE, dev/contracts/lib/forge-std/src/console.sol, dev/contracts/lib/forge-std/src/console2.sol

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

@vercel
Copy link

vercel bot commented May 8, 2023

@Raiden1411 is attempting to deploy a commit to the wagmi Team on Vercel.

A member of the Team first needs to authorize it.

@changeset-bot
Copy link

changeset-bot bot commented May 8, 2023

⚠️ No Changeset found

Latest commit: 1c802ea

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov
Copy link

codecov bot commented May 8, 2023

Codecov Report

Merging #460 (1c802ea) into main (88152e9) will decrease coverage by 3.80%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #460      +/-   ##
==========================================
- Coverage   99.92%   96.13%   -3.80%     
==========================================
  Files         254      236      -18     
  Lines       23688    20823    -2865     
  Branches     1968     1661     -307     
==========================================
- Hits        23671    20018    -3653     
- Misses         17      800     +783     
- Partials        0        5       +5     

see 62 files with indirect coverage changes

@Raiden1411
Copy link
Contributor Author

The changeset bot currently is not able to look other than the root folder for the changeset. Not sure if the PR that fixes that will land.

Related PR

@fubhy
Copy link
Collaborator

fubhy commented May 9, 2023

Mhm, I can see that arktype also uses this pattern. Generally I'd also like to see this as a more widely adopted standard / convention for configuration. Having all that stuff in the root bothers me too, especially with the explosion of tooling & config over the past few years.

However, I am not sure if I like inventing a bunch of crafty tricks & maintaining those and going against the flow with this. Coming to this repository as a new contributor I'd likely find it harder to navigate things & find which config is coming from where if it's hidden in an unexpected location.

Now, for the status quo to change and the community eventually settling on a shared config location someone has to be the first mover... Not sure if I'd want us to do that tbh. :-/

@jxom
Copy link
Member

jxom commented May 9, 2023

Generally agree with @fubhy. I like to be more pragmatic with directory structure, etc. Config at the root may look overloaded, but it is most discoverable there.

@Raiden1411
Copy link
Contributor Author

@fubhy, @jxom, I see your points. Will close this PR. Hopefully in the future there is a consensus/better way to organize this.

@tmm
Copy link
Member

tmm commented May 9, 2023

Agree with all these points. Hope it's better supported someday or tools have sensible enough defaults so you don't need to configure them :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants