145 lines (95 loc) · 6.95 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

4.2.0

Added

Extend Prettier’s Options interface with plugin options (#292)
- This provides autocomplete when editing a local prettier.config.ts

Fixed

Fix sorting of negative numbers (#291)
- The numeric sort option was not recognizing negative numbers as numbers

4.1.1

Fixed

Fix jsonSortOrder validation (#263)
- The plugin was throwing an error when jsonSortOrder was not set.

4.1.0

Added

Export SortJsonOptions and CategorySort types (#256)

Changed

Update TypeScript from ~5.1.0 to ~5.5.0 (#238)

4.0.0

Changed

BREAKING: Drop support for Node.js v16 (#203)
BREAKING: Update case insensitive sort to use deterministic key order (#189)
- Previously the "case insensitive" sorting options would leave keys in their original order when they differed only in case. They have been updated to sort identical keys in case order instead, making these sort options deterministic.
- This change has been made because deterministic sort orders tend to be easier to work with, are more aligned with how Prettier works, and typically lead to less churn. However, if your project needs to preserve original key order, you can emulate the old behavior by defining a custom sort order that has a category for each case-insensitive character. For example, you could set this as your prettierrc.js file:
```
  {
      jsonSortOrder: JSON.stringify({
          '/^[Aa]/': 'none',
          '/^[Bb]/': 'none',
          '/^[Cc]/': 'none',
          ...
          '/^[Zz]/': 'none',
      })
  }
```
This should work for small character sets. If you require case-insensitive sorting with a larger character set, please submit a feature request. We can bring back the old sorting order as an option if there is demand for it.

3.1.0

Added

Add none sorting algorithm (#177)
- This lets you leave certain properties usorted when defining a custom sort order
- Contributed by @hyperupcall

3.0.1

Fixed

Fix accidental removal of trailing newline (#170)

3.0.0

Changed

BREAKING: Migrate to Prettier v3 (#156)
- This plugin no longer works with Prettier v2. Prettier v2 support will be maintained on v2 of this plugin however.
- Prettier v3 will no longer automatically load plugins. Follow these instructions to load this plugin after updating.

2.0.0

Changed

BREAKING: Update minimum supported Node.js version to v16 (#164)
Update dependencies (#137, #139, #141, #153, #157)

1.0.0

Changed

BREAKING: Change jsonSortOrder option to a JSON string (#118)
- This configuration option used to accept a file path. Now it accepts a JSON string instead. See the README for more details.

0.0.3

Added

Add jsonSortOrder option (#92)
- This also supports case-insensitive sorting (#104)

Changed

BREAKING: Rewrite plugin to sort AST (#100)
- This ensures that symbols are sorted before numbers, as in a normal lexical sort. This is the breaking change, because the sort order may have changed in some edge cases.
- This ensures that JSON files with mistakes like trailing commas are still sorted properly the first time.
BREAKING: Update minimum Node.js version to v14 (#40, #61)
BREAKING: Update minimum Prettier version to v2.3.2 (#47)

0.0.2 - 2021-02-13

Added

JSON Recursive Sort option (#23)

Changed

[BREAKING] Update minimum prettier version to v2.1.0 (#21, #24)
[BREAKING] Move prettier from dependencies to peerDependencies (#22)
Fix manifest repository property (#17)

Removed

Remove unused @babel/types dependency (#20)

0.0.1 - 2020-09-22

Added

Initial release

⚡