Remove cycle in printDiffs, diffLines and joinAlignedDiffs

[raymondnumbergenerator]

Summary

The jest-diff package has three files with cyclical dependencies. This makes the logic more confusing to follow and the distinction between files less clear. Several helper functions that should be private are also needed to be exported because of the cycles.

• formatTrailingSpaces, printDiffLine, printDeleteLine, printInsertLine, printCommonLine and createPatchMark are moved from printDiffs to joinAlignedDiffs and made private.
• hasCommonDiff in printDiffs is made private.
• countChanges and printAnnotation are moved from printDiffs to diffLines and made private.
• printDiffLines is moved from printDiffs to diffLines and exported there, imports are changed to reflect this.

Test plan

No new tests added, passes existing tests with yarn test.

I ran madge --circular to demonstrate that the cycles are gone.

Madge output before:

» madge --circular --extensions ts packages/jest-diff
Processed 24 files (453ms) (7 warnings)

✖ Found 2 circular dependencies!

1) src/diffLines.ts > src/printDiffs.ts
2) src/printDiffs.ts > src/joinAlignedDiffs.ts

Madge output after:

» madge --circular --extensions ts packages/jest-diff
Processed 24 files (449ms) (7 warnings)

✔ No circular dependency found!

[facebook-github-bot]

Hi @raymondnumbergenerator!

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.

In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

[SimenB]

Thanks! could you add a changelog entry as well? just in case 🙂

[SimenB]

Thanks @raymondnumbergenerator! Could you sign the CLA? Then I can merge 🙂

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

[SimenB]

Thanks!

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.