From a9aee0c8ae42ef6b67ce69b97af3ffe83e1cdbd2 Mon Sep 17 00:00:00 2001 From: chirokas <157580465+chirokas@users.noreply.github.com> Date: Sun, 22 Sep 2024 22:03:29 +0800 Subject: [PATCH] chore: correct partition by comment description --- docs/content/rules/sort-exports.mdx | 2 +- docs/content/rules/sort-objects.mdx | 5 +++-- rules/sort-classes.ts | 2 +- rules/sort-enums.ts | 2 +- rules/sort-exports.ts | 2 +- rules/sort-objects.ts | 2 +- 6 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/content/rules/sort-exports.mdx b/docs/content/rules/sort-exports.mdx index 8a6d2864..22b384df 100644 --- a/docs/content/rules/sort-exports.mdx +++ b/docs/content/rules/sort-exports.mdx @@ -110,7 +110,7 @@ Controls whether sorting should be case-sensitive or not. default: `false` -Allows you to use comments to separate the members of intersection types into logical groups. This can help in organizing and maintaining large enums by creating partitions within the enum based on comments. +Allows you to use comments to separate the exports into logical groups. This can help in organizing and maintaining large enums by creating partitions within the enum based on comments. - `true` — All comments will be treated as delimiters, creating partitions. - `false` — Comments will not be used as delimiters. diff --git a/docs/content/rules/sort-objects.mdx b/docs/content/rules/sort-objects.mdx index a8e6dbc3..3cee57ec 100644 --- a/docs/content/rules/sort-objects.mdx +++ b/docs/content/rules/sort-objects.mdx @@ -188,8 +188,9 @@ Controls whether sorting should be case-sensitive or not. Allows you to use comments to separate the keys of objects into logical groups. This can help in organizing and maintaining large enums by creating partitions within the enum based on comments. - `true` — All comments will be treated as delimiters, creating partitions. -- `false` — Comments will not be used as delimiters. -- string — A glob pattern to specify which comments should act as delimiters. +- `false` — Comments will not be used as delimiters. +- `string` — A glob pattern to specify which comments should act as delimiters. +- `string[]` — An array of glob patterns to specify which comments should act as delimiters. ### partitionByNewLine diff --git a/rules/sort-classes.ts b/rules/sort-classes.ts index 2bcef391..5afe5d96 100644 --- a/rules/sort-classes.ts +++ b/rules/sort-classes.ts @@ -72,7 +72,7 @@ export default createEslintRule({ }, partitionByComment: { description: - 'Allows to use comments to separate the nodes into logical groups.', + 'Allows to use comments to separate the class members into logical groups.', anyOf: [ { type: 'array', diff --git a/rules/sort-enums.ts b/rules/sort-enums.ts index a7635e17..4d4a7ccd 100644 --- a/rules/sort-enums.ts +++ b/rules/sort-enums.ts @@ -71,7 +71,7 @@ export default createEslintRule({ }, partitionByComment: { description: - 'Allows you to use comments to separate the class members into logical groups.', + 'Allows you to use comments to separate the members of enums into logical groups.', anyOf: [ { type: 'array', diff --git a/rules/sort-exports.ts b/rules/sort-exports.ts index a69921b4..15dbc12e 100644 --- a/rules/sort-exports.ts +++ b/rules/sort-exports.ts @@ -61,7 +61,7 @@ export default createEslintRule({ }, partitionByComment: { description: - 'Allows you to use comments to separate the class members into logical groups.', + 'Allows you to use comments to separate the exports into logical groups.', anyOf: [ { type: 'array', diff --git a/rules/sort-objects.ts b/rules/sort-objects.ts index 71dc0ecd..efb4ac87 100644 --- a/rules/sort-objects.ts +++ b/rules/sort-objects.ts @@ -86,7 +86,7 @@ export default createEslintRule({ }, partitionByComment: { description: - 'Allows you to use comments to separate the class members into logical groups.', + 'Allows you to use comments to separate the keys of objects into logical groups.', anyOf: [ { type: 'array',