shopify_theme_builder 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ec5132dafa257a32acaf60705bd7e982eca93a913ce3034d07bf87aefb3fd40
-  data.tar.gz: 619f614802c6bfbd6335c343318ec55742e638772835f24536bf88329dacf6bd
+  metadata.gz: 307e28c3c750b87460a048c082ba3c3287a480419c1b1c52faa84660de8b543a
+  data.tar.gz: 1ea87aa101f2858f46090e8f12d61c231bb4671dbd10aaa53b5427497690ae28
 SHA512:
-  metadata.gz: 51107d89418b9556afb502a91acaabe4773ba6edc0b6afff3a1cc3765a2b93bd6fdcae9d7eaa8eebd67e4f0411a072ba6290b5630f909e988fdc75e1e3836204
-  data.tar.gz: dacf7cbd3ffd8878e4b26d11fe90b28e793dd13fceadcf22524ff8c32325f6aec4ea58276e4f1cb3b0536df823525b66e472b66d3d281ab1e4e4411d4d551853
+  metadata.gz: 4997036e87e815574d49b2857e4c8f859fcd53afcd279652ec3b81b563d454bd0826c21101a616c82cb8b0b570817e1c3d6d20a827c7d91d0940f81ed5d4766c
+  data.tar.gz: 199222a677430c7ec42719ef04574050327f61f8648c5096b7d60c9f06ac9a4c03b42fdbc90e307f41b46fd916eebb79fbac437a82c67ba00f87ce3805126279

data/README.md

@@ -1,5 +1,12 @@
 # ShopifyThemeBuilder
 
+![Gem Version](https://img.shields.io/gem/v/shopify_theme_builder?logo=rubygems)
+![GitHub branch check runs](https://img.shields.io/github/check-runs/nebulab/shopify_theme_builder/main?logo=github)
+![Codecov](https://img.shields.io/codecov/c/github/nebulab/shopify_theme_builder)
+![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/rubygems/shopify_theme_builder)
+![Gem Total Downloads](https://img.shields.io/gem/dt/shopify_theme_builder)
+![GitHub License](https://img.shields.io/github/license/nebulab/shopify_theme_builder)
+
 ShopifyThemeBuilder is a Ruby gem that facilitates the development of Shopify themes by enabling the use of a components folder where you can organize your files and separate liquid, JSON, CSS, JavaScript, comment and doc into a dedicated file. It watches for changes in your component folder and automatically compiles all files into Shopify-compatible Liquid templates.
 
 ## What problem does it solve?
@@ -32,6 +39,9 @@ blocks/
 
 All files inside the `button` folder will be compiled into a single `button.liquid` file in the `blocks` folder, combining the comment, doc, Liquid, JSON, CSS, and JavaScript code.
 
+## Tailwind CSS Support
+
+ShopifyThemeBuilder also supports Tailwind CSS integration. You can specify an input CSS file that includes Tailwind directives and an output CSS file where the compiled styles will be saved. The watcher will automatically run the Tailwind build process whenever changes are detected in the components folder.
 
 ## Installation
 
@@ -46,27 +56,28 @@ bundle add shopify_theme_builder --group "development"
 To watch for changes in the default components folder and build the theme, run:
 
 ```bash
-bundle exec theme-watcher
+bundle exec theme-builder watch
 ```
 
-You can customize the components folder by passing options:
-
-```bash
-bundle exec theme-watcher my_components
-```
+You can customize multiple options when running the watcher:
+- `--folders`: Specify one or more folders to watch (default is `_components`).
+- `--tailwind-input-file`: Specify the Tailwind CSS input file (default is `src/styles/tailwind.css`).
+- `--tailwind-output-file`: Specify the Tailwind CSS output file (default is `assets/tailwind-output.css`).
+- `--skip-tailwind`: Skip the Tailwind CSS build process (default is `false`).
 
-If you prefer, you can import the watcher executable locally using:
+If you need help with all available options, or how to set them, run:
 
 ```bash
-bundle binstubs shopify_theme_builder
+bundle exec theme-builder help watch
 ```
 
-It will create a `bin/theme-watcher` file that you can run with:
+## After Running the Watcher
 
-```bash
-bin/theme-watcher
-```
+The watcher will create a CSS file that can be included in your Shopify theme layout in this way:
 
+```liquid
+{{ 'tailwind-output.css' | asset_url | stylesheet_tag }}
+```
 
 ## Development
 
@@ -74,10 +85,10 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, run `bin/release VERSION`, which will update the version file, create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## TODO
+## Next Steps
 
-- [ ] Run the tailwind build process automatically.
-- [ ] Check if stimulus controllers are loaded correctly in Shopify themes.
+- [x] Run the tailwind build process automatically.
+- [ ] Add Stimulus JS support.
 - [ ] Create a command to build an example component with all the files.
 - [ ] Decompile existing Shopify files into components structure (?).
 

data/exe/theme-builder

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "shopify_theme_builder"
+
+ShopifyThemeBuilder::CommandLine.start(ARGV)

data/lib/shopify_theme_builder/command_line.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module ShopifyThemeBuilder
+  # CommandLine class to handle CLI commands using Thor.
+  class CommandLine < Thor
+    desc "watch", "Watch for changes in the components folder and build the theme accordingly"
+    method_option :folders, type: :array, default: ["_components"], desc: "Folders to watch for changes"
+    method_option :tailwind_input_file, type: :string, default: "./assets/tailwind.css", desc: "Tailwind CSS input file"
+    method_option :tailwind_output_file, type: :string, default: "./assets/tailwind-output.css",
+                                         desc: "Tailwind CSS output file"
+    method_option :skip_tailwind, type: :boolean, default: false, desc: "Skip Tailwind CSS processing"
+    def watch
+      ShopifyThemeBuilder.watch(
+        folders_to_watch: options[:folders],
+        tailwind_input_file: options[:tailwind_input_file],
+        tailwind_output_file: options[:tailwind_output_file],
+        skip_tailwind: options[:skip_tailwind]
+      )
+    end
+  end
+end

data/lib/shopify_theme_builder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ShopifyThemeBuilder
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/shopify_theme_builder.rb

@@ -6,16 +6,26 @@ require_relative "shopify_theme_builder/version"
 require_relative "shopify_theme_builder/watcher"
 require_relative "shopify_theme_builder/liquid_processor"
 require_relative "shopify_theme_builder/builder"
+require_relative "shopify_theme_builder/command_line"
 
 # The main module for ShopifyThemeBuilder.
 module ShopifyThemeBuilder
   class << self
-    def watch(folders_to_watch: ["_components"])
+    def watch(
+      folders_to_watch: ["_components"],
+      tailwind_input_file: "./assets/tailwind.css",
+      tailwind_output_file: "./assets/tailwind-output.css",
+      skip_tailwind: false
+    )
       create_folders(folders_to_watch)
 
       initial_build(folders_to_watch)
 
-      watch_folders(folders_to_watch)
+      run_tailwind(tailwind_input_file, tailwind_output_file) unless skip_tailwind
+
+      watch_folders(folders_to_watch) do
+        run_tailwind(tailwind_input_file, tailwind_output_file) unless skip_tailwind
+      end
     end
 
     private
@@ -46,7 +56,15 @@ module ShopifyThemeBuilder
 
           Builder.new(files_to_process: [relative_filename]).build if relative_filename.start_with?(*folders_to_watch)
         end
+
+        yield if block_given?
       end
     end
+
+    def run_tailwind(tailwind_input_file, tailwind_output_file)
+      puts "Running Tailwind CSS build..."
+
+      system("tailwindcss", "-i", tailwind_input_file, "-o", tailwind_output_file)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_theme_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Massimiliano Lattanzio
@@ -38,10 +38,44 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: tailwindcss-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 email:
 - massimiliano.lattanzio@gmail.com
 executables:
-- theme-watcher
+- theme-builder
 extensions: []
 extra_rdoc_files: []
 files:
@@ -49,9 +83,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- exe/theme-watcher
+- exe/theme-builder
 - lib/shopify_theme_builder.rb
 - lib/shopify_theme_builder/builder.rb
+- lib/shopify_theme_builder/command_line.rb
 - lib/shopify_theme_builder/liquid_processor.rb
 - lib/shopify_theme_builder/version.rb
 - lib/shopify_theme_builder/watcher.rb
@@ -64,7 +99,7 @@ metadata:
   bug_tracker_uri: https://github.com/nebulab/shopify_theme_builder/issues
   homepage_uri: https://github.com/nebulab/shopify_theme_builder?tab=readme-ov-file#readme
   source_code_uri: https://github.com/nebulab/shopify_theme_builder
-  changelog_uri: https://github.com/nebulab/shopify_theme_toolkit/releases
+  changelog_uri: https://github.com/nebulab/shopify_theme_builder/releases
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:

data/exe/theme-watcher

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "shopify_theme_builder"
-
-$stdout.sync = true
-
-if ARGV.empty?
-  ShopifyThemeBuilder.watch
-else
-  ShopifyThemeBuilder.watch(folders_to_watch: ARGV)
-end