feat: added support for sort-imports-ignore

[stephdotnet]

Hi,

Thank you for this amazing package. I have been using it on some of my projects. However, recently I needed to ignore the import order for certain specific files.

I encountered this issue: #230 and decided to contribute to the solution.

I chose to follow the basic idea of ignoring the file if a leading comment // sort-imports-ignore is detected (as you mentioned in a previous issue, it is tricky to ignore specific lines, and we will probably need an RFC before diving into it: #26).

I attempted to follow your approach for parsing and formatting the code, which was very interesting by the way, and added the necessary tests.

Please feel free to ask for more if needed, and I will make the appropriate changes.

[d0whc3r]

maybe the string to search for ignore could be in the "constants.ts" file

[stephdotnet]

maybe the string to search for ignore could be in the "constants.ts" file

I actually didn't notice the constants.ts file and i'll add that right the way. Nice catch @d0whc3r

[codemers]

Would really like this feature to! Thanks @stephdotnet

[bdombro]

@ayusharma could you please review this? Seems to be a popular feature request.

[ayusharma]

Looks good to me ❤️ @byara can you please check 🙏

[byara]

Released in v4.3.0

[danielR2001]

@byara I did add // sort-imports-ignore but it still sorts the imports on save (I have prettier on save) 😞
Do I need something else?
this is my prettierrc

{
  "plugins": [
    "@trivago/prettier-plugin-sort-imports"
  ],
  "importOrder": [
    "^@(?!library1|library2)",
    "^[./]"
  ],
  "importOrderSeparation": true,
  "importOrderSortSpecifiers": true,
  "importOrderParserPlugins": [
    "typescript",
    "decorators-legacy"
  ]
}

[TheMikeyRoss]

@byara I did add // sort-imports-ignore but it still sorts the imports on save (I have prettier on save) 😞 Do I need something else? this is my prettierrc

{
  "plugins": [
    "@trivago/prettier-plugin-sort-imports"
  ],
  "importOrder": [
    "^@(?!library1|library2)",
    "^[./]"
  ],
  "importOrderSeparation": true,
  "importOrderSortSpecifiers": true,
  "importOrderParserPlugins": [
    "typescript",
    "decorators-legacy"
  ]
}

Same for me as well,

@danielR2001 Did you manage to resolve it?

[zaaakher]

@TheMikeyRoss @danielR2001 Make sure // sort-imports-ignore is at the very top of the file

[TheMikeyRoss]

@TheMikeyRoss Make sure // sort-imports-ignore is at the very top of the file

Thanks @zaaakher that fixed it for me

[danielR2001]

@TheMikeyRoss @danielR2001 Make sure // sort-imports-ignore is at the very top of the file

Thanks @zaaakher , that fixed for me too!

[qiutian00]

@TheMikeyRoss @danielR2001 Make sure // sort-imports-ignore is at the very top of the file

This works for me.

[farzadmf]

Hey everyone. Is this also supported in jsx files? I have:

{
  "endOfLine": "auto",
  "importOrder": ["^@/(.*)$", "^[./]"],
  "importOrderParserPlugins": ["typescript", "jsx", "decorators-legacy"],
  "importOrderSeparation": true,
  "importOrderSortSpecifiers": true,
  "plugins": ["@trivago/prettier-plugin-sort-imports"],
  "printWidth": 120,
  "proseWrap": "always",
  "semi": true,
  "singleQuote": true,
  "tabWidth": 2,
  "trailingComma": "all"
}

But // sort-imports-ignore doesn't stop anything (even when placed at the top of the file)

EDIT: technically, it's a .tsx file that I'm running prettier on

[farzadmf]

To add to what I wrote above, my "interesting lines" that I don't want to move are for jest:

const myMock = jest.fn();

jest.mock('src/dependency/imported/by/MyModule', () => { /* ... */ });

// import other stuff
// import MyModule (jest.mock call would capture the dpendency here)

// My tests

Now, when imports are sorted, obviously, jest.mock will have no effect. Is there any solution/workaround for this? (I don't want to add the test files to .prettierignore because then I lose all the formatting functionality)