jekyll-postcss 0.2.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1cfaea0a05a10e083038206f5834b33df1b64c845c444aba901a7966e3a505d
-  data.tar.gz: 7a0a5f58661e27b29bf050056a186d599249e08e509c6610bbf441ab23454d68
+  metadata.gz: cba7273f4532e27ab92106857418dc0263b353e5bf82de0f6b01ab7a9f0672c3
+  data.tar.gz: d4f38cf3b58e9d5a5f84425b19795a99c586eb5a7a65e3f17c24edad9bda81af
 SHA512:
-  metadata.gz: 5a589cb99ed995104b7b277e043ca0b98532790536585015f3910e69444e8d87bd3b2c4009c0187be1a03674ccffa65735c4b1977fdbc4b82088237839acae30
-  data.tar.gz: 67f350a07a6aeb95f456e96ca738f2c19d777812ce6304d14fbc1b0943c398b41d980f41f5db02e0c78220a12088577cc73f734c114ab37e7dc330621a4bd87b
+  metadata.gz: 4c33fa3a5cbaa238644fe013dbe4f8c0dc7773c4c77993b193c08f130b00b2fd2917997ab83416e88eb169b9464a621ef1011567c60b7b33a8913f63723d20bc
+  data.tar.gz: 30238af1504ce3ec730a22bd9dd02a0e01ef2550467d4b4d78a21e10663b9b9f61cc1cc1f528819586cad62a11d999cbae244a08d71115aca1c70808584f50b6

data/.github/FUNDING.yml

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

data/.gitignore

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

data/.tool-versions

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

data/CHANGELOG.md

@@ -1,5 +1,42 @@
 # Changelog
 
+## 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.
+    - 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
 
 - Use `Array.unshift` instead of `Array.prepend` to support older Ruby versions

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
@@ -24,26 +25,76 @@ plugins:
 
 ## Usage
 
-Make sure you have [postcss-cli](https://github.com/postcss/postcss-cli) installed and has its binary located at `./node_modules/.bin/postcss`.
+Make sure you have [postcss](https://github.com/postcss/postcss) installed.
 
 Add your PostCSS plugins to a `postcss.config.js` file in the root of your repository.
 
 ```javascript
 // postcss.config.js
 
-module.exports {
+module.exports = {
+  plugins: [
+    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" })]
+      : [])
+  ]
+};
+```
+
+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: [
-    require("autoprefixer") // example of plugin you might use
+    // ...
   ]
 };
 ```
 
-All files with the `.css` extension will now be processed by PostCSS.
+### 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
 
-### Note
+```shell
+JEKYLL_ENV=production bundle exec jekyll build
+```
 
-`jekyll-postcss` will cache your styles to avoid rebuilding when nothing has changed.
+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"
+```
+
+### Front Matter Reminder
+
+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.
+
+```
+---
+---
+
+/* Example using Tailwind */
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+```
 
 ## Development
 

data/bin/command

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+
+script_status="running"
+
+# Start the program in the background
+exec "$@" &
+pid1=$!
+
+shutdown(){
+    local pid1=$1
+    local pid2=$2
+
+    if [ $script_status = "running" ]; then
+        script_status="shutting down"
+        wait "$pid1"
+        ret=$?
+        kill -KILL "$pid2"
+        exit $ret
+    fi
+}
+
+# Silence warnings from here on
+exec >/dev/null 2>&1
+
+# Read from stdin in the background and
+# kill running program when stdin closes
+exec 0<&0 "$(
+    while read -r; do :; done
+    kill -KILL "$pid1"
+)" &
+pid2=$!
+
+# Clean up
+trap 'shutdown $pid1 $pid2' INT HUP TERM
+shutdown "$pid1" "$pid2"
+

data/bin/postcss

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+
+const postcss = require(require.resolve("postcss", { paths: [process.cwd()] }));
+const config = require(`${process.cwd()}/postcss.config.js`);
+const net = require("net");
+
+class PostCSS {
+  static process(data, write) {
+    postcss(config.plugins)
+      .process(JSON.parse(data).raw_content, { from: "stdin" })
+      .then((result) => write(result))
+      .catch((error) => {
+        console.error("PostCSS Error!\n");
+        console.error(error.toString());
+      });
+  }
+
+  static startServer() {
+    const server = net.createServer((c) => {
+      c.on("data", (data) => {
+        this.process(data, function (result) {
+          const packet = { compiled_css: result.toString() };
+
+          c.write(`${JSON.stringify(packet)}\n`);
+        });
+      });
+    });
+
+    server.on("error", (err) => {
+      console.error("PostCSS Server Error!\n");
+      throw err;
+    });
+
+    server.listen(8124, () => {
+      console.log("PostCSS Server listening on port 8124...");
+    });
+  }
+}
+
+switch (process.argv[2]) {
+  case "--development":
+    PostCSS.startServer();
+    break;
+  default:
+    PostCSS.process(process.argv[2], function (result) {
+      const packet = { compiled_css: result.toString() };
+
+      process.stdout.write(`${JSON.stringify(packet)}`);
+    });
+}

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/jekyll-postcss.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "jekyll",
                                   ENV["JEKYLL_VERSION"] ? "~> #{ENV["JEKYLL_VERSION"]}" : ">= 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop-jekyll", "~> 0.5.1"
 end

data/lib/jekyll-postcss/socket.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "socket"
+require "json"
+
+module PostCss
+  class Socket
+    class PostCssRuntimeError; end
+    START_SCRIPT = File.expand_path("../../bin/command", __dir__)
+    POSTCSS_SCRIPT = File.expand_path("../../bin/postcss", __dir__)
+
+    def initialize
+      start_dev_server if development?
+    end
+
+    def write(data)
+      if development?
+        @postcss.puts encode(data)
+      else
+        @compiled_css = `#{POSTCSS_SCRIPT} '#{encode(data)}'`
+      end
+
+      nil
+    end
+
+    def read
+      if development?
+        decode(@postcss.gets.chomp)
+      else
+        raise "You must call PostCss#write before calling PostCss#read" if @compiled_css.nil?
+
+        decode(@compiled_css)
+      end
+    end
+
+    private
+
+    def encode(data)
+      JSON.dump(:raw_content => data)
+    end
+
+    def decode(data)
+      JSON.parse(data)["compiled_css"]
+    end
+
+    def development?
+      @env ||= Jekyll.env
+
+      @env == "development"
+    end
+
+    MAX_ATTEMPTS = 100
+
+    def start_dev_server
+      Thread.new do
+        system "#{START_SCRIPT} #{POSTCSS_SCRIPT} --development"
+      end
+
+      attempts = 0
+      @postcss =
+        begin
+          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

data/lib/jekyll-postcss/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module PostCss
-    VERSION = "0.2.2"
+    VERSION = "0.4.1"
   end
 end

data/lib/jekyll/converters/postcss.rb

@@ -1,32 +1,33 @@
 # frozen_string_literal: true
 
-require "open3"
 require "digest"
+require_relative "../../jekyll-postcss/socket"
 
 module Jekyll
   module Converters
     class PostCss < Converter
       safe true
-      priority :low
+      priority :normal
 
       def initialize(config = {})
         super
 
+        @socket = config.fetch("socket") { ::PostCss::Socket.new }
         @raw_cache = nil
         @import_raw_cache = {}
         @converted_cache = nil
       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)
-        raise PostCssNotFoundError unless File.file?("./node_modules/.bin/postcss")
+        raise PostCssNotFoundError unless Dir.exist?("./node_modules/postcss")
 
         @raw_digest = Digest::MD5.hexdigest content
         @raw_import_digests = import_digests(content)
@@ -35,12 +36,9 @@ module Jekyll
           @raw_cache = @raw_digest.dup
           @import_raw_cache = @raw_import_digests.dup
 
-          compiled_css, status =
-            Open3.capture2("./node_modules/.bin/postcss", :stdin_data => content)
+          @socket.write content
 
-          raise PostCssRuntimeError unless status.success?
-
-          @converted_cache = compiled_css
+          @converted_cache = @socket.read
         end
 
         reset
@@ -75,4 +73,3 @@ module Jekyll
 end
 
 class PostCssNotFoundError < RuntimeError; end
-class PostCssRuntimeError < RuntimeError; end

data/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "jekyll-postcss",
+  "version": "0.3.0",
+  "repository": "git@github.com:mhanberg/jekyll-postcss.git",
+  "author": "Mitchell Hanberg <mitch@mitchellhanberg.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "prettier": "^2.0.5"
+  }
+}

data/yarn.lock

@@ -0,0 +1,8 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+prettier@^2.0.5:
+  version "2.0.5"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.0.5.tgz#d6d56282455243f2f92cc1716692c08aa31522d4"
+  integrity sha512-7PtVymN48hGcO4fGjybyBSIWDsLU4H4XlvOHfq91pz9kkGlonzwTfYkaIEwiRg/dAJF9YlbsduBAgtYLi+8cFg==

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-postcss
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Mitchell Hanberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-06 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -98,12 +99,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/command
 - bin/console
+- bin/postcss
+- bin/release
 - bin/setup
+- bin/spec
 - jekyll-postcss.gemspec
 - lib/jekyll-postcss.rb
+- lib/jekyll-postcss/socket.rb
 - lib/jekyll-postcss/version.rb
 - lib/jekyll/converters/postcss.rb
+- package.json
+- yarn.lock
 homepage: https://github.com/mhanberg/jekyll-postcss
 licenses:
 - MIT
@@ -125,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.