fluid_cli 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77caec2dd9193b287504a5ebb36eb91746f4a4f5f13e37403e0af2ac89f8dcf2
-  data.tar.gz: 1de9dc376d3f1c151bd47ff897305f55fc3c13d6409d3202676e394fd7a41e98
+  metadata.gz: 84ff5fea48f57756d085af8e58148aec8b8b98161b152f5c7e95252f51e2348b
+  data.tar.gz: 0b65b1eccfcf8e095961e4518eb9c5e73cb4b6884b029f12074bfe477b1dc40a
 SHA512:
-  metadata.gz: 0da7f1602d15d1ba32f8995039a2d4d40cb2292f2546fbf941f8dcedbded6b5b73df918df068045d815f10bbb2a2377d6b2600beeed87b3cf952d7236a7970a6
-  data.tar.gz: 46ac939cb3df539f6b447e127487d80aa59c39ac995f17e1f1b858bd3c68e255ec2c28d922c117720c8da520efa77787d3c9b292a5157907f41b821217762282
+  metadata.gz: a951d7bfafd5ce072e8b2b8e91f308878021a13697848f0eb6fa294f09e5e0d2118a02339530914fa3dcd0647b2c7e7f29bf36bc4d2f89adcfebaf3e3b225937
+  data.tar.gz: 1031eb13ffbfb6025e7adbea17dca9bc76d7ab220840e3a8e5782422ba2edba49ee8dc8ccbc7a631e244e04aca5d62718db9f1d85043ec4ad5770008c00e2533

data/README.md

@@ -1 +1,185 @@
-# fluid_cli
+# Fluid CLI
+
+The official command-line interface for the [Fluid](https://fluid.app) e-commerce platform. Build, preview, and deploy themes for your Fluid storefront directly from the terminal.
+
+## Installation
+
+### Prerequisites
+
+- Ruby >= 3.1.0
+- Bundler
+
+### From Source
+
+```sh
+git clone https://github.com/fluid-commerce/fluid-cli.git
+cd fluid-cli
+bundle install
+```
+
+### As a Gem
+
+```sh
+gem install fluid_cli
+```
+
+## Quick Start
+
+```sh
+# Authenticate with your Fluid account
+fluid login
+
+# Initialize a new theme from the base template
+fluid theme init
+
+# Start the local development server
+fluid theme dev
+
+# Push your theme to Fluid
+fluid theme push
+```
+
+## Authentication
+
+Fluid CLI uses OAuth2 for authentication. Running `fluid login` will open your browser and redirect you to the Fluid authentication page. Once authenticated, your session is stored locally.
+
+```sh
+# Log in to your Fluid account
+fluid login
+
+# Log in to a specific company
+fluid login --company=my-store
+
+# Check who you're logged in as
+fluid whoami
+
+# Switch between companies
+fluid switch --company=another-store
+
+# Log out
+fluid logout
+```
+
+You can also authenticate via environment variables:
+
+| Variable | Description |
+|----------|-------------|
+| `FLUID_AUTH_TOKEN` | Bearer token for API authentication |
+| `FLUID_COMPANY` | Default company subdomain |
+
+## Commands
+
+### `fluid login`
+
+Authenticate with your Fluid account via the browser.
+
+| Flag | Description |
+|------|-------------|
+| `-c, --company=COMPANY` | Specify the company to log in to |
+
+### `fluid logout`
+
+Clear stored authentication tokens.
+
+### `fluid whoami`
+
+Display the currently authenticated company.
+
+### `fluid switch`
+
+Switch between companies on your account.
+
+| Flag | Description |
+|------|-------------|
+| `-c, --company=COMPANY` | Specify the company to switch to |
+
+### `fluid theme init`
+
+Initialize a new theme by cloning the base template into your current directory.
+
+| Flag | Description |
+|------|-------------|
+| `-u, --clone-url=URL` | Custom Git URL to clone from |
+
+### `fluid theme dev`
+
+Start a local development server with hot reload. The dev server proxies requests to your Fluid storefront and injects local theme files, enabling a fast development workflow.
+
+| Flag | Description |
+|------|-------------|
+| `--host=HOST` | Host to bind the dev server to |
+| `--port=PORT` | Port to bind the dev server to |
+| `--poll` | Use polling instead of filesystem events for file watching |
+| `--live-reload=MODE` | Reload mode: `full-page` or `hot-reload` |
+| `-t, --theme=THEME_ID` | Use a specific theme |
+| `-f, --force` | Force create a new development theme |
+| `--overwrite-json` | Overwrite remote JSON files with local versions |
+| `--navigate` | Open the interactive route/resource navigator |
+
+### `fluid theme push`
+
+Upload your local theme files to Fluid.
+
+| Flag | Description |
+|------|-------------|
+| `-n, --nodelete` | Don't delete remote files that are missing locally |
+| `-t, --theme=THEME_ID` | Push to a specific theme |
+| `-u, --unpublished` | Push to a new unpublished theme |
+| `-j, --json` | Include JSON settings files |
+| `-a, --allow-live` | Allow pushing to the live theme |
+| `-p, --publish` | Publish the theme after pushing |
+| `-f, --force` | Skip confirmation prompts |
+
+### `fluid theme pull`
+
+Download theme files from Fluid to your local directory.
+
+| Flag | Description |
+|------|-------------|
+| `-t, --theme=THEME_ID` | Pull from a specific theme |
+
+### `fluid theme navigate`
+
+Launch an interactive navigator to browse routes and resources for your storefront.
+
+| Flag | Description |
+|------|-------------|
+| `--host=HOST` | Host for the navigator server |
+| `--port=PORT` | Port for the navigator server |
+| `-t, --theme=THEME_ID` | Theme to navigate |
+
+## `.fluidignore`
+
+You can create a `.fluidignore` file in your theme's root directory to exclude files and directories from all theme operations (dev, push, pull, and file watching). The syntax is identical to `.gitignore`:
+
+```gitignore
+# Ignore node_modules
+node_modules/
+
+# Ignore all log files
+*.log
+
+# Ignore a specific directory
+tmp/
+
+# Negate a pattern (re-include a previously ignored file)
+!important.log
+```
+
+## Development
+
+After cloning the repository:
+
+```sh
+bundle install
+
+# Run the CLI locally
+bundle exec fluid
+
+# Run tests
+bundle exec rake test
+```
+
+## License
+
+This project is available under the [MIT License](LICENSE.txt).

data/lib/fluid_cli/file_system_listener.rb

@@ -6,11 +6,14 @@ module FluidCLI
   class FileSystemListener
     include Observable
 
-    def initialize(root:, force_poll:)
+    def initialize(root:, force_poll:, ignore_pattern: nil)
       @root = root
       @force_poll = force_poll
 
-      @listener = Listen.to(@root, force_polling: @force_poll) do |updated, added, removed|
+      listen_opts = { force_polling: @force_poll }
+      listen_opts[:ignore] = ignore_pattern if ignore_pattern
+
+      @listener = Listen.to(@root, **listen_opts) do |updated, added, removed|
         changed
         notify_observers(updated, added, removed)
       end

data/lib/fluid_cli/theme/dev_server/watcher.rb

@@ -15,7 +15,13 @@ module FluidCLI
           @ctx = ctx
           @theme = theme
           @syncer = syncer
-          @listener = FileSystemListener.new(root: @theme.root, force_poll: poll)
+
+          ignore_pattern = @theme.fluid_ignore.to_listen_regexp
+          @listener = FileSystemListener.new(
+            root: @theme.root,
+            force_poll: poll,
+            ignore_pattern: ignore_pattern
+          )
 
           add_observer(self, :upload_files_when_changed)
         end

data/lib/fluid_cli/theme/fluid_ignore.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module FluidCLI
+  module Theme
+    class FluidIgnore
+      IGNORE_FILE = ".fluidignore"
+
+      attr_reader :patterns
+
+      def initialize(root)
+        @root = root
+        @patterns = parse(ignore_file_path)
+      end
+
+      # Returns true if the given relative path should be ignored.
+      # Last matching pattern wins (supports negation with !).
+      def ignore?(relative_path)
+        relative_path = relative_path.to_s
+        result = false
+        @patterns.each do |negated, pattern|
+          if match?(pattern, relative_path)
+            result = !negated
+          end
+        end
+        result
+      end
+
+      # Returns a Regexp suitable for Listen.to(ignore: ...).
+      # Returns nil if there are no positive patterns.
+      def to_listen_regexp
+        positive_patterns = @patterns.reject(&:first).map(&:last)
+        return nil if positive_patterns.empty?
+
+        parts = positive_patterns.map { |pat| fnmatch_to_regex(pat) }
+        Regexp.new(parts.join("|"))
+      end
+
+      def any?
+        @patterns.any?
+      end
+
+      private
+
+      def ignore_file_path
+        ::File.join(@root.to_s, IGNORE_FILE)
+      end
+
+      def parse(path)
+        return [] unless ::File.exist?(path)
+
+        ::File.readlines(path, chomp: true).filter_map do |line|
+          line = line.strip
+          next if line.empty? || line.start_with?("#")
+
+          negated = line.start_with?("!")
+          line = line[1..] if negated
+
+          # Leading slash means relative to root — strip it for fnmatch
+          line = line[1..] if line.start_with?("/")
+
+          [negated, line]
+        end
+      end
+
+      def match?(pattern, path)
+        if pattern.end_with?("/")
+          # Directory pattern — match anything under this directory
+          path.start_with?(pattern) || path == pattern.chomp("/")
+        elsif pattern.include?("/")
+          # Path pattern — match against the full relative path
+          ::File.fnmatch(pattern, path, ::File::FNM_PATHNAME | ::File::FNM_DOTMATCH)
+        else
+          # Basename pattern — match against both full path and basename
+          ::File.fnmatch(pattern, path, ::File::FNM_PATHNAME | ::File::FNM_DOTMATCH) ||
+            ::File.fnmatch(pattern, ::File.basename(path), ::File::FNM_DOTMATCH)
+        end
+      end
+
+      def fnmatch_to_regex(pattern)
+        if pattern.end_with?("/")
+          # Directory pattern — match the directory and anything under it
+          Regexp.escape(pattern) + ".*"
+        else
+          re = Regexp.escape(pattern)
+          re.gsub("\\*\\*", "DOUBLE_STAR")
+            .gsub("\\*", "[^/]*")
+            .gsub("DOUBLE_STAR", ".*")
+            .gsub("\\?", "[^/]")
+        end
+      end
+    end
+  end
+end

data/lib/fluid_cli/theme/root.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require_relative "file"
+require_relative "fluid_ignore"
 require "pathname"
 
 module FluidCLI
@@ -24,11 +25,16 @@ module FluidCLI
         glob("**/*.json")
       end
 
+      def fluid_ignore
+        @fluid_ignore ||= FluidIgnore.new(root)
+      end
+
       def glob(pattern, raise_on_dir: false)
         root
           .glob(pattern)
           .select { |path| file?(path, raise_on_dir) }
           .map { |path| File.new(path, root) }
+          .reject { |file| fluid_ignore.ignore?(file.relative_path) }
       end
 
       def static_asset_file?(file)

data/lib/fluid_cli/version.rb

@@ -1,3 +1,3 @@
 module FluidCLI
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fluid_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Fluid
 bindir: exe
 cert_chain: []
-date: 2026-02-24 00:00:00.000000000 Z
+date: 2026-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bugsnag
@@ -142,6 +142,7 @@ files:
 - lib/fluid_cli/theme/dev_server/web_server.rb
 - lib/fluid_cli/theme/development_theme.rb
 - lib/fluid_cli/theme/file.rb
+- lib/fluid_cli/theme/fluid_ignore.rb
 - lib/fluid_cli/theme/forms/select.rb
 - lib/fluid_cli/theme/mime_type.rb
 - lib/fluid_cli/theme/navigation/resource_fetcher.rb