Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add support for sorting reflections based on user criteria
Resolves #112
- Loading branch information
Showing
14 changed files
with
505 additions
and
124 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| /** | ||
| * Module which handles sorting reflections according to a user specified strategy. | ||
| * @module | ||
| */ | ||
|
|
||
| import { DeclarationReflection, ReflectionKind } from "../models"; | ||
|
|
||
| export const SORT_STRATEGIES = [ | ||
| "source-order", | ||
| "alphabetical", | ||
| "enum-value-ascending", | ||
| "enum-value-descending", | ||
| "static-first", | ||
| "instance-first", | ||
| "visibility", | ||
| "required-first", | ||
| "kind", | ||
| ] as const; | ||
|
|
||
| export type SortStrategy = typeof SORT_STRATEGIES[number]; | ||
|
|
||
| // Return true if a < b | ||
| const sorts: Record< | ||
| SortStrategy, | ||
| (a: DeclarationReflection, b: DeclarationReflection) => boolean | ||
| > = { | ||
| "source-order"(a, b) { | ||
| const aSymbol = a.project.getSymbolFromReflection(a); | ||
| const bSymbol = b.project.getSymbolFromReflection(b); | ||
|
|
||
| // This is going to be somewhat ambiguous. No way around that. Treat the first | ||
| // declaration of a symbol as its ordering declaration. | ||
| const aDecl = aSymbol?.getDeclarations()?.[0]; | ||
| const bDecl = bSymbol?.getDeclarations()?.[0]; | ||
|
|
||
| if (aDecl && bDecl) { | ||
| const aFile = aDecl.getSourceFile().fileName; | ||
| const bFile = bDecl.getSourceFile().fileName; | ||
| if (aFile < bFile) { | ||
| return true; | ||
| } | ||
| if (aFile == bFile && aDecl.pos < bDecl.pos) { | ||
| return true; | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| // Someone is doing something weird. Fail to re-order. This *might* be a bug in TD | ||
| // but it could also be TS having some exported symbol without a declaration. | ||
| return false; | ||
| }, | ||
| alphabetical(a, b) { | ||
| return a.name < b.name; | ||
| }, | ||
| "enum-value-ascending"(a, b) { | ||
| if ( | ||
| a.kind == ReflectionKind.EnumMember && | ||
| b.kind == ReflectionKind.EnumMember | ||
| ) { | ||
| return ( | ||
| parseFloat(a.defaultValue ?? "0") < | ||
| parseFloat(b.defaultValue ?? "0") | ||
| ); | ||
| } | ||
| return false; | ||
| }, | ||
| "enum-value-descending"(a, b) { | ||
| if ( | ||
| a.kind == ReflectionKind.EnumMember && | ||
| b.kind == ReflectionKind.EnumMember | ||
| ) { | ||
| return ( | ||
| parseFloat(b.defaultValue ?? "0") < | ||
| parseFloat(a.defaultValue ?? "0") | ||
| ); | ||
| } | ||
| return false; | ||
| }, | ||
| "static-first"(a, b) { | ||
| return a.flags.isStatic && !b.flags.isStatic; | ||
| }, | ||
| "instance-first"(a, b) { | ||
| return !a.flags.isStatic && b.flags.isStatic; | ||
| }, | ||
| visibility(a, b) { | ||
| // Note: flags.isPublic may not be set on public members. It will only be set | ||
| // if the user explicitly marks members as public. Therefore, we can't use it | ||
| // here to get a reliable sort order. | ||
| if (a.flags.isPrivate) { | ||
| return false; // Not sorted before anything | ||
| } | ||
| if (a.flags.isProtected) { | ||
| return b.flags.isPrivate; // Sorted before privates | ||
| } | ||
| if (b.flags.isPrivate || b.flags.isProtected) { | ||
| return true; // We are public, sort before b if b is less visible | ||
| } | ||
| return false; | ||
| }, | ||
| "required-first"(a, b) { | ||
| return !a.flags.isOptional && b.flags.isOptional; | ||
| }, | ||
| kind(a, b) { | ||
| const weights = [ | ||
| ReflectionKind.Reference, | ||
| ReflectionKind.Project, | ||
| ReflectionKind.Module, | ||
| ReflectionKind.Namespace, | ||
| ReflectionKind.Enum, | ||
| ReflectionKind.EnumMember, | ||
| ReflectionKind.Class, | ||
| ReflectionKind.Interface, | ||
| ReflectionKind.TypeAlias, | ||
|
|
||
| ReflectionKind.Constructor, | ||
| ReflectionKind.Event, | ||
| ReflectionKind.Property, | ||
| ReflectionKind.Variable, | ||
| ReflectionKind.Function, | ||
| ReflectionKind.Accessor, | ||
| ReflectionKind.Method, | ||
| ReflectionKind.ObjectLiteral, | ||
|
|
||
| ReflectionKind.Parameter, | ||
| ReflectionKind.TypeParameter, | ||
| ReflectionKind.TypeLiteral, | ||
| ReflectionKind.CallSignature, | ||
| ReflectionKind.ConstructorSignature, | ||
| ReflectionKind.IndexSignature, | ||
| ReflectionKind.GetSignature, | ||
| ReflectionKind.SetSignature, | ||
| ] as const; | ||
|
|
||
| return weights.indexOf(a.kind) < weights.indexOf(b.kind); | ||
| }, | ||
| }; | ||
|
|
||
| export function sortReflections( | ||
| strategies: DeclarationReflection[], | ||
| strats: readonly SortStrategy[] | ||
| ) { | ||
| strategies.sort((a, b) => { | ||
| for (const s of strats) { | ||
| if (sorts[s](a, b)) { | ||
| return -1; | ||
| } | ||
| if (sorts[s](b, a)) { | ||
| return 1; | ||
| } | ||
| } | ||
| return 0; | ||
| }); | ||
| } |
Oops, something went wrong.