Add internal-first sort strategy

TypeStrong · Oct 28, 2023 · 02a14c0 · 02a14c0
1 parent d26f553
commit 02a14c0
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/src/lib/utils/sort.ts b/src/lib/utils/sort.ts
@@ -19,6 +19,7 @@ export const SORT_STRATEGIES = [
     "visibility",
     "required-first",
     "kind",
+    "internal-first",
 ] as const;
 
 export type SortStrategy = (typeof SORT_STRATEGIES)[number];
@@ -151,6 +152,9 @@ const sorts: Record<
     kind(a, b, { kindSortOrder }) {
         return kindSortOrder.indexOf(a.kind) < kindSortOrder.indexOf(b.kind);
     },
+    "internal-first"(a, b) {
+        return !a.flags.isExternal && b.flags.isExternal;
+    },
 };
 
 export function getSortFunction(opts: Options) {

diff --git a/src/test/utils/sort.test.ts b/src/test/utils/sort.test.ts
@@ -209,6 +209,23 @@ describe("Sort", () => {
         );
     });
 
+    it("Should sort by internal first", () => {
+        const arr = [
+            new DeclarationReflection("a", ReflectionKind.Function),
+            new DeclarationReflection("b", ReflectionKind.Function),
+            new DeclarationReflection("c", ReflectionKind.Function),
+        ];
+        arr[0].setFlag(ReflectionFlag.External, true);
+        arr[1].setFlag(ReflectionFlag.External, false);
+        arr[2].setFlag(ReflectionFlag.External, true);
+
+        sortReflections(arr, ["internal-first"]);
+        equal(
+            arr.map((r) => r.name),
+            ["b", "a", "c"],
+        );
+    });
+
     it("Should sort with multiple strategies", () => {
         resetReflectionID();
         const arr = [