adopt Ava default files glob
#8273
Labels
Comments
turadg
added
enhancement
|
This should only be fixed for agoric-sdk (this issue) in coordination with fixing it for endo (endojs/endo#1913) See #8653 (review) |
This was referenced May 8, 2024
mergify bot
added a commit
that referenced
this issue
May 9, 2024
closes: #8273 ## Description Adds a script to migrate a package's file glob to the Ava defaults. See script docs and #8273 for motivation. It uses https://github.com/google/zx because I was banging my head on Bash options and version inconsistencies. The main thing to review is whether this change is good. Then the code in the first commit. The subsequent commits just are the code running over all the packages. When this PR is approved I'll rebase and re-run the batch to make all the migration commits anew. Once this is in SDK, we can do the same in other Agoric repos. ### Security Considerations n/a ### Scaling Considerations n/a ### Documentation Considerations If anything, less need for documentation because it aligns with how Ava works by default. ### Testing Considerations To run the script yourself, ensure, ``` npm install -g zx ``` ### Upgrade Considerations n/a
|
To be closed in June, when
|
turadg
added a commit
to endojs/endo
that referenced
this issue
May 9, 2024
Refs: Agoric/agoric-sdk#8273 ## Description Akin to Agoric/agoric-sdk#8653 ### Security Considerations none ### Scaling Considerations none ### Documentation Considerations reduces need to document differences ### Testing Considerations CI ### Compatibility Considerations Developers will need to know to make the new files. This globs for both old and new so no tests are accidentally omitted from CI. Agoric/agoric-sdk#8273 will be closed by dropping the custom glob and ensuring no old names remain. ### Upgrade Considerations none
mergify bot
added a commit
that referenced
this issue
May 28, 2024
closes: #8273 ## Description #8653 adopted the new glob but left the old one so any in-flight PRs with new tests wouldn't have them ignored. It's been a month so any should be migrated by now. This removes the old glob. It doesn't remove the `"files"` option entirely, because the default glob is everything under `test` and we have files there that aren't tests. Ava warns they're not tests and and eslint errors when tests import from them. We could go fully to the default glob by using an underscore prefixes on files in `test` that aren't tests. I don't think we need to do that. This change already meets the goal of matching the DX of Ava in other repos. (Test filenames are indicated by a `.test.js` suffix) ### Security Considerations n/a ### Scaling Considerations n/a ### Documentation Considerations reduces need to document ### Testing Considerations no older test files in master (`find packages -name 'test-*' |grep 'test/'`) ### Upgrade Considerations n/a
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What is the Problem Being Solved?
Our
package.jsonhas an"ava":section that configures a custom"files"glob. There are two problems with this:yarn test test/test-something.js. With Ava's default it would beyarn test test/something.test.jsand typing the "so" can autocomplete.Description of the Design
Remove all the custom globs.
Rename test files to
.test.js.Security Considerations
none
Scaling Considerations
none
Test Plan
Before closing this ticket, check that all open PRs don't have new test files that would be ignored upon merge.
Upgrade Considerations
none
The text was updated successfully, but these errors were encountered: