feat(sort-objects): Adds ignore rule for objects passed as arguments to function calls

[hugop95]

Resolves #413

Changes

• Adds a useConfigurationIf.callingFunctionNamePattern option to sort-objects. Object that are not parameters of a function will not be matched by configurations using this option.
• Allows users to enter unsorted as type.

Example configuration:

{
  'perfectionist/sort-objects': [
    'error',
    {
      type: 'unsorted', // Don't sort objects passed to createSlice
      useConfigurationIf: {
        callingFunctionNamePattern: '^createSlice$',
      },
    },
    {
      type: 'alphabetical' // Fallback configuration
    }
  ],
}

What is the purpose of this pull request?

• New Feature

[azat-io]

What do you think of the name 'no-sort' or 'preserve-order'? Or do you prefer 'unsorted'?

[hugop95]

@azat-io

• I prefer unsorted and no-sort over preserve-order (I feel the first two are more explicit).
• unsorted is already used in customGroups.
  

  eslint-plugin-perfectionist/rules/sort-classes.types.ts

  Lines 205 to 216 in 7fdadd7

  	type CustomGroup = (
  	| {
  	order?: SortClassesOptions[0]['order']
  	type?: SortClassesOptions[0]['type']
  	}
  	| {
  	type?: 'unsorted'
  	}
  	) &
  	(SingleCustomGroup | AnyOfCustomGroup) & {
  	groupName: string
  	}

I think it's better for consistency to keep the same name, so I would personally pick unsorted.

[azat-io]

Okay, thank you 👍

[azat-io]

Do I understand correctly that we should remove the sort-objects scope from commit?

[hugop95]

Do I understand correctly that we should remove the sort-objects scope from commit?

Sorry, I'm not sure to understand! What do you mean?

[azat-io]

@hugop95 You added scope in commit message feat(sort-objects)

[hugop95]

@azat-io you can remove it you want, the PR does affects other rules as well (by adding the type: unsorted to some other rules too)