jekyll-tailwind 1.0.0 → 2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b8dafd0a86f3def0e0b737532f34a43950de42fb61a4023c2418febe8c2d721
-  data.tar.gz: 74dc082a521f00cf6405c17550d86212b6939c348f292207972eed588f6b3333
+  metadata.gz: bfc5db87c31c4f1f704558198c29a61878e9d3bfc707d8a448ca63b166487a29
+  data.tar.gz: 3f2472d57d40f82f51e3de00517d58bff5fe4e5a6f04d22aef4cc0934b5abb6b
 SHA512:
-  metadata.gz: c0dabe14e1b1443f634ea7ba2b878c4523cd94fa5d4f0b01cbceb0471b438fe477004f4e4551ac299370eaf63b02b9adba7dc55f72f40e46088f97afc39771ea
-  data.tar.gz: abb59dfb73338c7c965fc0b73fce6623f46ca955c5ef1100981a1d20ff844cfe573a7dc78f3c006301b447ef3fedb916d23c7e6b71c3ff3b7e192424ead17337
+  metadata.gz: 7c17b0881fb9ca7878c97e9619243ea7f4b1742e9342e414ddacb02a3ae0b5a8a29c9392372a97a515d39c17e72fca1416263698e2f4f95f583a500378586b31
+  data.tar.gz: 10c55df1672307e2b27c177c466e2155a4b8d4be3233fc6ef9d6ca35605312e0c700197fc0c89fbadcfaa4cb13635252e027490393b8cf01dbb2834698c51207

data/CHANGELOG.md

@@ -1,4 +1,25 @@
-## [Unreleased]
+## Unreleased
+
+## [2.1.0] - 2025-01-20
+### Changed
+- We emit a deprecation warning if Arrays is used for input config.
+
+### Added
+- Fail a build, if there are multiple input files defined.
+
+## [2.0.0] - 2024-09-30
+### New
+- Use tailwindcss-ruby gem as a wrapper for executable.
+- Expose `input` and `output` parameters in _config.yml.
+- It's possible to minimize output now
+- support for postcss was added.
+- `rake` was added as a dev dependency, to publish updates with `rake release`.
+
+### Changed
+- `config_path` is currently deprecated and will be replaced with `config`
+
+### Removed
+- `version` setting doesn't do anything anymore, tailwindcss executable version could be managed through Gemfile.
 
 ## [1.0.0] - 2024-03-13
 

data/README.md

@@ -6,34 +6,64 @@
 
 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'
 end
 ```
+2. Add plugin to _config.yml:
+```yml
+plugins:
+  - jekyll-tailwind
+```
+
+3. Add **tailwind.config.js** to root directory with following contents
+```js
+module.exports = {
+  content: ["./**/*.html"],
+  theme: {
+    extend: {},
+  },
+  plugins: [
+    require('@tailwindcss/typography'),
+    require('@tailwindcss/forms'),
+    require('@tailwindcss/container-queries')
+  ],
+};
+```
+
+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.**
+## Adjust tailwind configuration
 
-## Customize the Tailwind version
+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)).
+- Output file will also be written into `_site/assets/css/app.css`.
+- Process postcss if `postcss.config.js` is present in the root directory.
 
-Although not strictly necessary, it is recommended to pin your desired Tailwind CLI version in `_config.yml`.
+But it's possible to tweak these settings through `_config.yml` file:
 
 ```yml
 tailwind:
-  version: 3.4.1
+  config: config/tailwind.config.js
+  input: assets/css/app.css
+  output: _site/assets/css/web.css
+  postcss: config/postcss.config.js # default is nil
+  minify: true # defaults to false
 ```
 
-If you don't do this, the gem will automatically download the latest Tailwind CLI version that was available when gem was published.
+## Picking Tailwind version
+It's possible to pick particular version of tailwindd by locking `tailwindcss-ruby` dependency to certain version. Add following to your Gemfile:
 
-## Read the Tailwind configuration from an alternative path
+`gem 'tailwindcss-ruby', '>=3', '<4'`
 
-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)).
+or if you're looking for a 4v:
 
-If your configuration file lives elsewhere you can say so in the `_config.yml` file:
+`gem 'tailwindcss-ruby', '>=4'`
 
-```yml
-tailwind:
-  config_path: assets/tailwind.config.js
-```
+
+## Troubleshooting
+You may run into issues with tailwind executable, please refer to [troubleshooting section in tailwindcss-ruby gem](https://github.com/flavorjones/tailwindcss-ruby?tab=readme-ov-file#troubleshooting).

data/Rakefile

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

data/lib/jekyll-tailwind/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   class Tailwind
-    VERSION = "1.0.0"
+    VERSION = "2.1"
   end
 end

data/lib/jekyll-tailwind.rb

@@ -1,14 +1,53 @@
 # frozen_string_literal: true
 
 require_relative "jekyll-tailwind/version"
-require_relative "jekyll-tailwind/installer"
 
 require "jekyll"
+require "tailwindcss/ruby"
 
+module Jekyll
+  class Tailwind
+    def initialize(config)
+      if config["config_path"]
+        Jekyll.logger.warn "WARNING: The `config_path` option is deprecated and will be removed in the next releases. Please use the `config` option instead."
+      end
+      if config["version"]
+        Jekyll.logger.warn "WARNING: The `version` option has no effect, version could be managed through 'tailwindcss-ruby' gem in you're Gemfile."
+      end
+
+      @config = config["config_path"] || config["config"] || "tailwind.config.js"
+      @postcss = config.fetch("postcss", "postcss.config.js")
+
+      @input = if config["input"].is_a?(Array)
+        Jekyll.logger.warn "DEPRECATION: jekyll-tailwind gem can't have multiple input files. Ability to provide array as input will be gradually fazed out. Change array value like this `[assets/css/app.css]` to `assets/css/app.css`"
+
+        raise "Multiple input files are not supported" if config["input"].length > 1
+
+        config["input"].first
+      else
+        config["input"]
+      end
+      @output = config.fetch("output", "_site/assets/css/app.css")
+      @minify = config.fetch("minify", false)
+    end
+
+    def compile
+      command = [
+                Tailwindcss::Ruby.executable,
+                "--output", @output,
+                "--config", @config,
+              ]
+
+      command += ["--input", @input] if @input
+      command += ["--minify"] if @minify
+      command += ["--postcss", @postcss] if File.exist?(@postcss)
+
+      `#{command.join(' ')}`
+    end
+  end
+end
+
+# It's important to run TailwindCSS compilation after Jekyll has finished with build steps. TailwindCSS will analyse resulting HTML and produce a CSS file with attributes that are actually in use, this is done to produce a smaller CSS file.
 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
+  Jekyll::Tailwind.new(site.config.fetch('tailwind', {})).compile
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-tailwind
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: '2.1'
 platform: ruby
 authors:
-- crbelaus
+- Cristian Álvarez Belaustegui
+- Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-13 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,9 +31,38 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !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'
+- !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:
 - cristian@crbelaus.com
+- github@skatkov.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -41,9 +71,8 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- jekyll-tailwind.gemspec
+- Rakefile
 - lib/jekyll-tailwind.rb
-- lib/jekyll-tailwind/installer.rb
 - lib/jekyll-tailwind/version.rb
 homepage: https://github.com/crbelaus/jekyll-tailwind
 licenses:
@@ -67,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Use Tailwind CLI from your Jekyll site

data/jekyll-tailwind.gemspec

@@ -1,37 +0,0 @@
-# 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

@@ -1,47 +0,0 @@
-# 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