fix: fixes overlapping errors between newlinesBetween and comment-after fixes

[hugop95]

Related issue: #11
Related comment: #11 (comment)

Description

Note: good news! I've managed to find a way to fix this without impacting any existing test 🙂

In some specific cases, comments-related fixes and newline fixes may overlap.

Example

type Test = {
  onAdd: () => void;
  title: string; // The fix related to this comment will overlap with newline fixes

  onClick: () => void; 
};

'perfectionist/sort-object-types': [
  'error',
  {
    type: 'natural',
    groups: [
      'property',
      'required-method',
    ],
    newlinesBetween: 'always',
  },
]

Today, both comment/order fixes and newlines fixes are done in the same cycle. The easiest fix is to separate those fixes into a different cycle (see below).

Proposal

The PR includes a refactor part and a simple fix that aims to separate the "comments after" fixes and the newlines fixes. "comments after" fixes are fixes related to comments appearing at the end of lines, after nodes.

State today

• makeFixes handles:
  • Order-related fixes.
  • Comments after fixes.
• makeNewlinesFixes handles only newline fixes.

Commits split

The refactor commits (first 5 commits) rename and split existing functions into new functions in order to separate each type of fixes independently.

This allows us in the end to do

  let orderFixes = makeOrderFixes({...})

  let commentAfterFixes = makeCommentAfterFixes({...})
  if (commentAfterFixes.length) {
    return [...orderFixes, ...commentAfterFixes]
  }

  let newlinesFixes = makeNewlinesFixes({...})
  return [...orderFixes, ...newlinesFixes]

What is the purpose of this pull request?

• Bug fix

[azat-io]

Looks good. I am a bit confused by the long function names. And I want to take some time to think if it can be made a bit simpler.

[hugop95]

@azat-io I've simplified things in these two commits:

• 8732a40
• ce18e18

The remaining fixes functions are

• makeAllFixes
• makeNewlinesFixes
• makeCommentAfterFixes
• makeOrderFixes

[azat-io]

Why not makeFixes?

[hugop95]

@azat-io Renamed in ee1f5eb.