@effect-app/cli 1.24.0 → 1.26.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @effect-app/cli
 
+## 1.26.0
+
+### Minor Changes
+
+- 2bcc323: add cli gist command to work with github gist files
+
+## 1.25.0
+
+### Minor Changes
+
+- 6d8c512: update packages
+
 ## 1.24.0
 
 ### Minor Changes

package/dist/gist.d.ts

@@ -0,0 +1,231 @@
+import { FileSystem, Path } from "@effect/platform";
+import { Effect, ParseResult, Schema } from "effect";
+import { RunCommandService } from "./os-command.js";
+declare const GistEntry_base: Schema.Class<GistEntry, {
+    description: typeof Schema.String;
+    public: typeof Schema.Boolean;
+    files: Schema.Array$<typeof Schema.String>;
+}, Schema.Struct.Encoded<{
+    description: typeof Schema.String;
+    public: typeof Schema.Boolean;
+    files: Schema.Array$<typeof Schema.String>;
+}>, never, {
+    readonly description: string;
+} & {
+    readonly public: boolean;
+} & {
+    readonly files: readonly string[];
+}, {}, {}>;
+export declare class GistEntry extends GistEntry_base {
+}
+declare const GistEntryDecoded_base: Schema.Class<GistEntryDecoded, {
+    description: typeof Schema.String;
+    public: typeof Schema.Boolean;
+    files: Schema.Array$<typeof Schema.String>;
+} & {
+    files_with_name: Schema.Array$<Schema.Struct<{
+        path: typeof Schema.String;
+        name: typeof Schema.String;
+    }>>;
+}, Schema.Struct.Encoded<{
+    description: typeof Schema.String;
+    public: typeof Schema.Boolean;
+    files: Schema.Array$<typeof Schema.String>;
+}>, never, {
+    readonly description: string;
+} & {
+    readonly public: boolean;
+} & {
+    readonly files: readonly string[];
+} & {
+    readonly files_with_name: readonly {
+        readonly name: string;
+        readonly path: string;
+    }[];
+}, GistEntry, {}>;
+/**
+ * Extended gist entry that validates file_name uniqueness and extracts base filenames.
+ *
+ * GitHub Gists have a flat file structure and do not support directories/folders.
+ * All files within a gist must exist in the same namespace, meaning that files
+ * with identical names will collide, even if they originate from different local
+ * directories. When multiple files share the same basename, GitHub will either:
+ * - Reject the gist creation
+ * - Silently overwrite files (last one wins)
+ * - Display unpredictable behavior
+ *
+ * This validation prevents such collisions by detecting when multiple file paths
+ * would result in the same file_name when flattened to the gist structure.
+ *
+ * @example
+ * // These paths would collide in a gist
+ * ["src/config.json", "dist/config.json"] // Both become "config.json"
+ *
+ * @see {@link https://docs.github.com/articles/creating-gists | GitHub Gist Documentation}
+ * @see {@link https://github.com/orgs/community/discussions/29584 | Community Discussion on Gist Folder Support}
+ */
+export declare class GistEntryDecoded extends GistEntryDecoded_base {
+}
+declare const GistYAML_base: Schema.Class<GistYAML, {
+    gists: Schema.Record$<typeof Schema.String, typeof GistEntryDecoded>;
+    settings: Schema.Struct<{
+        token_env: typeof Schema.String;
+        base_directory: typeof Schema.String;
+    }>;
+}, Schema.Struct.Encoded<{
+    gists: Schema.Record$<typeof Schema.String, typeof GistEntryDecoded>;
+    settings: Schema.Struct<{
+        token_env: typeof Schema.String;
+        base_directory: typeof Schema.String;
+    }>;
+}>, never, {
+    readonly gists: {
+        readonly [x: string]: GistEntryDecoded;
+    };
+} & {
+    readonly settings: {
+        readonly token_env: string;
+        readonly base_directory: string;
+    };
+}, {}, {}>;
+export declare class GistYAML extends GistYAML_base {
+}
+declare const GistCacheEntry_base: Schema.Class<GistCacheEntry, {
+    name: typeof Schema.String;
+    id: typeof Schema.String;
+}, Schema.Struct.Encoded<{
+    name: typeof Schema.String;
+    id: typeof Schema.String;
+}>, never, {
+    readonly name: string;
+} & {
+    readonly id: string;
+}, {}, {}>;
+export declare class GistCacheEntry extends GistCacheEntry_base {
+}
+export declare const GistCacheEntries: Schema.Array$<typeof GistCacheEntry>;
+export interface GistCacheEntries extends Schema.Schema.Type<typeof GistCacheEntries> {
+}
+/**
+ * Gist cache mapping YAML configuration names to GitHub gist IDs.
+ *
+ * Since GitHub gists don't have user-defined names, we maintain a cache
+ * that maps the human-readable names from our YAML config to actual gist IDs.
+ * This allows us to:
+ * - Update existing gists instead of creating duplicates
+ * - Clean up obsolete entries when gists are removed from config
+ * - Persist the name->ID mapping across CLI runs
+ *
+ * The cache itself is stored as a secret GitHub gist for persistence.
+ */
+export declare class GistCache {
+    entries: GistCacheEntries;
+    gist_id: string;
+    constructor({ entries, gist_id }: {
+        entries: GistCacheEntries;
+        gist_id: string;
+    });
+}
+declare const GHGistService_base: Effect.Service.Class<GHGistService, "GHGistService", {
+    readonly dependencies: readonly [import("effect/Layer").Layer<RunCommandService, never, import("@effect/platform/CommandExecutor").CommandExecutor>];
+    readonly effect: Effect.Effect<{
+        /**
+         * Loads the gist cache from GitHub, containing mappings of YAML configuration names to gist IDs.
+         * If no cache exists, creates a new empty cache gist.
+         *
+         * @returns An Effect that yields a GistCache containing the loaded cache entries and cache gist ID
+         */
+        loadGistCache: () => Effect.Effect.AsEffect<Effect.Effect<GistCache, never, never>>;
+        /**
+         * Saves the current gist cache state to the GitHub cache gist.
+         * Updates the existing cache gist with the current mappings of names to gist IDs.
+         *
+         * @param cache - The GistCache instance to save
+         * @returns An Effect that succeeds when the cache is successfully saved
+         */
+        saveGistCache: (cache: GistCache) => Effect.Effect<void, never, never>;
+        /**
+         * Creates a new GitHub gist with the specified files and updates the local cache.
+         * Generates a GitHub CLI command to create the gist and extracts the resulting gist ID.
+         *
+         * @param cache - The current GistCache instance
+         * @param name - The human-readable name for this gist (used in cache mapping)
+         * @param description - The description for the GitHub gist
+         * @param files - Array of file paths to include in the gist
+         * @param is_public - Whether the gist should be public or private
+         * @returns An Effect that yields an updated GistCache with the new gist entry
+         */
+        createGistWithFiles: (args_0: {
+            gist_name: string;
+            description: string;
+            files: string[];
+            is_public: boolean;
+            cache: GistCache;
+        }) => Effect.Effect<GistCache, never, never>;
+        /**
+         * Retrieves file names from a GitHub gist.
+         * Fetches the list of files contained in the specified gist.
+         *
+         * @param gist_id - The GitHub gist ID to retrieve file names from
+         * @param gist_name - The human-readable name of the gist (for logging purposes)
+         * @returns An Effect that yields an array of file names
+         */
+        getGistFileNames: (args_0: {
+            gist_id: string;
+            gist_name: string;
+        }) => Effect.Effect<string[], never, never>;
+        /**
+         * Removes a file from a specified GitHub gist.
+         * @param gist_id - The ID of the gist to modify
+         * @param gist_name - The human-readable name of the gist (for logging purposes)
+         * @param file_name - The name of the file to remove from the gist
+         * @returns An Effect that succeeds when the file is removed
+         */
+        removeFileFromGist: (args_0: {
+            gist_id: string;
+            gist_name: string;
+            file_name: string;
+        }) => Effect.Effect<void, never, never>;
+        /**
+         * Updates a file in a specified GitHub gist.
+         * @param gist_id - The ID of the gist to modify
+         * @param gist_name - The human-readable name of the gist (for logging purposes)
+         * @param file_name - The name of the file to remove from the gist
+         * @param file_path - The local path of the file to update in the gist
+         * @returns An Effect that succeeds when the file is updated
+         */
+        updateFileOfGist: (args_0: {
+            gist_id: string;
+            gist_name: string;
+            file_name: string;
+            file_path: string;
+        }) => Effect.Effect<void, never, never>;
+        /**
+         * Adds a new file to a specified GitHub gist.
+         * @param gist_id - The ID of the gist to modify
+         * @param gist_name - The human-readable name of the gist (for logging purposes)
+         * @param file_path - The local path of the file to add to the gist
+         * @returns An Effect that succeeds when the file is added
+         */
+        addFileToGist: (args_0: {
+            gist_id: string;
+            gist_name: string;
+            file_path: string;
+        }) => Effect.Effect<void, never, never>;
+    }, never, RunCommandService>;
+}>;
+declare class GHGistService extends GHGistService_base {
+}
+declare const GistHandler_base: Effect.Service.Class<GistHandler, "GistHandler", {
+    readonly accessors: true;
+    readonly dependencies: readonly [import("effect/Layer").Layer<GHGistService, never, import("@effect/platform/CommandExecutor").CommandExecutor>];
+    readonly effect: Effect.Effect<{
+        handler: (args_0: {
+            YAMLPath: string;
+        }) => Effect.Effect<undefined, import("@effect/platform/Error").PlatformError | Error | ParseResult.ParseError | import("effect/ConfigError").ConfigError, never>;
+    }, never, Path.Path | FileSystem.FileSystem | GHGistService>;
+}>;
+export declare class GistHandler extends GistHandler_base {
+}
+export {};
+//# sourceMappingURL=gist.d.ts.map

package/dist/gist.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gist.d.ts","sourceRoot":"","sources":["../src/gist.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,EAAuB,MAAM,EAAU,WAAW,EAAQ,MAAM,EAAmB,MAAM,QAAQ,CAAA;AAGxG,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;;;;;;;;;;;;;;;;AAOnD,qBAAa,SAAU,SAAQ,cAI7B;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,gBAAiB,SAAQ,qBAoDpC;CAAG;;;;;;;;;;;;;;;;;;;;;;;AAEL,qBAAa,QAAS,SAAQ,aAS5B;CAAG;;;;;;;;;;;;AAEL,qBAAa,cAAe,SAAQ,mBAGlC;CAAG;AAEL,eAAO,MAAM,gBAAgB,sCAA+B,CAAA;AAC5D,MAAM,WAAW,gBAAiB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC;CAAG;AAExF;;;;;;;;;;;GAWG;AACH,qBAAa,SAAS;IACpB,OAAO,EAAE,gBAAgB,CAAA;IACzB,OAAO,EAAE,MAAM,CAAA;gBAEH,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,gBAAgB,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE;CAIjF;;;;QAoPK;;;;;WAKG;;QAGH;;;;;;WAMG;;QAGH;;;;;;;;;;WAUG;;uBA3IU,MAAM;yBACJ,MAAM;mBACZ,MAAM,EAAE;uBACJ,OAAO;mBACX,SAAS;;QA0IlB;;;;;;;WAOG;;qBAzGQ,MAAM;uBACJ,MAAM;;QA2GnB;;;;;;WAMG;;qBApGQ,MAAM;uBACJ,MAAM;uBACN,MAAM;;QAqGnB;;;;;;;WAOG;;qBAnGQ,MAAM;uBACJ,MAAM;uBACN,MAAM;uBACN,MAAM;;QAmGnB;;;;;;WAMG;;qBArFQ,MAAM;uBACJ,MAAM;uBACN,MAAM;;;;AA/MzB,cAAM,aAAc,SAAQ,kBAsS1B;CAAG;;;;;;sBAcqF,MAAM;;;;AAXhG,qBAAa,WAAY,SAAQ,gBAmK/B;CAAG"}