jekyll-tailwindcss 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75d434c7c83974fc629cc0896f7119d8f0f98581abe6538cb08cea7209db3cb7
-  data.tar.gz: fb18f1e889dcd3276cb4dad19dc9ecfed2c93c04f6dff175c4911143ff1a9766
+  metadata.gz: 9492cf16b8cad5f3df51dcfdd261be6be8e32924607dc589d0edeae0bc6f13da
+  data.tar.gz: d3937dbfa2fa5fd19cd1fbe6054228496c2534607c3944e7eb3216e6815c73cb
 SHA512:
-  metadata.gz: b8b0637db403254e56022f1c50a0a37640fb7db1bcb18a463be2989a7bf696c33a5d84c8690e8261c877baf8f3ffa4d1444d621f5cfa0a0a54f3b2f732b3fc90
-  data.tar.gz: 1887b6539c5e2bd143efa5ed3045f440f2d51edfcff4c9009edf06f63bc200cdb7ce4c9ed28f96be5c4974bfdaf1d863880c0bf889ac601e1dec1a17580b52d3
+  metadata.gz: c0f7f4ab399b48b20094fd93ef318f4601c30e24547b7e2154720d1c5f1a34efe8c693dc9087babcafdd428f0d1017200a85c376527ea64a0d6ba4d7dcc995c5
+  data.tar.gz: cd1594db42c22df32a69da50557fc767c01bb4ce21f9c1f0755ab120bf29c0bc7cc38286996b5b6dcd9077f82aa0da1883301457559fb039dda462dcd71fb261

data/README.md

@@ -4,8 +4,6 @@ Bring the fun of building with TailwindCSS into your Jekyll project (without any
 
 **TL;DR** This gem borrows *heavily* from [tailwindcss-rails](https://github.com/rails/tailwindcss-rails) to provide platform-specific tailwind executables and provide a smooth developer experience in Jekyll projects
 
-Much like the Rails gem, this gem wraps [the standalone executable version](https://tailwindcss.com/blog/standalone-cli) of the Tailwind CSS v3 framework. It installs these as platform-specific executables, so there are separate underlying gems per platform, but the correct gem will automatically be picked for your platform.
-
 > “Because building a great jekyll site shouldn’t require a `node_modules` folder
 
 ## Installation
@@ -58,6 +56,15 @@ Any `*.css` file processed by jekyll [^1] that contains the `@tailwind` [directi
 
 [^1]: Jekyll will process any file that begins with yaml [frontmatter](https://jekyllrb.com/docs/front-matter/)
 
+### Configuration
+
+Location of the `tailwind.config.js` file can be configured in `_config.yml`:
+
+``` yaml
+tailwindcss:
+  config: './tailwind.config.js' # this is the default location
+```
+
 ### Examples
 
 
@@ -91,26 +98,16 @@ will be converted to
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 
 
 To install this gem on your local machine, run `bundle exec rake install`.
 
-### Updating to the latest upstream tailwindcss version
-
-Update `lib/tailwindcss/upstream.rb` with the upstream version.
-
-Run `bundle exec rake clobber` and then `bundle exec rake download` to ensure the tailwindcss binaries can be downloaded and you have the correct versions on the local disk.
-
-
 ## Testing this gem
 
 ### Running the test suite
 
 The unit tests are run with `bundle exec rspec`
 
-There is an additional integration test which runs in CI, `spec/integration/user_journey_test.sh` which you may also want to run.
-
-
 ### Testing in a Jekyll project
 
 If you want to test modifications to this gem, you must run `rake download` once to download the upstream `tailwindcss` executables.
@@ -127,11 +124,9 @@ gem "jekyll-tailwindcss", path: "/path/to/jekyll-tailwindcss"
   - [ ] update `lib/jekyll-tailwindcss/version.rb`
   - [ ] update `CHANGELOG.md`
   - [ ] commit and create a git tag ( example `git tag -a v0.3.1 -m "Release 0.3.1"` )
-- build the native gems:
-  - [ ] `bundle exec rake clobber` to clean up possibly old tailwindcss executables
-  - [ ] `bundle exec rake package`
 - push
-  - [ ] `for g in pkg/*.gem ; do gem push $g ; done`
+  - [ ] `bundle exec rake build`
+  - [ ] `gem push pkg/*.gem`
   - [ ] `git push --follow-tags`
 - announce
   - [ ] create a release at https://github.com/vormwald/jekyll-tailwindcss/releases

data/lib/jekyll/converters/tailwindcss.rb

@@ -21,7 +21,9 @@ module Jekyll
         dev_mode = Jekyll.env == "development"
         Jekyll.logger.info "Jekyll Tailwind:", "Generating #{dev_mode ? "" : "minified "}CSS"
 
-        compile_command = ::Tailwindcss::Commands.compile_command(debug: dev_mode).join(" ")
+        compile_command = ::Tailwindcss::Commands
+          .compile_command(debug: dev_mode, config: config_location)
+          .join(" ")
 
         output, error = nil
         Open3.popen3(tailwindcss_env_options, compile_command) do |stdin, stdout, stderr, _wait_thread|
@@ -45,6 +47,10 @@ module Jekyll
         # Since we're using the CLI, we can't update the data, so we ignore it.
         {"BROWSERSLIST_IGNORE_OLD_DATA" => "1"}
       end
+
+      def config_location
+        @config.dig("tailwindcss", "config") || "./tailwind.config.js"
+      end
     end
   end
 end

data/lib/jekyll-tailwindcss/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Tailwindcss
-    VERSION = "0.3.1"
+    VERSION = "0.5.0"
   end
 end

data/lib/jekyll-tailwindcss.rb

@@ -4,7 +4,6 @@ require "jekyll"
 require_relative "jekyll-tailwindcss/version"
 require_relative "jekyll/converters/tailwindcss"
 require_relative "tailwindcss/commands"
-require_relative "tailwindcss/upstream"
 
 module Jekyll
   module Tailwindcss

data/lib/tailwindcss/commands.rb

@@ -1,84 +1,14 @@
-require_relative "upstream"
+require "tailwindcss/ruby"
 
 module Tailwindcss
   module Commands
-    DEFAULT_DIR = File.expand_path(File.join(__dir__, "..", "..", "exe"))
-    GEM_NAME = "jekyll-tailwindcss"
-
-    # raised when the host platform is not supported by upstream tailwindcss's binary releases
-    class UnsupportedPlatformException < StandardError
-    end
-
-    # raised when the tailwindcss executable could not be found where we expected it to be
-    class ExecutableNotFoundException < StandardError
-    end
-
-    # raised when TAILWINDCSS_INSTALL_DIR does not exist
-    class DirectoryNotFoundException < StandardError
-    end
-
     class << self
-      def platform
-        [:cpu, :os].map { |m| Gem::Platform.local.send(m) }.join("-")
-      end
-
-      def executable(exe_path: DEFAULT_DIR)
-        tailwindcss_install_dir = ENV["TAILWINDCSS_INSTALL_DIR"]
-        if tailwindcss_install_dir
-          if File.directory?(tailwindcss_install_dir)
-            warn "NOTE: using TAILWINDCSS_INSTALL_DIR to find tailwindcss executable: #{tailwindcss_install_dir}"
-            exe_path = tailwindcss_install_dir
-            exe_file = File.expand_path(File.join(tailwindcss_install_dir, "tailwindcss"))
-          else
-            raise DirectoryNotFoundException, <<~MESSAGE
-              TAILWINDCSS_INSTALL_DIR is set to #{tailwindcss_install_dir}, but that directory does not exist.
-            MESSAGE
-          end
-        else
-          if Tailwindcss::Upstream::NATIVE_PLATFORMS.keys.none? { |p| Gem::Platform.match_gem?(Gem::Platform.new(p), GEM_NAME) }
-            raise UnsupportedPlatformException, <<~MESSAGE
-              jekyll-tailwindcss does not support the #{platform} platform
-              Please install tailwindcss following instructions at https://tailwindcss.com/docs/installation
-            MESSAGE
-          end
-
-          exe_file = Dir.glob(File.expand_path(File.join(exe_path, "*", "tailwindcss"))).find do |f|
-            Gem::Platform.match_gem?(Gem::Platform.new(File.basename(File.dirname(f))), GEM_NAME)
-          end
-        end
-
-        if exe_file.nil? || !File.exist?(exe_file)
-          raise ExecutableNotFoundException, <<~MESSAGE
-            Cannot find the tailwindcss executable for #{platform} in #{exe_path}
-
-            If you're using bundler, please make sure you're on the latest bundler version:
-
-                gem install bundler
-                bundle update --bundler
-
-            Then make sure your lock file includes this platform by running:
-
-                bundle lock --add-platform #{platform}
-                bundle install
-
-            See `bundle lock --help` output for details.
-
-            TODO If you're still seeing this message after taking those steps, try running
-            `bundle config` and ensure `force_ruby_platform` isn't set to `true`. See
-            https://github.com/vormwald/jekyll-tailwindcss#check-bundle_force_ruby_platform
-            for more details.
-          MESSAGE
-        end
-
-        exe_file
-      end
-
-      def compile_command(debug: false, **kwargs)
+      def compile_command(debug: false, config: nil, **kwargs)
         command = [
-          executable(**kwargs),
-          "--input", "-",
-          "--config", "./tailwind.config.js"
+          Tailwindcss::Ruby.executable(**kwargs),
+          "--input", "-"
         ]
+        command += ["--config", config] if config
 
         command << "--minify" unless debug
 

data/lib/tailwindcss/upstream.rb

@@ -1,17 +1,7 @@
 module Tailwindcss
   # constants describing the upstream tailwindcss project
   module Upstream
-    VERSION = "v3.4.12"
-
-    # rubygems platform name => upstream release filename
-    NATIVE_PLATFORMS = {
-      "arm64-darwin" => "tailwindcss-macos-arm64",
-      "x64-mingw32" => "tailwindcss-windows-x64.exe",
-      "x64-mingw-ucrt" => "tailwindcss-windows-x64.exe",
-      "x86_64-darwin" => "tailwindcss-macos-x64",
-      "x86_64-linux" => "tailwindcss-linux-x64",
-      "aarch64-linux" => "tailwindcss-linux-arm64",
-      "arm-linux" => "tailwindcss-linux-armv7"
-    }
+    VERSION = Tailwindcss::Ruby::Upstream::VERSION
+    deprecate_constant :VERSION
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-tailwindcss
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Mike Vormwald
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-23 00:00:00.000000000 Z
-dependencies: []
+date: 2024-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tailwindcss-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - mvormwald@gmail.com
@@ -40,14 +54,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Integrate Tailwind CSS into your Jekyll site.