Feature: Allow Explicit Separator after Top-of-file-comments #92

fbartho · 2023-05-17T20:31:31Z

Primarily, this makes it possible for people to declare that there should be a gap after top-of-file-comments (before other imports).

Additionally:

Centralizes plugin options parsing so it only happens once
I think it fixes a regression that was introduced in 4.0.0-alpha.? around tests/ImportsSeparatedIntoSideEffectGroups
Cleans up some more trailing commas in the readme-json-options

Also fixes a regression in tests/ImportsSeparatedIntoSideEffectGroups!

README.md

src/utils/normalize-plugin-options.ts

IanVS

Still going through it, but wanted to leave a few comments as I go.

src/types.ts

src/utils/normalize-plugin-options.ts

src/utils/get-sorted-nodes-by-import-order.ts

README.md

tests/ImportsSeparatedIntoSideEffectGroups/__snapshots__/ppsi.spec.ts.snap

src/utils/__tests__/remove-nodes-from-original-code.spec.ts

IanVS · 2023-05-17T22:47:04Z

src/utils/__tests__/get-sorted-nodes-by-import-order.spec.ts

@@ -179,8 +182,13 @@ test('it returns all sorted nodes with builtin specifiers at the top', () => {
 test('it returns all sorted nodes with custom third party modules and builtins at top', () => {
    const result = getImportNodes(code);
    const sorted = getSortedNodesByImportOrder(result, {
-        importOrder: ['^a$', '<THIRD_PARTY_MODULES>', '^t$', '^k$', '^[./]'],
-        importOrderCombineTypeAndValueImports: true,


I think this is lost if we don't specify a importOrderTypeScriptVersion, right? I don't think you meant to change that behavior in this test.

Edit: Maybe it's fine because that only applies to typescript files, and we weren't actually combining anything in these tests? (I didn't look)

README.md

tests/ImportsSeparatedIntoSideEffectGroups/__snapshots__/ppsi.spec.ts.snap

src/types.ts

IanVS

OK I think I'm on board with this, and don't have further comments. Let me know when you'd like me to take another look.

src/utils/get-comment-registry.ts

Created as a separate PR to review if I'm missing anything --------- Co-authored-by: Ian VanSchooten <ian.vanschooten@gmail.com>

docs/MIGRATION.md

…#156) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@ianvs/prettier-plugin-sort-imports](https://togithub.com/ianvs/prettier-plugin-sort-imports) | [`^3.7.2` -> `^4.0.0`](https://renovatebot.com/diffs/npm/@ianvs%2fprettier-plugin-sort-imports/3.7.2/4.0.0) | [![age](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/compatibility-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/confidence-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>ianvs/prettier-plugin-sort-imports</summary> ### [`v4.0.0`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.0) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v3.7.2...v4.0.0) #### What's Changed This new release focuses on simplifying the plugin options, shipping more useful defaults, handling comments around import statements more reliably, and improving Vue and TypeScript compatibility. We also are targeting Node 16 syntax with our build, though older versions may continue to work (untested). See the full [migration guide](https://togithub.com/IanVS/prettier-plugin-sort-imports/blob/next/docs/MIGRATION.md#migrating-from-v3xx-to-v4xx) for details of the breaking changes. ##### ⬆️ Breaking Changes - Build for Node 16+ ([IanVS/prettier-plugin-sort-imports#59) - Remove `importOrderBuiltinModulesToTop` (always true) ([IanVS/prettier-plugin-sort-imports#60) - Remove `importOrderSeparation` option ([IanVS/prettier-plugin-sort-imports#62) - Remove `importOrderCaseInsensitive` option ([IanVS/prettier-plugin-sort-imports#63) - Remove `importOrderGroupNamespaceSpecifiers` option ([IanVS/prettier-plugin-sort-imports#64) - Remove `importOrderSortSpecifiers` option ([IanVS/prettier-plugin-sort-imports#65) - Remove `importOrderMergeDuplicateImports` option (always on) ([IanVS/prettier-plugin-sort-imports#66) - Replace `importOrderCombineTypeAndValueImports` with `importOrderTypeScriptVersion` ([IanVS/prettier-plugin-sort-imports#67) - Improve default sort order ([IanVS/prettier-plugin-sort-imports#83) ##### 🐛 Bug Fixes - Fix behavior around comments embedded in imports ([IanVS/prettier-plugin-sort-imports#71) - Preserve trailing comments on specifiers ([IanVS/prettier-plugin-sort-imports#80) - Preserve comments and blank lines at top-of-file (in [IanVS/prettier-plugin-sort-imports#82) - Prevent comment gap when re-arranging first import ([IanVS/prettier-plugin-sort-imports#85) - Fix: Top-of-file Comments get duplicated when moving runtime code ([IanVS/prettier-plugin-sort-imports#88) - Vue: Sort both script and setup script ([IanVS/prettier-plugin-sort-imports#90) - Vue and TypeScript: Use correct parser plugins ([IanVS/prettier-plugin-sort-imports#91) ##### ⚡️ Features - Add `<BUILTIN_MODULES>` Special Word ([IanVS/prettier-plugin-sort-imports#86) - Allow Explicit Separator after Top-of-file-comments ([IanVS/prettier-plugin-sort-imports#92) - Support babel-ts parser ([IanVS/prettier-plugin-sort-imports#97) ##### 🛠️ Repo Maintenance - Update dependencies, jest -> vitest ([IanVS/prettier-plugin-sort-imports#59) - Check formatting in CI ([IanVS/prettier-plugin-sort-imports#61) - Update to latest versions of Github Actions ([IanVS/prettier-plugin-sort-imports#73) - Add some more tests for comments ([IanVS/prettier-plugin-sort-imports#77) ##### 🧳 Dependencies - Drop javascript-natural-sort dependency ([IanVS/prettier-plugin-sort-imports#28) - Drop lodash.clone dependency ([IanVS/prettier-plugin-sort-imports#74) - Upgrade Babel to 7.21 ([IanVS/prettier-plugin-sort-imports#72) **Full Changelog**: IanVS/prettier-plugin-sort-imports@v3.7.2...v4.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 12am and before 5am every weekday,every weekend" in timezone Asia/Kolkata, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/timelessco/browser-js-library-template).

…#109) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@ianvs/prettier-plugin-sort-imports](https://togithub.com/ianvs/prettier-plugin-sort-imports) | [`^3.7.2` -> `^4.0.0`](https://renovatebot.com/diffs/npm/@ianvs%2fprettier-plugin-sort-imports/3.7.2/4.0.0) | [![age](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/compatibility-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/confidence-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>ianvs/prettier-plugin-sort-imports</summary> ### [`v4.0.0`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.0) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v3.7.2...v4.0.0) #### What's Changed This new release focuses on simplifying the plugin options, shipping more useful defaults, handling comments around import statements more reliably, and improving Vue and TypeScript compatibility. We also are targeting Node 16 syntax with our build, though older versions may continue to work (untested). See the full [migration guide](https://togithub.com/IanVS/prettier-plugin-sort-imports/blob/next/docs/MIGRATION.md#migrating-from-v3xx-to-v4xx) for details of the breaking changes. ##### ⬆️ Breaking Changes - Build for Node 16+ ([IanVS/prettier-plugin-sort-imports#59) - Remove `importOrderBuiltinModulesToTop` (always true) ([IanVS/prettier-plugin-sort-imports#60) - Remove `importOrderSeparation` option ([IanVS/prettier-plugin-sort-imports#62) - Remove `importOrderCaseInsensitive` option ([IanVS/prettier-plugin-sort-imports#63) - Remove `importOrderGroupNamespaceSpecifiers` option ([IanVS/prettier-plugin-sort-imports#64) - Remove `importOrderSortSpecifiers` option ([IanVS/prettier-plugin-sort-imports#65) - Remove `importOrderMergeDuplicateImports` option (always on) ([IanVS/prettier-plugin-sort-imports#66) - Replace `importOrderCombineTypeAndValueImports` with `importOrderTypeScriptVersion` ([IanVS/prettier-plugin-sort-imports#67) - Improve default sort order ([IanVS/prettier-plugin-sort-imports#83) ##### 🐛 Bug Fixes - Fix behavior around comments embedded in imports ([IanVS/prettier-plugin-sort-imports#71) - Preserve trailing comments on specifiers ([IanVS/prettier-plugin-sort-imports#80) - Preserve comments and blank lines at top-of-file (in [IanVS/prettier-plugin-sort-imports#82) - Prevent comment gap when re-arranging first import ([IanVS/prettier-plugin-sort-imports#85) - Fix: Top-of-file Comments get duplicated when moving runtime code ([IanVS/prettier-plugin-sort-imports#88) - Vue: Sort both script and setup script ([IanVS/prettier-plugin-sort-imports#90) - Vue and TypeScript: Use correct parser plugins ([IanVS/prettier-plugin-sort-imports#91) ##### ⚡️ Features - Add `<BUILTIN_MODULES>` Special Word ([IanVS/prettier-plugin-sort-imports#86) - Allow Explicit Separator after Top-of-file-comments ([IanVS/prettier-plugin-sort-imports#92) - Support babel-ts parser ([IanVS/prettier-plugin-sort-imports#97) ##### 🛠️ Repo Maintenance - Update dependencies, jest -> vitest ([IanVS/prettier-plugin-sort-imports#59) - Check formatting in CI ([IanVS/prettier-plugin-sort-imports#61) - Update to latest versions of Github Actions ([IanVS/prettier-plugin-sort-imports#73) - Add some more tests for comments ([IanVS/prettier-plugin-sort-imports#77) ##### 🧳 Dependencies - Drop javascript-natural-sort dependency ([IanVS/prettier-plugin-sort-imports#28) - Drop lodash.clone dependency ([IanVS/prettier-plugin-sort-imports#74) - Upgrade Babel to 7.21 ([IanVS/prettier-plugin-sort-imports#72) **Full Changelog**: IanVS/prettier-plugin-sort-imports@v3.7.2...v4.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 12am and before 5am every weekday,every weekend" in timezone Asia/Kolkata, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/timelessco/browser-js-website-template).

…#122) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@ianvs/prettier-plugin-sort-imports](https://togithub.com/ianvs/prettier-plugin-sort-imports) | [`^3.7.2` -> `^4.0.0`](https://renovatebot.com/diffs/npm/@ianvs%2fprettier-plugin-sort-imports/3.7.2/4.0.0) | [![age](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/compatibility-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/confidence-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>ianvs/prettier-plugin-sort-imports</summary> ### [`v4.0.0`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.0) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v3.7.2...v4.0.0) #### What's Changed This new release focuses on simplifying the plugin options, shipping more useful defaults, handling comments around import statements more reliably, and improving Vue and TypeScript compatibility. We also are targeting Node 16 syntax with our build, though older versions may continue to work (untested). See the full [migration guide](https://togithub.com/IanVS/prettier-plugin-sort-imports/blob/next/docs/MIGRATION.md#migrating-from-v3xx-to-v4xx) for details of the breaking changes. ##### ⬆️ Breaking Changes - Build for Node 16+ ([IanVS/prettier-plugin-sort-imports#59) - Remove `importOrderBuiltinModulesToTop` (always true) ([IanVS/prettier-plugin-sort-imports#60) - Remove `importOrderSeparation` option ([IanVS/prettier-plugin-sort-imports#62) - Remove `importOrderCaseInsensitive` option ([IanVS/prettier-plugin-sort-imports#63) - Remove `importOrderGroupNamespaceSpecifiers` option ([IanVS/prettier-plugin-sort-imports#64) - Remove `importOrderSortSpecifiers` option ([IanVS/prettier-plugin-sort-imports#65) - Remove `importOrderMergeDuplicateImports` option (always on) ([IanVS/prettier-plugin-sort-imports#66) - Replace `importOrderCombineTypeAndValueImports` with `importOrderTypeScriptVersion` ([IanVS/prettier-plugin-sort-imports#67) - Improve default sort order ([IanVS/prettier-plugin-sort-imports#83) ##### 🐛 Bug Fixes - Fix behavior around comments embedded in imports ([IanVS/prettier-plugin-sort-imports#71) - Preserve trailing comments on specifiers ([IanVS/prettier-plugin-sort-imports#80) - Preserve comments and blank lines at top-of-file (in [IanVS/prettier-plugin-sort-imports#82) - Prevent comment gap when re-arranging first import ([IanVS/prettier-plugin-sort-imports#85) - Fix: Top-of-file Comments get duplicated when moving runtime code ([IanVS/prettier-plugin-sort-imports#88) - Vue: Sort both script and setup script ([IanVS/prettier-plugin-sort-imports#90) - Vue and TypeScript: Use correct parser plugins ([IanVS/prettier-plugin-sort-imports#91) ##### ⚡️ Features - Add `<BUILTIN_MODULES>` Special Word ([IanVS/prettier-plugin-sort-imports#86) - Allow Explicit Separator after Top-of-file-comments ([IanVS/prettier-plugin-sort-imports#92) - Support babel-ts parser ([IanVS/prettier-plugin-sort-imports#97) ##### 🛠️ Repo Maintenance - Update dependencies, jest -> vitest ([IanVS/prettier-plugin-sort-imports#59) - Check formatting in CI ([IanVS/prettier-plugin-sort-imports#61) - Update to latest versions of Github Actions ([IanVS/prettier-plugin-sort-imports#73) - Add some more tests for comments ([IanVS/prettier-plugin-sort-imports#77) ##### 🧳 Dependencies - Drop javascript-natural-sort dependency ([IanVS/prettier-plugin-sort-imports#28) - Drop lodash.clone dependency ([IanVS/prettier-plugin-sort-imports#74) - Upgrade Babel to 7.21 ([IanVS/prettier-plugin-sort-imports#72) **Full Changelog**: IanVS/prettier-plugin-sort-imports@v3.7.2...v4.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 12am and before 5am every weekday,every weekend" in timezone Asia/Kolkata, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/timelessco/js-bottomsheet).

…#79) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@ianvs/prettier-plugin-sort-imports](https://togithub.com/ianvs/prettier-plugin-sort-imports) | [`3.7.2` -> `4.0.0`](https://renovatebot.com/diffs/npm/@ianvs%2fprettier-plugin-sort-imports/3.7.2/4.0.0) | [![age](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/compatibility-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.0/confidence-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>ianvs/prettier-plugin-sort-imports</summary> ### [`v4.0.0`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.0) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v3.7.2...v4.0.0) #### What's Changed This new release focuses on simplifying the plugin options, shipping more useful defaults, handling comments around import statements more reliably, and improving Vue and TypeScript compatibility. We also are targeting Node 16 syntax with our build, though older versions may continue to work (untested). See the full [migration guide](https://togithub.com/IanVS/prettier-plugin-sort-imports/blob/next/docs/MIGRATION.md#migrating-from-v3xx-to-v4xx) for details of the breaking changes. ##### ⬆️ Breaking Changes - Build for Node 16+ ([IanVS/prettier-plugin-sort-imports#59) - Remove `importOrderBuiltinModulesToTop` (always true) ([IanVS/prettier-plugin-sort-imports#60) - Remove `importOrderSeparation` option ([IanVS/prettier-plugin-sort-imports#62) - Remove `importOrderCaseInsensitive` option ([IanVS/prettier-plugin-sort-imports#63) - Remove `importOrderGroupNamespaceSpecifiers` option ([IanVS/prettier-plugin-sort-imports#64) - Remove `importOrderSortSpecifiers` option ([IanVS/prettier-plugin-sort-imports#65) - Remove `importOrderMergeDuplicateImports` option (always on) ([IanVS/prettier-plugin-sort-imports#66) - Replace `importOrderCombineTypeAndValueImports` with `importOrderTypeScriptVersion` ([IanVS/prettier-plugin-sort-imports#67) - Improve default sort order ([IanVS/prettier-plugin-sort-imports#83) ##### 🐛 Bug Fixes - Fix behavior around comments embedded in imports ([IanVS/prettier-plugin-sort-imports#71) - Preserve trailing comments on specifiers ([IanVS/prettier-plugin-sort-imports#80) - Preserve comments and blank lines at top-of-file (in [IanVS/prettier-plugin-sort-imports#82) - Prevent comment gap when re-arranging first import ([IanVS/prettier-plugin-sort-imports#85) - Fix: Top-of-file Comments get duplicated when moving runtime code ([IanVS/prettier-plugin-sort-imports#88) - Vue: Sort both script and setup script ([IanVS/prettier-plugin-sort-imports#90) - Vue and TypeScript: Use correct parser plugins ([IanVS/prettier-plugin-sort-imports#91) ##### ⚡️ Features - Add `<BUILTIN_MODULES>` Special Word ([IanVS/prettier-plugin-sort-imports#86) - Allow Explicit Separator after Top-of-file-comments ([IanVS/prettier-plugin-sort-imports#92) - Support babel-ts parser ([IanVS/prettier-plugin-sort-imports#97) ##### 🛠️ Repo Maintenance - Update dependencies, jest -> vitest ([IanVS/prettier-plugin-sort-imports#59) - Check formatting in CI ([IanVS/prettier-plugin-sort-imports#61) - Update to latest versions of Github Actions ([IanVS/prettier-plugin-sort-imports#73) - Add some more tests for comments ([IanVS/prettier-plugin-sort-imports#77) ##### 🧳 Dependencies - Drop javascript-natural-sort dependency ([IanVS/prettier-plugin-sort-imports#28) - Drop lodash.clone dependency ([IanVS/prettier-plugin-sort-imports#74) - Upgrade Babel to 7.21 ([IanVS/prettier-plugin-sort-imports#72) **Full Changelog**: IanVS/prettier-plugin-sort-imports@v3.7.2...v4.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 12am and before 5am on saturday" in timezone Asia/Kolkata, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/timelessco/node-ts-library-template).

…#71) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@ianvs/prettier-plugin-sort-imports](https://togithub.com/ianvs/prettier-plugin-sort-imports) | [`3.7.2` -> `4.0.2`](https://renovatebot.com/diffs/npm/@ianvs%2fprettier-plugin-sort-imports/3.7.2/4.0.2) | [![age](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.2/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.2/compatibility-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.2/confidence-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>ianvs/prettier-plugin-sort-imports</summary> ### [`v4.0.2`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.2) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v4.0.1...v4.0.2) #### What's Changed - Account for missing filepath by [@IanVS](https://togithub.com/IanVS) in [IanVS/prettier-plugin-sort-imports#104 **Full Changelog**: IanVS/prettier-plugin-sort-imports@v4.0.1...v4.0.2 ### [`v4.0.1`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.1) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v4.0.0...v4.0.1) #### What's Changed - Fix cli in Install section by [@torn4dom4n](https://togithub.com/torn4dom4n) in [IanVS/prettier-plugin-sort-imports#99 - Fix dollar sign ($) issue in Vue SFC by [@istiak-tridip](https://togithub.com/istiak-tridip) in [IanVS/prettier-plugin-sort-imports#101 #### New Contributors - [@torn4dom4n](https://togithub.com/torn4dom4n) made their first contribution in [IanVS/prettier-plugin-sort-imports#99 - [@istiak-tridip](https://togithub.com/istiak-tridip) made their first contribution in [IanVS/prettier-plugin-sort-imports#101 **Full Changelog**: IanVS/prettier-plugin-sort-imports@v4.0.0...v4.0.1 ### [`v4.0.0`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.0) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v3.7.2...v4.0.0) #### What's Changed This new release focuses on simplifying the plugin options, shipping more useful defaults, handling comments around import statements more reliably, and improving Vue and TypeScript compatibility. We also are targeting Node 16 syntax with our build, though older versions may continue to work (untested). See the full [migration guide](https://togithub.com/IanVS/prettier-plugin-sort-imports/blob/next/docs/MIGRATION.md#migrating-from-v3xx-to-v4xx) for details of the breaking changes. ##### ⬆️ Breaking Changes - Build for Node 16+ ([IanVS/prettier-plugin-sort-imports#59) - Remove `importOrderBuiltinModulesToTop` (always true) ([IanVS/prettier-plugin-sort-imports#60) - Remove `importOrderSeparation` option ([IanVS/prettier-plugin-sort-imports#62) - Remove `importOrderCaseInsensitive` option ([IanVS/prettier-plugin-sort-imports#63) - Remove `importOrderGroupNamespaceSpecifiers` option ([IanVS/prettier-plugin-sort-imports#64) - Remove `importOrderSortSpecifiers` option ([IanVS/prettier-plugin-sort-imports#65) - Remove `importOrderMergeDuplicateImports` option (always on) ([IanVS/prettier-plugin-sort-imports#66) - Replace `importOrderCombineTypeAndValueImports` with `importOrderTypeScriptVersion` ([IanVS/prettier-plugin-sort-imports#67) - Improve default sort order ([IanVS/prettier-plugin-sort-imports#83) ##### 🐛 Bug Fixes - Fix behavior around comments embedded in imports ([IanVS/prettier-plugin-sort-imports#71) - Preserve trailing comments on specifiers ([IanVS/prettier-plugin-sort-imports#80) - Preserve comments and blank lines at top-of-file (in [IanVS/prettier-plugin-sort-imports#82) - Prevent comment gap when re-arranging first import ([IanVS/prettier-plugin-sort-imports#85) - Fix: Top-of-file Comments get duplicated when moving runtime code ([IanVS/prettier-plugin-sort-imports#88) - Vue: Sort both script and setup script ([IanVS/prettier-plugin-sort-imports#90) - Vue and TypeScript: Use correct parser plugins ([IanVS/prettier-plugin-sort-imports#91) ##### ⚡️ Features - Add `<BUILTIN_MODULES>` Special Word ([IanVS/prettier-plugin-sort-imports#86) - Allow Explicit Separator after Top-of-file-comments ([IanVS/prettier-plugin-sort-imports#92) - Support babel-ts parser ([IanVS/prettier-plugin-sort-imports#97) ##### 🛠️ Repo Maintenance - Update dependencies, jest -> vitest ([IanVS/prettier-plugin-sort-imports#59) - Check formatting in CI ([IanVS/prettier-plugin-sort-imports#61) - Update to latest versions of Github Actions ([IanVS/prettier-plugin-sort-imports#73) - Add some more tests for comments ([IanVS/prettier-plugin-sort-imports#77) ##### 🧳 Dependencies - Drop javascript-natural-sort dependency ([IanVS/prettier-plugin-sort-imports#28) - Drop lodash.clone dependency ([IanVS/prettier-plugin-sort-imports#74) - Upgrade Babel to 7.21 ([IanVS/prettier-plugin-sort-imports#72) **Full Changelog**: IanVS/prettier-plugin-sort-imports@v3.7.2...v4.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 12am and before 5am on saturday" in timezone Asia/Kolkata, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/timelessco/node-js-library-template).

…#36) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@ianvs/prettier-plugin-sort-imports](https://togithub.com/ianvs/prettier-plugin-sort-imports) | [`3.7.2` -> `4.0.2`](https://renovatebot.com/diffs/npm/@ianvs%2fprettier-plugin-sort-imports/3.7.2/4.0.2) | [![age](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.2/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.2/compatibility-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.2/confidence-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>ianvs/prettier-plugin-sort-imports</summary> ### [`v4.0.2`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.2) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v4.0.1...v4.0.2) #### What's Changed - Account for missing filepath by [@IanVS](https://togithub.com/IanVS) in [IanVS/prettier-plugin-sort-imports#104 **Full Changelog**: IanVS/prettier-plugin-sort-imports@v4.0.1...v4.0.2 ### [`v4.0.1`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.1) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v4.0.0...v4.0.1) #### What's Changed - Fix cli in Install section by [@torn4dom4n](https://togithub.com/torn4dom4n) in [IanVS/prettier-plugin-sort-imports#99 - Fix dollar sign ($) issue in Vue SFC by [@istiak-tridip](https://togithub.com/istiak-tridip) in [IanVS/prettier-plugin-sort-imports#101 #### New Contributors - [@torn4dom4n](https://togithub.com/torn4dom4n) made their first contribution in [IanVS/prettier-plugin-sort-imports#99 - [@istiak-tridip](https://togithub.com/istiak-tridip) made their first contribution in [IanVS/prettier-plugin-sort-imports#101 **Full Changelog**: IanVS/prettier-plugin-sort-imports@v4.0.0...v4.0.1 ### [`v4.0.0`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.0) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v3.7.2...v4.0.0) ##### What's Changed This new release focuses on simplifying the plugin options, shipping more useful defaults, handling comments around import statements more reliably, and improving Vue and TypeScript compatibility. We also are targeting Node 16 syntax with our build, though older versions may continue to work (untested). See the full [migration guide](https://togithub.com/IanVS/prettier-plugin-sort-imports/blob/next/docs/MIGRATION.md#migrating-from-v3xx-to-v4xx) for details of the breaking changes. ##### ⬆️ Breaking Changes - Build for Node 16+ ([IanVS/prettier-plugin-sort-imports#59) - Remove `importOrderBuiltinModulesToTop` (always true) ([IanVS/prettier-plugin-sort-imports#60) - Remove `importOrderSeparation` option ([IanVS/prettier-plugin-sort-imports#62) - Remove `importOrderCaseInsensitive` option ([IanVS/prettier-plugin-sort-imports#63) - Remove `importOrderGroupNamespaceSpecifiers` option ([IanVS/prettier-plugin-sort-imports#64) - Remove `importOrderSortSpecifiers` option ([IanVS/prettier-plugin-sort-imports#65) - Remove `importOrderMergeDuplicateImports` option (always on) ([IanVS/prettier-plugin-sort-imports#66) - Replace `importOrderCombineTypeAndValueImports` with `importOrderTypeScriptVersion` ([IanVS/prettier-plugin-sort-imports#67) - Improve default sort order ([IanVS/prettier-plugin-sort-imports#83) ##### 🐛 Bug Fixes - Fix behavior around comments embedded in imports ([IanVS/prettier-plugin-sort-imports#71) - Preserve trailing comments on specifiers ([IanVS/prettier-plugin-sort-imports#80) - Preserve comments and blank lines at top-of-file (in [IanVS/prettier-plugin-sort-imports#82) - Prevent comment gap when re-arranging first import ([IanVS/prettier-plugin-sort-imports#85) - Fix: Top-of-file Comments get duplicated when moving runtime code ([IanVS/prettier-plugin-sort-imports#88) - Vue: Sort both script and setup script ([IanVS/prettier-plugin-sort-imports#90) - Vue and TypeScript: Use correct parser plugins ([IanVS/prettier-plugin-sort-imports#91) ##### ⚡️ Features - Add `<BUILTIN_MODULES>` Special Word ([IanVS/prettier-plugin-sort-imports#86) - Allow Explicit Separator after Top-of-file-comments ([IanVS/prettier-plugin-sort-imports#92) - Support babel-ts parser ([IanVS/prettier-plugin-sort-imports#97) ##### 🛠️ Repo Maintenance - Update dependencies, jest -> vitest ([IanVS/prettier-plugin-sort-imports#59) - Check formatting in CI ([IanVS/prettier-plugin-sort-imports#61) - Update to latest versions of Github Actions ([IanVS/prettier-plugin-sort-imports#73) - Add some more tests for comments ([IanVS/prettier-plugin-sort-imports#77) ##### 🧳 Dependencies - Drop javascript-natural-sort dependency ([IanVS/prettier-plugin-sort-imports#28) - Drop lodash.clone dependency ([IanVS/prettier-plugin-sort-imports#74) - Upgrade Babel to 7.21 ([IanVS/prettier-plugin-sort-imports#72) **Full Changelog**: IanVS/prettier-plugin-sort-imports@v3.7.2...v4.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am on Monday" in timezone Asia/Kolkata, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/timelessco/bookmark-tags).

…#161) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@ianvs/prettier-plugin-sort-imports](https://togithub.com/ianvs/prettier-plugin-sort-imports) | [`3.7.2` -> `4.0.2`](https://renovatebot.com/diffs/npm/@ianvs%2fprettier-plugin-sort-imports/3.7.2/4.0.2) | [![age](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.2/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.2/compatibility-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@ianvs%2fprettier-plugin-sort-imports/4.0.2/confidence-slim/3.7.2)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>ianvs/prettier-plugin-sort-imports</summary> ### [`v4.0.2`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.2) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v4.0.1...v4.0.2) #### What's Changed - Account for missing filepath by [@IanVS](https://togithub.com/IanVS) in [IanVS/prettier-plugin-sort-imports#104 **Full Changelog**: IanVS/prettier-plugin-sort-imports@v4.0.1...v4.0.2 ### [`v4.0.1`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.1) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v4.0.0...v4.0.1) #### What's Changed - Fix cli in Install section by [@torn4dom4n](https://togithub.com/torn4dom4n) in [IanVS/prettier-plugin-sort-imports#99 - Fix dollar sign ($) issue in Vue SFC by [@istiak-tridip](https://togithub.com/istiak-tridip) in [IanVS/prettier-plugin-sort-imports#101 #### New Contributors - [@torn4dom4n](https://togithub.com/torn4dom4n) made their first contribution in [IanVS/prettier-plugin-sort-imports#99 - [@istiak-tridip](https://togithub.com/istiak-tridip) made their first contribution in [IanVS/prettier-plugin-sort-imports#101 **Full Changelog**: IanVS/prettier-plugin-sort-imports@v4.0.0...v4.0.1 ### [`v4.0.0`](https://togithub.com/IanVS/prettier-plugin-sort-imports/releases/tag/v4.0.0) [Compare Source](https://togithub.com/ianvs/prettier-plugin-sort-imports/compare/v3.7.2...v4.0.0) #### What's Changed This new release focuses on simplifying the plugin options, shipping more useful defaults, handling comments around import statements more reliably, and improving Vue and TypeScript compatibility. We also are targeting Node 16 syntax with our build, though older versions may continue to work (untested). See the full [migration guide](https://togithub.com/IanVS/prettier-plugin-sort-imports/blob/next/docs/MIGRATION.md#migrating-from-v3xx-to-v4xx) for details of the breaking changes. ##### ⬆️ Breaking Changes - Build for Node 16+ ([IanVS/prettier-plugin-sort-imports#59) - Remove `importOrderBuiltinModulesToTop` (always true) ([IanVS/prettier-plugin-sort-imports#60) - Remove `importOrderSeparation` option ([IanVS/prettier-plugin-sort-imports#62) - Remove `importOrderCaseInsensitive` option ([IanVS/prettier-plugin-sort-imports#63) - Remove `importOrderGroupNamespaceSpecifiers` option ([IanVS/prettier-plugin-sort-imports#64) - Remove `importOrderSortSpecifiers` option ([IanVS/prettier-plugin-sort-imports#65) - Remove `importOrderMergeDuplicateImports` option (always on) ([IanVS/prettier-plugin-sort-imports#66) - Replace `importOrderCombineTypeAndValueImports` with `importOrderTypeScriptVersion` ([IanVS/prettier-plugin-sort-imports#67) - Improve default sort order ([IanVS/prettier-plugin-sort-imports#83) ##### 🐛 Bug Fixes - Fix behavior around comments embedded in imports ([IanVS/prettier-plugin-sort-imports#71) - Preserve trailing comments on specifiers ([IanVS/prettier-plugin-sort-imports#80) - Preserve comments and blank lines at top-of-file (in [IanVS/prettier-plugin-sort-imports#82) - Prevent comment gap when re-arranging first import ([IanVS/prettier-plugin-sort-imports#85) - Fix: Top-of-file Comments get duplicated when moving runtime code ([IanVS/prettier-plugin-sort-imports#88) - Vue: Sort both script and setup script ([IanVS/prettier-plugin-sort-imports#90) - Vue and TypeScript: Use correct parser plugins ([IanVS/prettier-plugin-sort-imports#91) ##### ⚡️ Features - Add `<BUILTIN_MODULES>` Special Word ([IanVS/prettier-plugin-sort-imports#86) - Allow Explicit Separator after Top-of-file-comments ([IanVS/prettier-plugin-sort-imports#92) - Support babel-ts parser ([IanVS/prettier-plugin-sort-imports#97) ##### 🛠️ Repo Maintenance - Update dependencies, jest -> vitest ([IanVS/prettier-plugin-sort-imports#59) - Check formatting in CI ([IanVS/prettier-plugin-sort-imports#61) - Update to latest versions of Github Actions ([IanVS/prettier-plugin-sort-imports#73) - Add some more tests for comments ([IanVS/prettier-plugin-sort-imports#77) ##### 🧳 Dependencies - Drop javascript-natural-sort dependency ([IanVS/prettier-plugin-sort-imports#28) - Drop lodash.clone dependency ([IanVS/prettier-plugin-sort-imports#74) - Upgrade Babel to 7.21 ([IanVS/prettier-plugin-sort-imports#72) **Full Changelog**: IanVS/prettier-plugin-sort-imports@v3.7.2...v4.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am on Monday" in timezone Asia/Kolkata, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/timelessco/next-ts-app).

fbartho added 4 commits May 17, 2023 10:12

Github highlights trailing commas in json in .md

50abaa6

Move normalizeImportOrderOption

1cf03eb

Centralize plugin-option-parsing

296b825

Also fixes a regression in tests/ImportsSeparatedIntoSideEffectGroups!

Tweak top-of-file-post-comments-blank-line tests

7355f4e

fbartho requested a review from IanVS May 17, 2023 20:31

fbartho added 2 commits May 17, 2023 13:38

Merge branch 'next' into fb/allow-spacing-after-top-of-file-comments

fc9c5c9

Add top-of-file-post-comments separator usage example

27b842f

fbartho commented May 17, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

correct an example in the Readme

1efc703

fbartho commented May 17, 2023

View reviewed changes

src/utils/normalize-plugin-options.ts Outdated Show resolved Hide resolved

Comment typo src/utils/normalize-plugin-options.ts

e8703e5

IanVS reviewed May 17, 2023

View reviewed changes

Add a docblock to examineAndNormalizePluginOptions

59a5076

IanVS reviewed May 17, 2023

View reviewed changes

src/utils/get-comment-registry.ts Outdated Show resolved Hide resolved

fbartho and others added 3 commits May 17, 2023 17:00

PR Feedback: rename InspectedAndNormalizedOptions

3bf85f2

Fix prettier-ignore lines at top-of-file get torn off

ba5d76e

Inject required groups after leading separator if present (#95)

0789e07

Created as a separate PR to review if I'm missing anything --------- Co-authored-by: Ian VanSchooten <ian.vanschooten@gmail.com>

IanVS reviewed May 19, 2023

View reviewed changes

docs/MIGRATION.md Show resolved Hide resolved

Simplify top-of-file comment separator in README

a7f2652

IanVS reviewed May 19, 2023

View reviewed changes

docs/MIGRATION.md Show resolved Hide resolved

IanVS approved these changes May 19, 2023

View reviewed changes

PR Feedback: Migration update

269756e

fbartho merged commit bfda0f5 into next May 19, 2023
6 checks passed

fbartho deleted the fb/allow-spacing-after-top-of-file-comments branch May 19, 2023 19:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Allow Explicit Separator after Top-of-file-comments #92

Feature: Allow Explicit Separator after Top-of-file-comments #92

fbartho commented May 17, 2023

IanVS left a comment

IanVS May 17, 2023 •

edited

IanVS left a comment

Feature: Allow Explicit Separator after Top-of-file-comments #92

Feature: Allow Explicit Separator after Top-of-file-comments #92

Conversation

fbartho commented May 17, 2023

IanVS left a comment

Choose a reason for hiding this comment

IanVS May 17, 2023 • edited

Choose a reason for hiding this comment

IanVS left a comment

Choose a reason for hiding this comment

IanVS May 17, 2023 •

edited