feat: makes partitionByComment support line and block filters
#433
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hugop95
force-pushed
the
feat/partition-by-comment
branch
4 times, most recently
from
b06e023 to
3200b45
Compare
- Uses object-based parameters. - Moves `hasPartitionComment` to its own file.
hugop95
force-pushed
the
feat/partition-by-comment
branch
from
3200b45 to
fe4841f
Compare
hugop95
force-pushed
the
feat/partition-by-comment
branch
from
fe4841f to
cb30325
Compare
hugop95
force-pushed
the
feat/partition-by-comment
branch
3 times, most recently
from
4a7198e to
4b5cd3b
Compare
hugop95
force-pushed
the
feat/partition-by-comment
branch
from
4b5cd3b to
731bbe1
Compare
OlivierZal
approved these changes
Dec 26, 2024
azat-io
reviewed
Dec 26, 2024
| @@ -192,6 +192,11 @@ Allows you to group array elements by their kind, determining whether spread val | |||
|
|
|||
| ### partitionByComment | |||
|
|
|||
| <sub> | |||
| - type: | |||
| - `boolean | string | string[]` (`BaseType`) | |||
There was a problem hiding this comment.
Are you sure we need this block? We just have default values in other places.
| @@ -200,6 +205,7 @@ Allows you to use comments to separate the members of arrays into logical groups | |||
| - `false` — Comments will not be used as delimiters. | |||
| - `string` — A regexp pattern to specify which comments should act as delimiters. | |||
| - `string[]` — A list of regexp patterns to specify which comments should act as delimiters. | |||
| - `{ block: BaseType; line: BaseType }` — Specify which block and line comments should act as delimiters. | |||
There was a problem hiding this comment.
I'm not sure it's clear what BaseType means here.
There was a problem hiding this comment.
@azat-io The idea is to tell that block and line can be string | string[] | boolean.
I felt that
`{ block: string | string[] | boolean; line: string | string[] | boolean }`was a bit hard to read but we can do that if you feel that it's better.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #432
Most of the lines added are tests and documentation.
Description
Updates the
partitionByCommentoption to supportblockandlinefilters:Affected rules
sort-enumssort-array-includessort-setssort-decoratorssort-object-typessort-interfacessort-modulessort-classessort-variable-declarationssort-union-typessort-intersection-typessort-objectssort-named-importssort-named-exportssort-mapssort-importssort-exportsWhat is the purpose of this pull request?