jekyll-tailwind-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28a76f9d8fe8b29a2c6d71dd0a3b81ebe29237525e83951410f1d7707be5eb5c
+  data.tar.gz: 736c273d0cac35717ff6b737ac03b98220593a367c6cce98ff6e564f0121a2c4
+SHA512:
+  metadata.gz: 075a8326f10761482124de7d321ad3fa5fd8a974d89ad2bc22010f7fb95844e465e7640165dc9875fc4d219d1a02b9ba462f521954d866149a1a7ca749f55edd
+  data.tar.gz: b29213cb464a353c4cda08e4aa55c0e2b9f636cf205a145c12907e48fac276da3a7f1343fe8ffa42e992fddff8f3ecfd714b6f0715e70555949cdf85b9f34c6d

data/.standard.yml

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

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,61 @@
+# 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.
+
+This gem was originally inspired by https://github.com/crbelaus/jekyll-tailwind
+## Set up
+
+To add this gem to your project you must include it in your Gemfile:
+
+1. Add a gem
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll-tailwind-cli'
+end
+```
+
+2. Add **tailwind.config.js** to root directory with following contents
+```js
+module.exports = {
+  content: ["./**/*.html", "./**/*.md"],
+  theme: {
+    extend: {},
+  },
+  plugins: [],
+};
+```
+
+3. Add **assets/app.css** file with following contents
+```css
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+```
+4. Modify default template to include app.css, e.g.:
+`<link rel="stylesheet" href="{{ "/assets/css/app.css" | relative_url }}">`
+
+**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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/jekyll-tailwind-cli/installer.rb

@@ -0,0 +1,51 @@
+# 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-darwin/
+          'macos-arm64'
+        when /^x86_64-darwin/
+          'macos-x64'
+        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 check_install
+      install unless File.exist?(@path)
+    end
+
+    def build
+      Jekyll.logger.info 'Tailwind:', 'Rebuilt _site/assets/css/app.css'
+      `#{@path} --input _site/assets/css/app.css --output _site/assets/css/app.css --config #{@config_path}`
+    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-cli/version.rb

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

data/lib/jekyll-tailwind-cli.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "jekyll-tailwind-cli/version"
+require_relative "jekyll-tailwind-cli/installer"
+
+require "jekyll"
+
+def tailwind(site)
+  Jekyll::Tailwind::Installer.new(
+    version: site.config.dig("tailwind", "version"),
+    config_path: site.config.dig("tailwind", "config_path")
+  )
+end
+
+Jekyll::Hooks.register [:site], :post_read do |site|
+  tailwind(site).check_install
+end
+
+Jekyll::Hooks.register [:site], :pre_render do |site|
+  tailwind(site).build
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-tailwind-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- skatkov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-20 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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Run TailwindCSS from your Jekyll site without requiring NodeJS
+email:
+- github@skatkov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/jekyll-tailwind-cli.rb
+- lib/jekyll-tailwind-cli/installer.rb
+- lib/jekyll-tailwind-cli/version.rb
+homepage: https://github.com/skatkov/jekyll-tailwind-cli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/skatkov/jekyll-tailwind-cli
+  source_code_uri: https://github.com/skatkov/jekyll-tailwind-cli
+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.9
+signing_key:
+specification_version: 4
+summary: Use Tailwind CLI with a Jekyll site
+test_files: []