feat(sort-imports) add support for new groups and customGroups API

[hugop95]

• Resolves Feature: path aware import sorting #509.
• Related to the following issues:
  • Question: Sorting named and default imports within the group #494.
  • Feature: subpath imports #510.

Description

We are finally migrating sort-imports to the new customGroups API with selectors and modifiers.
This PR only focuses on the migration to the new API. The old API is still supported.

Here is the list of selectors and modifiers:

Modifiers

• type: matches type imports.

Selectors

Ordered from most important to least important (it is the same order as the predefined groups today).

• index-type (ℹ️ deprecated for the type modifier with index selector)
• sibling-type (ℹ️ deprecated, same as above)
• parent-type (ℹ️ deprecated, same as above)
• internal-type (ℹ️ deprecated, same as above)
• builtin-type (ℹ️ deprecated, same as above)
• external-type (ℹ️ deprecated, same as above)
• type (not marked as deprecated, as it can be useful to quickly aggregate all types at the same place)
• side-effect-style
• side-effect
• style
• index
• sibling
• parent
• internal
• builtin
• external

Important

The object group was never matched, so it has been deprecated (but is still allowed in groups for backward compatibility).
See the code before the refactor to check that the object group was never defined. It can be re-added and implemented later if needed.

customGroups option

Supports elementNamePattern.

Follow-up improvements

• Update the default options to use the new generated groups (feat(sort-imports): update default groups to new API #511).
• Add additional selectors and modifiers (feat(sort-imports): add subpath, tsconfig-path selectors and 5 modifiers #512)

What is the purpose of this pull request?

• New Feature

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f790779) to head (9fea396).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #505   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           96        97    +1     
  Lines         7764      7857   +93     
  Branches      1563      1576   +13     
=========================================
+ Hits          7764      7857   +93     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[azat-io]

Hi @hugop95! Thanks for this PR that adds a new API for sort-imports.

This PR looks good. 👍

[azat-io]

Perhaps we can simplify the code of this function and make it more declarative?

let isPredefinedGroup = (
  allSelectors: string[],
  allModifiers: string[],
  input: string,
): boolean => {
  if (input === 'unknown') {
    return true
  }
  
  let parts = input.split('-')
  if (parts.length === 0) {
    return false
  }
  
  let possibleSelectors = [
    { selector: parts.slice(-3).join('-'), wordCount: 3 },
    { selector: parts.slice(-2).join('-'), wordCount: 2 },
    { selector: parts.slice(-1)[0], wordCount: 1 }
  ].filter(({ selector, wordCount }) => 
    allSelectors.includes(selector) && parts.length >= wordCount
  )
  
  if (possibleSelectors.length === 0) {
    return false
  }
  
  let { wordCount } = possibleSelectors[0]
  
  let modifiers = parts.slice(0, -wordCount)
  
  return (
    new Set(modifiers).size === modifiers.length &&
    modifiers.every(modifier => allModifiers.includes(modifier))
  )
}

[hugop95]

@azat-io Thank you, it's more readable indeed!

9fea396 (#505)