jekyll-tailwindcss 0.1.0-x86_64-linux → 0.3.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c34f97df1e831e430b92cab8f9dcbf3326d7cb61b3c5aa14d5c557e346ed3f0
-  data.tar.gz: 287eb01bfed25e7cfa2edaf82c1b5640f777838882045029ea0e92ed2630dea9
+  metadata.gz: 2606f7c9a3bf612cfe1c57c0cf79c8f2f982de6c70b46f14d1aeabf3c6c034e2
+  data.tar.gz: 188a4cd4df5e55e52c360c59300ff1c9ce2e6f43bc0f894263753796a58b7a19
 SHA512:
-  metadata.gz: ffdb8150aadb0cd4d3fb1b0ea08e109fc75f6fe7be936610c316621497bb90f4628ffb03ce2872456af4cad4a930158cfc422df1e5db72dee6c813c3edea4657
-  data.tar.gz: 3ceaf372cd23353049f47ce1638a9d7c3117f9b30398345732f6ea7252a98256d384875dbb903e0c6cea8f0e772f3e1b4c6d1896fa2db76aa4ee78c592d5e7a7
+  metadata.gz: e76b337e5f9054f2c7bd15f5a56a531baccc05d0bc61366d2e4cb4dde18f2f652b000c7a15ed1e4f885725bf7039bca0df86275b2a332ab8895938668ae95fdb
+  data.tar.gz: c50c1a8af793075e92bf6f295eac25e548046c668b5309f4ee3d2934b16584627bde8b8806096f71625a3b931f7370333ba9e98b371eaa8e1078955929c22791

data/README.md

@@ -1,53 +1,151 @@
 # Jekyll::Tailwindcss
 
+Bring the fun of building with TailwindCSS into your Jekyll project (without any JavaScript)
+
+**TL;DR** This gem borrows *heavily* from 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
 
 Install the gem in your jekyll project's Gemfile by executing the following:
 
-```sh
-$ bundle add jekyll-tailwindcss
+```
+bundle add jekyll-tailwindcss
 ```
 
-Add it to your list of jekyll-plugins
+Add the plugin to your list of jekyll plugins in `_config.yml`
 
 ```yml
 plugins:
   - jekyll-tailwindcss
 ```
 
+## Tailwind Configuration
+
+This plugin requires you to have a tailwind configuration file (`tailwind.config.js`) at the root level of your project, which can be generated by running:
+
+```
+bundle exec jekyll-tailwindcss init
+```
+
+Tailwind will include the CSS for the classes found in `content` directories. For most jekyll sites, this would work well.
+
+```js
+  content: [
+    "./_drafts/**/*.md",
+    "./_includes/**/*.html",
+    "./_layouts/**/*.html",
+    "./_pages/*.{html,md}",
+    "./_posts/*.md",
+    "./*.{html,md}",
+  ],
+```
+
+Learn more at https://tailwindcss.com/docs/configuration
+
+
+
 ## Usage
 
-Currently, this gem assumes you have several files in your project:
+```sh
+bundle exec jekyll serve # or build
+```
+
+Any `*.css` file processed by jekyll [^1] that contains the `@tailwind` [directive](https://tailwindcss.com/docs/functions-and-directives#config) will now be converted through the Tailwind CLI.
+
+[^1]: Jekyll will process any file that begins with yaml [frontmatter](https://jekyllrb.com/docs/front-matter/)
 
-**`tailwind.config.js`**
+### Examples
 
-This is the tailwind configuration for your project. Learn [more here](https://tailwindcss.com/docs/configuration).
 
-**`_input.css`**
+A CSS file with frontmatter and `@tailwind` directives:
 
-This file will contain your tailwind directives and any custom classes. Read more in the [docs here](https://tailwindcss.com/docs/functions-and-directives#config)
+```css
+/* assets/css/styles.css */
+---
+# This yaml frontmatter is required for jekyll to process the file
+---
 
-**`*.tailwindcss`**
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
 
-Any files with this extension (and contain [frontmatter](https://jekyllrb.com/docs/front-matter/)) will be processed by tailwind, and converted into a corresponding filename with a `.css` extension.
+.btn {
+  @apply font-bold py-2 px-4 rounded !important;
+}
+```
+
+will be converted to
 
-For instance, `assets/css/styles.tailwindcss` will convert to `_site/assets/css/styles.css`
+```css
+/* _site/assets/css/styles.css */
 
+/*
+ * Tailwind generated CSS 
+ * ...
+ */
+```
 
 ## 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will 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).
+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.
+
+Then you can point your Jekyll project's `Gemfile` at the local version of the gem as you normally would:
+
+``` ruby
+gem "jekyll-tailwindcss", path: "/path/to/jekyll-tailwindcss"
+```
+
+### Cutting a release
+
+- bump the version
+  - [ ] update `lib/jekyll-tailwindcss/version.rb`
+  - [ ] update `CHANGELOG.md`
+  - [ ] commit and create a git tag
+- 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`
+  - [ ] `git push`
+- announce
+  - [ ] create a release at https://github.com/vormwald/jekyll-tailwindcss/releases
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/vormwald/jekyll-tailwindcss. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/vormwald/jekyll-tailwindcss/blob/main/CODE_OF_CONDUCT.md).
 
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Jekyll::Tailwindcss project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/vormwald/jekyll-tailwindcss/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Jekyll::Tailwindcss project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/vormwald/jekyll-tailwindcss/blob/main/CODE_OF_CONDUCT.md).

data/lib/jekyll/converters/tailwindcss.rb

@@ -1,3 +1,5 @@
+require "open3"
+
 module Jekyll
   module Converters
     class Tailwindcss < Converter
@@ -5,20 +7,43 @@ module Jekyll
       priority :low
 
       def matches(ext)
-        /^\.tailwindcss$/i.match?(ext)
+        /^\.css$/i.match?(ext)
       end
 
       def output_ext(ext)
-        ".css"
+        # At this point, we will have a CSS file
+        ext
       end
 
       def convert(content)
+        return content unless /@tailwind/i.match?(content)
+
         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}`
+        output, error = nil
+        Open3.popen3(tailwindcss_env_options, compile_command) do |stdin, stdout, stderr, _wait_thread|
+          stdin.write content # write the content of *.tailwindcss to the tailwindcss CLI as input
+          stdin.close
+          error = stderr.read
+          output = stdout.read
+        end
+        Jekyll.logger.warn "Jekyll Tailwind:", error unless error.nil?
+
+        output
+      rescue => e
+        Jekyll.logger.error "Jekyll Tailwind:", e.message
+        content
+      end
+
+      private
+
+      def tailwindcss_env_options
+        # Without this ENV you'll get a warning about `Browserslist: caniuse-lite is outdated`
+        # Since we're using the CLI, we can't update the data, so we ignore it.
+        {"BROWSERSLIST_IGNORE_OLD_DATA" => "1"}
       end
     end
   end

data/lib/jekyll-tailwindcss/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Tailwindcss
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/tailwindcss/commands.rb

@@ -76,8 +76,8 @@ module Tailwindcss
       def compile_command(debug: false, **kwargs)
         command = [
           executable(**kwargs),
-          "-i", "./_input.css",
-          "-c", "./tailwind.config.js"
+          "--input", "-",
+          "--config", "./tailwind.config.js"
         ]
 
         command << "--minify" unless debug

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-tailwindcss
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: x86_64-linux
 authors:
 - Mike Vormwald
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-16 00:00:00.000000000 Z
+date: 2024-06-09 00:00:00.000000000 Z
 dependencies: []
-description:
+description: 
 email:
 - mvormwald@gmail.com
 executables:
-- tailwindcss
+- jekyll-tailwindcss
 extensions: []
 extra_rdoc_files: []
 files:
@@ -22,7 +22,7 @@ files:
 - LICENSE-DEPENDENCIES
 - README.md
 - Rakefile
-- exe/tailwindcss
+- exe/jekyll-tailwindcss
 - exe/x86_64-linux/tailwindcss
 - lib/jekyll-tailwindcss.rb
 - lib/jekyll-tailwindcss/version.rb
@@ -34,7 +34,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/vormwald/jekyll-tailwindcss
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -49,8 +49,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.5.11
+signing_key: 
 specification_version: 4
 summary: Integrate Tailwind CSS into your Jekyll site.
 test_files: []