jekyll-tailwind 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b8dafd0a86f3def0e0b737532f34a43950de42fb61a4023c2418febe8c2d721
+  data.tar.gz: 74dc082a521f00cf6405c17550d86212b6939c348f292207972eed588f6b3333
+SHA512:
+  metadata.gz: c0dabe14e1b1443f634ea7ba2b878c4523cd94fa5d4f0b01cbceb0471b438fe477004f4e4551ac299370eaf63b02b9adba7dc55f72f40e46088f97afc39771ea
+  data.tar.gz: abb59dfb73338c7c965fc0b73fce6623f46ca955c5ef1100981a1d20ff844cfe573a7dc78f3c006301b447ef3fedb916d23c7e6b71c3ff3b7e192424ead17337

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [Unreleased]
+
+## [1.0.0] - 2024-03-13
+
+- Initial release
+- Automatically download Tailwind CLI
+- Allow Tailwind CLI version configuration
+- Allow custom Tailwind configuration file path

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 crbelaus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Jekyll::Tailwind
+
+**This gem allows you integrate the [TailwindCSS Standalone CLI](https://tailwindcss.com/blog/standalone-cli) in your Jekyll site.** The Tailwind CLI is a standalone executable that doesn't need NodeJS or any other external dependency.
+
+## Set up
+
+To add this gem to your project you must include it in your Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll-tailwind'
+end
+```
+
+**The first time you build your Jekyll site, this gem will automatically download the Tailwind CLI for your platform and use it to build your CSS.** The Tailwind CLI will be saved in `_tailwind/tailwind-VERSION-PLATFORM`. It is recommended that you add this file to your `.gitignore` and don't commit it to your repository.
+
+It is important to note that **subsequent runs will use the existing Tailwind CLI and won't download it again.**
+
+## Customize the Tailwind version
+
+Although not strictly necessary, it is recommended to pin your desired Tailwind CLI version in `_config.yml`.
+
+```yml
+tailwind:
+  version: 3.4.1
+```
+
+If you don't do this, the gem will automatically download the latest Tailwind CLI version that was available when gem was published.
+
+## Read the Tailwind configuration from an alternative path
+
+By default Tailwind will read the `tailwind.config.js` file that lives in your project's root (more info at [the Tailwind docs](https://tailwindcss.com/docs/configuration)).
+
+If your configuration file lives elsewhere you can say so in the `_config.yml` file:
+
+```yml
+tailwind:
+  config_path: assets/tailwind.config.js
+```

data/jekyll-tailwind.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll-tailwind/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-tailwind"
+  spec.version = Jekyll::Tailwind::VERSION
+  spec.authors = ["crbelaus"]
+  spec.email = ["cristian@crbelaus.com"]
+
+  spec.summary = "Use Tailwind CLI from your Jekyll site"
+  spec.description = "Run TailwindCSS from your Jekyll site without requiring NodeJS"
+  spec.homepage = "https://github.com/crbelaus/jekyll-tailwind"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/crbelaus/jekyll-tailwind"
+  spec.metadata["changelog_uri"] = "https://github.com/crbelaus/jekyll-tailwind/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", ">= 3.0", "< 5.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/jekyll-tailwind/installer.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "jekyll"
+require "open-uri"
+
+module Jekyll
+  class Tailwind::Installer
+    def initialize(options)
+      @target =
+        case RUBY_PLATFORM
+        when "arm64-darwin23"
+          "macos-arm64"
+        when "x86_64-linux"
+          "linux-x64"
+        else
+          raise "Tailwind CLI is not available for platform: #{RUBY_PLATFORM}"
+        end
+
+      @version = options[:version] || "3.4.1"
+      @config_path = options[:config_path] || "tailwind.config.js"
+      @path = "_tailwind/tailwind-#{@target}-#{@version}"
+    end
+
+    def install_and_run
+      install unless File.exist?(@path)
+
+      `#{@path} -i _site/assets/css/app.css -o _site/assets/css/app.css -c #{@config_path}`
+      Jekyll.logger.info "Tailwind:", "Rebuilt _site/assets/css/app.css"
+    end
+
+    private
+
+    def install
+      Jekyll.logger.info "Tailwind:", "CLI version #{@version} not found for #{@target}"
+      Jekyll.logger.info "Tailwind:", "Installing..."
+
+      uri = URI.parse("https://github.com/tailwindlabs/tailwindcss/releases/download/v#{@version}/tailwindcss-#{@target}")
+      file = uri.open
+
+      FileUtils.mkdir "_tailwind" unless File.exist?("_tailwind")
+      FileUtils.install file.path, @path, mode: 0o755
+
+      Jekyll.logger.info "Tailwind:", "CLI installed at #{@path}"
+    end
+  end
+end

data/lib/jekyll-tailwind/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class Tailwind
+    VERSION = "1.0.0"
+  end
+end

data/lib/jekyll-tailwind.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "jekyll-tailwind/version"
+require_relative "jekyll-tailwind/installer"
+
+require "jekyll"
+
+Jekyll::Hooks.register [:site], :post_write do |site|
+  tailwind = Jekyll::Tailwind::Installer.new(
+    version: site.config.dig("tailwind", "version"),
+    config_path: site.config.dig("tailwind", "config_path")
+  )
+  tailwind.install_and_run
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-tailwind
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- crbelaus
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  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'
+description: Run TailwindCSS from your Jekyll site without requiring NodeJS
+email:
+- cristian@crbelaus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- jekyll-tailwind.gemspec
+- lib/jekyll-tailwind.rb
+- lib/jekyll-tailwind/installer.rb
+- lib/jekyll-tailwind/version.rb
+homepage: https://github.com/crbelaus/jekyll-tailwind
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/crbelaus/jekyll-tailwind
+  source_code_uri: https://github.com/crbelaus/jekyll-tailwind
+  changelog_uri: https://github.com/crbelaus/jekyll-tailwind/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Use Tailwind CLI from your Jekyll site
+test_files: []