refactor: rename itemA/itemB to source/target

[ricokahler]

This PR performs a straightforward but important refactoring throughout the codebase: renaming the parameters itemA and itemB to source and target respectively.

This change applies to:

• The public diffPatch function.
• Internal functions like diffItem, diffObject, diffArray, diffArrayByIndex, and getDiffMatchPatch (where applicable, though some parts of getDiffMatchPatch already used source/target).
• JSDoc comments and error messages.

Key Changes:

• Parameter Renaming:
  • In diffPatch(itemA, itemB, ...) is now diffPatch(source, target, ...).
  • In diffItem(itemA, itemB, ...) is now diffItem(source, target, ...).
  • Similar renames in diffObject and diffArray.
  • The JSDoc for getDiffMatchPatch already used source/target, but internal variable names like itemA/itemB were updated where they existed.
• Documentation and Error Message Updates:
  • JSDoc @param tags updated to reflect the new names (e.g., @param source - The first document/tree to compare).
  • Error messages updated, for example, the ID mismatch error now reads _id on source and target not present or differs....

Rationale:

• Semantic Clarity: source and target are more descriptive and standard terms for diffing operations, clearly indicating the initial state and the desired final state.
• Consistency: Aligns the parameter naming with common conventions in diffing libraries and algorithms.
• Improved Readability: Makes the code easier to understand at a glance, as the role of each parameter is more immediately obvious.

This is primarily a cosmetic and semantic improvement that enhances code clarity and maintainability without altering the core diffing logic. All tests continue to pass.

[ricokahler]

• docs: overhaul README for v6 with API reference and collaborative editing focus #45
• refactor: rename itemA/itemB to source/target #44 👈 (View in Graphite)
• refactor: simplify diffItem control flow #43
• feat: add key-based reordering support for keyed object arrays #41
• refactor: preserve order in patch serialization #42 : 1 other dependent PR (#40 )
• feat!: replace diffItem with diffValue #39
• feat!: remove undefined-to-null conversion warnings and simplify internal APIs #38
• refactor: simplify array unset logic by removing revision lock check #37
• feat!: replace configurable DMP with perf-based heuristics #36
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[ricokahler]

Merge activity

• Jun 13, 7:57 PM UTC: @ricokahler merged this pull request with Graphite.