jekyll-postcss 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 635d3d12852e6842c6d3b24493c98b986578b6209ad1628c7005e4ea7f3db7ce
-  data.tar.gz: bbafa3ff24e1186926a16ca4c9d9ae240035d95ded1e5e9005c814fe777e780f
+  metadata.gz: b4610bf3b4f73b8c871bdc5ae6f91ff3f461128b5ce34716486bbcbb77987a1d
+  data.tar.gz: d1033851975011342f10ad19c6acfd1b9168aa736cc0071766cb17eeefcd6fe5
 SHA512:
-  metadata.gz: fcb25b23596d06b8703b9a72697e614f7733ef7c07ece2ae4537934f4758c478bef4569da98bf99f0ccedfc1d8049d8d6782c349f69685a20f11ac1821004369
-  data.tar.gz: 669475b69a173d0aab8ea11aba25f40fadc68167ab0c099e95d94757032eefdbcce8441b487fadb5bbd00e5164e43c94d4953bbd4fa561391cf16744a9f6d609
+  metadata.gz: 3c9a64927c2b52f7041624b9413745b4f0e4539c2066c85533723d543c580bc946cf7e21426a02b29af2ca048eb821e896398433d0e575b560426099b787ac5f
+  data.tar.gz: 31b02f8c9c9b8610daff01bb5bd58622ff7354ea9f688c8d25018678996efdb3a9737dbe4ff67bc011090a7edcca938061a2c1b811319d7a8e0a6a0731f31119

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: mhanberg

data/.gitignore

@@ -11,5 +11,5 @@
 .rspec_status
 
 Gemfile.lock
-node_modules/
+node_modules
 yarn-error.log

data/.tool-versions

@@ -1 +1 @@
-ruby 2.5.3
+ruby 2.7.2

data/CHANGELOG.md

@@ -1,13 +1,46 @@
 # Changelog
 
+## 0.5.0
+
+- Option to disable the cache #32 by [Tristan Dunn](https://github.com/tristandunn)
+- Show full PostCSS error and stack trace #31 by [Carl Furrow](https://github.com/cfurrow)
+
+## 0.4.1
+
+- Fix a weird issue where the jekyll server never booted up because the converter class got in an infinite loop trying to make a socket connection to the postcss server.
+
+## 0.4.0
+
+### Process SCSS/Sass files
+
+The plugin now processes scss and sass files in addition to css files. This requires using the [postcss-scss](https://github.com/postcss/postcss-scss) syntax parser in your postcss.config.js
+
+```javascript
+module.exports = {
+  parser: 'postcss-scss',
+  plugins: [
+    // ...
+  ]
+};
+
+jekyll-postcss has a higher priority, so it will hand off the the postcss output to jekyll-sass-converter to finish off compiling.
+
+```
+
+## 0.3.2
+
+- Output valid CSS when running outside the development environment
+
 ## 0.3.1
 
-- Only run development server in development
+- Only run development server in development.
+    - This was discovered when attempting to deploy to Netlify. You can read more about it here [#8](https://github.com/mhanberg/jekyll-postcss/issues/8), [#15](https://github.com/mhanberg/jekyll-postcss/issues/15), and [here](https://community.netlify.com/t/deploy-is-hanging-postcss-problem/14822).
 
 ## 0.3.0
 
 - Update rake
 - Performance improvement
+- [Breaking?]: Uses `postcss` instead of `postcss-cli`. I think that it will continue to work without changing your dependencies since `postcss-cli` uses `postcss` as a dependency.
 
 ## 0.2.2
 

data/README.md

@@ -13,6 +13,7 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'jekyll-postcss'
 ```
+
 And then add this line to your application's `_config.yml`:
 
 ```yml
@@ -33,7 +34,7 @@ Add your PostCSS plugins to a `postcss.config.js` file in the root of your repos
 
 module.exports = {
   plugins: [
-    require("autoprefixer") // example of plugin you might use
+    require("autoprefixer"), // example of plugin you might use
     ...(process.env.JEKYLL_ENV == "production" // example of only using a plugin in production
       ? [require("cssnano")({ preset: "default" })]
       : [])
@@ -41,13 +42,62 @@ module.exports = {
 };
 ```
 
-All files with the `.css` extension will now be processed by PostCSS.
+All CSS and SCSS/Sass files will now be processed by PostCSS.
+
+### SCSS/Sass
+
+If using SCSS/Sass, you must have [postcss-scss](https://github.com/postcss/postcss-scss) installed and configured in your `postcss.config.js`
+
+```javascript
+module.exports = {
+  parser: 'postcss-scss',
+  plugins: [
+    // ...
+  ]
+};
+```
+
+### Caching
 
-### Notes
+Caching is enabled by default so PostCSS will only be called when the CSS content has changed. If needed you can disable caching in your Jekyll configuration to force the CSS to be recompiled every time.
+
+If you are using the [TailwindCSS JIT](https://tailwindcss.com/docs/just-in-time-mode), you most likely need to disable the caching feature.
+
+```yaml
+# _config.yml
+
+postcss:
+  cache: false
+```
+
+### Deployment
+
+When deploying, make sure to set your `JEKYLL_ENV` to something like `production` or `staging`. This is necessary to make sure that jekyll-postcss will not use internal development conveniences when building on your host's servers.
+
+This can be done so by setting your build command like so
+
+```shell
+JEKYLL_ENV=production bundle exec jekyll build
+```
+
+or using your hosts proprietary configuration. Here is an example using Netlify.
+
+```toml
+# netlify.toml
+
+[context.production.environment]
+  JEKYLL_ENV = "production"
+
+[context.branch-deploy.environment]
+  JEKYLL_ENV = "staging"
+
+[context.deploy-preview.environment]
+  JEKYLL_ENV = "staging"
+```
 
-jekyll-postcss will run a development server when `JEKYLL_ENV` is set to `development`. This is the default value if you don't set it elsewhere. When building your site for production or staging, make sure to set the `JEKYLL_ENV` appropriately, or else your deploy may fail, e.g., `JEKYLL_ENV=production bundle exec jekyll build`.
+### Front Matter Reminder
 
-Also note that your `.css` files still need to have a [front matter](https://jekyllrb.com/docs/step-by-step/03-front-matter/) for them to be processed by Jekyll.
+Your stylesheets still need to have [front matter](https://jekyllrb.com/docs/step-by-step/03-front-matter/) for them to be processed by Jekyll.
 
 ```
 ---

data/bin/postcss

@@ -7,11 +7,11 @@ const net = require("net");
 class PostCSS {
   static process(data, write) {
     postcss(config.plugins)
-      .process(JSON.parse(data).raw_content, { from: "stdin" })
+      .process(JSON.parse(data).raw_content, { from: undefined })
       .then((result) => write(result))
       .catch((error) => {
         console.error("PostCSS Error!\n");
-        console.error(error.toString());
+        console.error(error);
       });
   }
 

data/bin/release

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec rake release

data/bin/spec

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec rspec "$@"

data/lib/jekyll/converters/postcss.rb

@@ -7,11 +7,12 @@ module Jekyll
   module Converters
     class PostCss < Converter
       safe true
-      priority :low
+      priority :normal
 
       def initialize(config = {})
         super
 
+        @cache_enabled = config.fetch("postcss", {}).fetch("cache", true)
         @socket = config.fetch("socket") { ::PostCss::Socket.new }
         @raw_cache = nil
         @import_raw_cache = {}
@@ -19,11 +20,11 @@ module Jekyll
       end
 
       def matches(ext)
-        ext.casecmp(".css").zero?
+        [".css", ".scss", ".sass"].include?(ext.downcase)
       end
 
-      def output_ext(_ext)
-        ".css"
+      def output_ext(ext)
+        ext
       end
 
       def convert(content)
@@ -32,7 +33,7 @@ module Jekyll
         @raw_digest = Digest::MD5.hexdigest content
         @raw_import_digests = import_digests(content)
 
-        if cache_miss.any?
+        if cache_disabled? || cache_miss?
           @raw_cache = @raw_digest.dup
           @import_raw_cache = @raw_import_digests.dup
 
@@ -58,10 +59,15 @@ module Jekyll
           end
       end
 
-      def cache_miss
+      def cache_disabled?
+        @cache_enabled == false
+      end
+
+      def cache_miss?
         @raw_import_digests
           .map { |import, hash| @import_raw_cache[import] != hash }
           .unshift(@raw_cache != @raw_digest)
+          .any?
       end
 
       def reset

data/lib/jekyll-postcss/socket.rb

@@ -2,7 +2,6 @@
 
 require "socket"
 require "json"
-require "open3"
 
 module PostCss
   class Socket
@@ -30,7 +29,7 @@ module PostCss
       else
         raise "You must call PostCss#write before calling PostCss#read" if @compiled_css.nil?
 
-        @compiled_css
+        decode(@compiled_css)
       end
     end
 
@@ -50,19 +49,27 @@ module PostCss
       @env == "development"
     end
 
+    MAX_ATTEMPTS = 100
+
     def start_dev_server
       Thread.new do
         system "#{START_SCRIPT} #{POSTCSS_SCRIPT} --development"
       end
 
-      @postcss = nil
-      while @postcss.nil?
+      attempts = 0
+      @postcss =
         begin
-          @postcss = TCPSocket.open("localhost", 8124)
-        rescue StandardError
-          nil # Suppressing exceptions
+          TCPSocket.open("localhost", 8124) 
+        rescue StandardError => e
+          attempts = attempts + 1
+
+          if attempts < MAX_ATTEMPTS
+            sleep 0.1
+            retry 
+          else
+            raise "Could not connect to the PostCSS server"
+          end
         end
-      end
     end
   end
 end

data/lib/jekyll-postcss/version.rb

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

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jekyll-postcss",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "repository": "git@github.com:mhanberg/jekyll-postcss.git",
   "author": "Mitchell Hanberg <mitch@mitchellhanberg.com>",
   "license": "MIT",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-postcss
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Mitchell Hanberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2021-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -101,7 +102,9 @@ files:
 - bin/command
 - bin/console
 - bin/postcss
+- bin/release
 - bin/setup
+- bin/spec
 - jekyll-postcss.gemspec
 - lib/jekyll-postcss.rb
 - lib/jekyll-postcss/socket.rb
@@ -130,8 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A PostCSS plugin for Jekyll.