Replace getIndex with getIndexes and recognize index.*.js as an index (#3)

Author: gwbaik9717

README.md

@@ -184,13 +184,13 @@ function isSliced(layerOrName: Folder | LayerName): boolean;
 
 Determine if this layer is sliced. You can pass the folder of a layer or the name (lowercase). Only layers Shared and App are not sliced, the rest are.
 
-#### `getIndex`
+#### `getIndexes`
 
 ```ts
-function getIndex(fileOrFolder: File | Folder): File | undefined;
+function getIndexes(fileOrFolder: File | Folder): File[];
 ```
 
-Get the index (public API) of a slice or segment. When a segment is a file, it is its own index.
+Get the index (public API) of a slice or segment. When a segment is a file, it is its own index. When a segment is a folder, it returns an array of index files within that folder. Multiple index files (e.g., `index.client.js`, `index.server.js`) are supported.
 
 #### `isIndex`
 

src/fsd-aware-traverse.ts

@@ -154,20 +154,27 @@ export function isSliced(layerOrName: Folder | LayerName): boolean {
  * Get the index (public API) of a slice or segment.
  *
  * When a segment is a file, it is its own index.
+ * When a segment is a folder, it returns an array of index files within that folder.
+ * Multiple index files (e.g., `index.client.js`, `index.server.js`) are supported.
  */
-export function getIndex(fileOrFolder: File | Folder): File | undefined {
+export function getIndexes(fileOrFolder: File | Folder): File[] {
   if (fileOrFolder.type === "file") {
-    return fileOrFolder;
-  } else {
-    return fileOrFolder.children.find(isIndex) as File | undefined;
+    return [fileOrFolder];
   }
+
+  return fileOrFolder.children.filter(isIndex);
 }
 
 /** Determine if a given file or folder is an index file. */
 export function isIndex(fileOrFolder: File | Folder): boolean {
-  return (
-    fileOrFolder.type === "file" && parse(fileOrFolder.path).name === "index"
-  );
+  if (fileOrFolder.type === "file") {
+    const separator = ".";
+    const parsedFileName = parse(fileOrFolder.path).name;
+
+    return parsedFileName.split(separator).at(0) === "index";
+  }
+
+  return false;
 }
 
 /**

src/index.ts

@@ -5,7 +5,7 @@ export {
   getAllSlices,
   getAllSegments,
   isSliced,
-  getIndex,
+  getIndexes,
   isSlice,
   isIndex,
   isCrossImportPublicApi,

src/specs/fsd-aware-traverse.spec.ts

@@ -1,9 +1,9 @@
 import { join } from "node:path";
-import { test, expect } from "vitest";
+import { test, expect, describe } from "vitest";
 
 import {
   getAllSlices,
-  getIndex,
+  getIndexes,
   getSlices,
   isSlice,
   isSliced,
@@ -123,28 +123,111 @@ test("isSliced", () => {
   ).toBe(true);
 });
 
-test("getIndex", () => {
-  const indexFile: File = {
-    type: "file",
-    path: joinFromRoot("project", "src", "shared", "index.ts"),
-  };
-  const fileSegment: File = {
-    type: "file",
-    path: joinFromRoot("project", "src", "entities", "user", "ui.ts"),
-  };
-  const folderSegment = parseIntoFolder(
-    `
-    📄 Avatar.tsx
-    📄 User.tsx
-    📄 index.ts
-    `,
-    joinFromRoot("project", "src", "entities", "user", "ui"),
-  );
-  expect(getIndex(indexFile)).toEqual(indexFile);
-  expect(getIndex(fileSegment)).toEqual(fileSegment);
-  expect(getIndex(folderSegment)).toEqual({
-    type: "file",
-    path: joinFromRoot("project", "src", "entities", "user", "ui", "index.ts"),
+describe("getIndexes", () => {
+  test("basic functionality", () => {
+    const indexFile: File = {
+      type: "file",
+      path: joinFromRoot("project", "src", "shared", "index.ts"),
+    };
+    const fileSegment: File = {
+      type: "file",
+      path: joinFromRoot("project", "src", "entities", "user", "ui.ts"),
+    };
+    const folderSegment = parseIntoFolder(
+      `
+      📄 Avatar.tsx
+      📄 User.tsx
+      📄 index.ts
+      `,
+      joinFromRoot("project", "src", "entities", "user", "ui"),
+    );
+    expect(getIndexes(indexFile)).toEqual([indexFile]);
+    expect(getIndexes(fileSegment)).toEqual([fileSegment]);
+    expect(getIndexes(folderSegment)).toEqual([
+      {
+        type: "file",
+        path: joinFromRoot(
+          "project",
+          "src",
+          "entities",
+          "user",
+          "ui",
+          "index.ts",
+        ),
+      },
+    ]);
+  });
+
+  test("recognizes index.server.js as index file", () => {
+    const indexServerFile: File = {
+      type: "file",
+      path: joinFromRoot("project", "src", "shared", "index.server.js"),
+    };
+    const nonIndexFile: File = {
+      type: "file",
+      path: joinFromRoot("project", "src", "entities", "user", "ui.ts"),
+    };
+    const folderSegment = parseIntoFolder(
+      `
+      📄 Avatar.tsx
+      📄 User.tsx
+      📄 index.server.js
+      `,
+      joinFromRoot("project", "src", "entities", "user", "ui"),
+    );
+
+    expect(getIndexes(indexServerFile)).toEqual([indexServerFile]);
+    expect(getIndexes(nonIndexFile)).toEqual([nonIndexFile]);
+    expect(getIndexes(folderSegment)).toEqual([
+      {
+        type: "file",
+        path: joinFromRoot(
+          "project",
+          "src",
+          "entities",
+          "user",
+          "ui",
+          "index.server.js",
+        ),
+      },
+    ]);
+  });
+
+  test("handles multiple index files", () => {
+    const folderSegment = parseIntoFolder(
+      `
+      📄 Avatar.tsx
+      📄 User.tsx
+      📄 index.client.js
+      📄 index.server.js
+      `,
+      joinFromRoot("project", "src", "entities", "user", "ui"),
+    );
+
+    expect(getIndexes(folderSegment)).toEqual([
+      {
+        type: "file",
+        path: joinFromRoot(
+          "project",
+          "src",
+          "entities",
+          "user",
+          "ui",
+          "index.client.js",
+        ),
+      },
+      {
+        type: "file",
+        path: joinFromRoot(
+          "project",
+          "src",
+          "entities",
+          "user",
+          "ui",
+          "index.server.js",
+        ),
+      },
+    ]);
   });
 });