feat: implement analyze method on store #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

luxass merged 33 commits into main from store-analyze

Jul 31, 2025

.changeset/proud-mangos-look.md

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+    ---
+    "@ucdjs/ucd-store": minor
+    ---
+    implement analyze on ucd-store

packages/cli/package.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -36,7 +36,7 @@ @@
         "node": ">=22.17"
       },
       "scripts": {
-        "build": "tsdown",
+        "build": "tsdown --tsconfig=./tsconfig.build.json",
         "clean": "git clean -xdf dist node_modules",
         "lint": "eslint .",
         "typecheck": "tsc --noEmit"
@@ Expand Down @@

packages/cli/src/cmd/store/analyze.ts

-Original file line number
+Diff line change
@@ -0,0 +1,115 @@
+    /* eslint-disable no-console */
+    import type { Prettify } from "@luxass/utils";
+    import type { CLIArguments } from "../../cli-utils";
+    import type { CLIStoreCmdSharedFlags } from "./_shared";
+    import { UCDStoreUnsupportedFeature } from "@ucdjs/ucd-store";
+    import { green, red } from "farver/fast";
+    import { printHelp } from "../../cli-utils";
+    import { assertRemoteOrStoreDir, createStoreFromFlags, SHARED_FLAGS } from "./_shared";
+    export interface CLIStoreAnalyzeCmdOptions {
+      flags: CLIArguments<Prettify<CLIStoreCmdSharedFlags & {
+        json?: boolean;
+        checkOrphaned?: boolean;
+      }>>;
+      versions?: string[];
+    }
+    export async function runAnalyzeStore({ flags, versions }: CLIStoreAnalyzeCmdOptions) {
+      if (flags?.help || flags?.h) {
+        printHelp({
+          headline: "Analyze UCD Store",
+          commandName: "ucd store analyze",
+          usage: "[...versions] [...flags]",
+          tables: {
+            Flags: [
+              ...SHARED_FLAGS,
+              ["--check-orphaned", "Check for orphaned files in the store."],
+              ["--json", "Output analyze information in JSON format."],
+              ["--help (-h)", "See all available flags."],
+            ],
+          },
+        });
+        return;
+      }
+      if (!versions || versions.length === 0) {
+        console.info("No specific versions provided. Analyzing all versions in the store.");
+      }
+      const {
+        storeDir,
+        json,
+        remote,
+        baseUrl,
+        patterns,
+        checkOrphaned,
+      } = flags;
+      try {
+        assertRemoteOrStoreDir(flags);
+        const store = await createStoreFromFlags({
+          baseUrl,
+          storeDir,
+          remote,
+          patterns,
+        });
+        if (store == null) {
+          console.error("Error: Failed to create UCD store.");
+          return;
+        }
+        const result = await store.analyze({
+          checkOrphaned: !!checkOrphaned,
+          versions: versions || [],
+        });
+        if (json) {
+          console.info(JSON.stringify(result, null, 2));
+          return;
+        }
+        for (const { version, fileCount, isComplete, missingFiles, orphanedFiles, totalFileCount } of result) {
+          console.info(`Version: ${version}`);
+          if (isComplete) {
+            console.info(`  Status: ${green("complete")}`);
+          } else {
+            console.warn(`  Status: ${red("incomplete")}`);
+          }
+          console.info(`  Files: ${fileCount}`);
+          if (missingFiles && missingFiles.length > 0) {
+            console.warn(`  Missing files: ${missingFiles.length}`);
+          }
+          if (orphanedFiles && orphanedFiles.length > 0) {
+            console.warn(`  Orphaned files: ${orphanedFiles.length}`);
+          }
+          if (totalFileCount) {
+            console.info(`  Total files expected: ${totalFileCount}`);
+          }
+        }
+      } catch (err) {
+        if (err instanceof UCDStoreUnsupportedFeature) {
+          console.error(red(`\n❌ Error: Unsupported feature:`));
+          console.error(`  ${err.message}`);
+          console.error("");
+          console.error("This store does not support the analyze operation.");
+          console.error("Please check the store capabilities or use a different store type.");
+          return;
+        }
+        let message = "Unknown error";
+        if (err instanceof Error) {
+          message = err.message;
+        } else if (typeof err === "string") {
+          message = err;
+        }
+        console.error(red(`\n❌ Error analyzing store:`));
+        console.error(`  ${message}`);
+        console.error("Please check the store configuration and try again.");
+        console.error("If you believe this is a bug, please report it at https://github.com/ucdjs/ucd/issues");
+      }
+    }

packages/cli/src/cmd/store/root.ts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -14,7 +14,7 @@ const CODEGEN_SUBCOMMANDS = [
  
      "init",

      "repair",

      "clean",

      "status",

      "analyze",

    ] as const;

    export type Subcommand = (typeof CODEGEN_SUBCOMMANDS)[number];

    @@ -70,9 +70,9 @@ export async function runStoreRoot(subcommand: string, { flags }: CLIStoreCmdOpt
  
        return;

      }

      if (subcommand === "status") {

        const { runStatusStore } = await import("./status");

        await runStatusStore({ flags });

      if (subcommand === "analyze") {

        const { runAnalyzeStore } = await import("./analyze");

        await runAnalyzeStore({ flags });

        return;

      }

packages/cli/src/cmd/store/status.ts

This file was deleted.

packages/env/package.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -32,7 +32,7 @@ @@
         "node": ">=22.17"
       },
       "scripts": {
-        "build": "tsdown",
+        "build": "tsdown --tsconfig=./tsconfig.build.json",
         "dev": "tsdown --watch",
         "clean": "git clean -xdf dist node_modules",
         "lint": "eslint .",
@@ Expand Down @@

packages/fetch/package.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -32,7 +32,7 @@ @@
         "node": ">=22.17"
       },
       "scripts": {
-        "build": "tsdown",
+        "build": "tsdown --tsconfig=./tsconfig.build.json",
         "dev": "tsdown --watch",
         "clean": "git clean -xdf dist node_modules",
         "lint": "eslint .",
@@ Expand Down @@

packages/fs-bridge/eslint.config.js

-Original file line number
+Diff line change
@@ -1,11 +1,11 @@
     // @ts-check
-    import { luxass } from "@luxass/eslint-config";
+    import { GLOB_TESTS, luxass } from "@luxass/eslint-config";
     export default luxass({
       type: "lib",
       pnpm: true,
     }).append({
-      ignores: ["src/bridges/node.ts"],
+      ignores: ["src/bridges/node.ts", ...GLOB_TESTS],
       rules: {
         "no-restricted-imports": ["error", {
           patterns: [
@@ Expand Down @@

packages/fs-bridge/package.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -35,7 +35,7 @@ @@
         "node": ">=22.17"
       },
       "scripts": {
-        "build": "tsdown",
+        "build": "tsdown --tsconfig=./tsconfig.build.json",
         "dev": "tsdown --watch",
         "clean": "git clean -xdf dist node_modules",
         "lint": "eslint .",
@@ Expand Down @@

packages/fs-bridge/src/bridges/http.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -90,7 +90,7 @@ const HTTPFileSystemBridge = defineFileSystemBridge({ @@
             const entries: FSEntry[] = [];
             for (const entry of data) {
               if (entry.type === "directory") {
-                const children = await this.listdir(entry.path, true);
+                const children = await this.listdir(joinURL(path, entry.path), true);
                 entries.push({
                   type: "directory",
                   name: entry.name,
@@ Expand Down @@

packages/fs-bridge/test/bridges/http.test.ts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -120,19 +120,19 @@ describe("http fs-bridge", () => {
  
          {

            type: "file" as const,

            name: "file1.txt",

            path: "/dir/file1.txt",

            path: "/file1.txt",

            lastModified: Date.now(),

          },

          {

            type: "file" as const,

            name: "file2.txt",

            path: "/dir/file2.txt",

            path: "/file2.txt",

            lastModified: Date.now(),

          },

          {

            type: "directory" as const,

            name: "subdir",

            path: "/dir/subdir",

            path: "/subdir",

            lastModified: Date.now(),

          },

        ] satisfies FileEntry[];

    @@ -154,18 +154,18 @@ describe("http fs-bridge", () => {
  
          expect(files).toEqual([

            {

              name: "file1.txt",

              path: "/dir/file1.txt",

              path: "/file1.txt",

              type: "file",

            },

            {

              name: "file2.txt",

              path: "/dir/file2.txt",

              path: "/file2.txt",

              type: "file",

            },

            {

              children: [],

              name: "subdir",

              path: "/dir/subdir",

              path: "/subdir",

              type: "directory",

            },

    @@ -177,7 +177,7 @@ describe("http fs-bridge", () => {
  
            {

              type: "file" as const,

              name: "nested.txt",

              path: "/dir/subdir/nested.txt",

              path: "/nested.txt",

              lastModified: Date.now(),

            },

          ] satisfies FileEntry[];

    @@ -199,14 +199,14 @@ describe("http fs-bridge", () => {
  
          const files = await bridge.listdir("dir", true);

          expect(files).toEqual([

            { type: "file", name: "file1.txt", path: "/dir/file1.txt" },

            { type: "file", name: "file2.txt", path: "/dir/file2.txt" },

            { type: "file", name: "file1.txt", path: "/file1.txt" },

            { type: "file", name: "file2.txt", path: "/file2.txt" },

            {

              type: "directory",

              name: "subdir",

              path: "/dir/subdir",

              path: "/subdir",

              children: [

                { type: "file", name: "nested.txt", path: "/dir/subdir/nested.txt" },

                { type: "file", name: "nested.txt", path: "/nested.txt" },

              ],

            },

          ]);

    @@ -260,13 +260,13 @@ describe("http fs-bridge", () => {
  
                {

                  type: "file" as const,

                  name: "accessible.txt",

                  path: "/dir/accessible.txt",

                  path: "/accessible.txt",

                  lastModified: Date.now(),

                },

                {

                  type: "directory" as const,

                  name: "inaccessible",

                  path: "/dir/inaccessible",

                  path: "/inaccessible",

                  lastModified: Date.now(),

                },

              ] satisfies FileEntry[]), {

    @@ -290,10 +290,10 @@ describe("http fs-bridge", () => {
  
          const files = await bridge.listdir("dir", true);

          expect(files).toEqual([

            { type: "file", name: "accessible.txt", path: "/dir/accessible.txt" },

            { type: "directory", name: "inaccessible", path: "/dir/inaccessible", children: [] },

            { type: "file", name: "accessible.txt", path: "/accessible.txt" },

            { type: "directory", name: "inaccessible", path: "/inaccessible", children: [] },

          ]);

          expect(flattenFilePaths(files)).not.toContain("/dir/inaccessible/another-file.txt");

          expect(flattenFilePaths(files)).not.toContain("/inaccessible/another-file.txt");

        });

      });

packages/schema-gen/package.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -32,7 +32,7 @@ @@
         "node": ">=22.17"
       },
       "scripts": {
-        "build": "tsdown",
+        "build": "tsdown --tsconfig=./tsconfig.build.json",
         "dev": "tsdown --watch",
         "clean": "git clean -xdf dist node_modules",
         "lint": "eslint .",
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: implement analyze method on store #183

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!