Restructure project

[mattphillips]

What

• Move predicate contents into matcher file
• Delete predicate tests in favour of matcher tests
• Move matcher tests to test/matchers/[matcher].js
• Move match from src/matchers/[matcher]/index.js to src/matchers/[matcher].js
• Inline messages into matcher body to remove passing this.utils around.

Why

This will simplify the codebase and we be closer to Typescript structured projects as I'd like to migrate to TS once this change is in.

Notes

• Although I've deleted all predicate.test.js files coverage is still 100% and none of the snapshots have changed so I'm confident that everything is working as it was before.

Housekeeping

• Unit tests
• Documentation is up to date
• No additional lint warnings
• Typescript definitions are added/updated where relevant

[igorwessel]

If you need any help either here or in the ts part, I'm available.

[codecov]

Codecov Report

Merging #410 (06c8051) into main (e52cd5d) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##              main      #410    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files          137        71    -66     
  Lines          853       575   -278     
  Branches       143       146     +3     
==========================================
- Hits           853       575   -278     

Impacted Files	Coverage Δ
src/utils/print.js	100.00% <ø> (ø)
src/matchers/fail.js	100.00% <100.00%> (ø)
src/matchers/pass.js	100.00% <100.00%> (ø)
src/matchers/toBeAfter.js	100.00% <100.00%> (ø)
src/matchers/toBeAfterOrEqualTo.js	100.00% <100.00%> (ø)
src/matchers/toBeArray.js	100.00% <100.00%> (ø)
src/matchers/toBeArrayOfSize.js	100.00% <100.00%> (ø)
src/matchers/toBeBefore.js	100.00% <100.00%> (ø)
src/matchers/toBeBeforeOrEqualTo.js	100.00% <100.00%> (ø)
src/matchers/toBeBetween.js	100.00% <100.00%> (ø)
... and 61 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e52cd5d...06c8051. Read the comment docs.

[mattphillips]

@igorwessel thanks for the offer I think this PR is sorted now but will deffo take you up on the TS offer. I'll also try to go over the TS issue you raised in the next few days when I get some time 😊

[keeganwitt]

Do we want to continue having JSDoc on the new functions?

[SimenB]

why do we want this? seems likely to only cause confusion for most tools

[mattphillips]

So that we can import from src in the test files as src/ and test/ are at the same level in the directory instead of having to add ../.. to all imports.

[SimenB]

right, but is avoiding ../ worth breaking "go to definition" etc?

I don't really have a strong opinion here (nor ownership 😀) but in the same way removing the import.all macro makes things not require specific tooling I don't think configuring the resolver of jest and eslint (and later typescript I assume) keeps the code base as approachable as possible.

(if we want something like this, we should use https://nodejs.org/api/packages.html#subpath-imports or something that has an actual spec behind it instead of ad hoc config. That said, Jest does not support it (yet)).

---

Again, this is your project, not mine, so feel free to structure it how you want to 🙂 Just putting my opinion out there, because what else is the internet for?

[mattphillips]

Again, this is your project, not mine, so feel free to structure it how you want to 🙂 Just putting my opinion out there, because what else is the internet for?

Love this 😆 your opinions are always welcome!

---

Tbh I setup all of my Typescript projects with the ability to import from src to make it easy to do absolute imports and move stuff around. With vscode at least (when using TS) importing from src doesn't break go to definition, do you know if it does in other editors?

I kind of see this PR as a precursor to switching to TS so hopefully the tooling will be better then.

This all probably stems from my Java days and when I work in Scala and being able to treat directories as packages/namespaces regardless of source set 😝

[SimenB]

I've been writing Rust lately, so I feel this 😀

[keeganwitt]

Do we want to continue having JSDoc on the new functions?

Actually, only toContainAnyValues/predicate.ts and toBeArrayOfSize/predicate.ts had JSDoc (besides index.d.ts), so we don't need to worry about that. I just randomly happened to look at one of those two that had it.