jekyll-postcss-v2 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bba2a3b9465f900eb7eca43bb91cf7260de96dfc4fef8c206fc77464962cb6a
-  data.tar.gz: d8799804da82a9d4ad9e8fc1ed098af675a4d67d00e2946ebc7d23ab9c75a9b0
+  metadata.gz: 355465f0a7ff03775c701327324d28f839e9eb999ab0521db78e5a8b91c3c734
+  data.tar.gz: 046316cee00e8d4e1643f14b866a9ab173e518ab960d25ee27ab4cba7fae03c4
 SHA512:
-  metadata.gz: 0cb379319cab02d45abc17e6bb056b6253899c7cf72e8f430dff071dade71678ad9d9f5b4c71d61b409c2c3efeee423ffdb5684c28566a0fa15efcdccdc97107
-  data.tar.gz: 98e5ff3f4db6919263e78d798e72c08d6a8b23ba05378ceaabcd6aeb1a07a000b9a5f863208cf23d6232a56de826c8ffc95ae38389be10397c93dacabfb0ae3b
+  metadata.gz: 97ed7678e2fb27bc61432d5c75ccaa639d344d1ca1242e9a1e80334b841d52d1fe97101bf0e6d3ad9ba880a3386d830653983b84cf3faf6e5f7be79d19f057ee
+  data.tar.gz: d661c419ab3fd622ed8eb4cae573448bd90858913b3ea37e64e2c54bc655e2f832e74eb75f5fbc240843b13891e1a85795f7cbb46297cdbc78455f2bbac63b32

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## 1.0.2
+
+(PR #4): Added an option to specify a postcss location in your _config.yml file:
+
+```yml
+postcss:
+  script: node_modules/.bin/postcss
+  config: postcss.config.js
+```

data/README.md

@@ -27,13 +27,91 @@ plugins:
 
 _In your jekyll source directory:_
 ```bash
-npm i -D postcss postcss-cli
+npm i postcss postcss-cli
 ```
 
+Also install any postcss plugins you wish to use. For example, [fluidvars](https://github.com/bglw/postcss-fluidvars), [autoprefixer](https://github.com/postcss/autoprefixer), [cssnano](https://cssnano.co/) etc.
+
 ## Usage
 
 Configure your `postcss.config.js` file in your jekyll source directory.
 
+## Configuration
+
+This plugin will try and locate Postcss automatically. If this fails, you can specify locations in the `_config.yml` file of your site:
+```yml
+postcss:
+  script: node_modules/.bin/postcss
+  config: postcss.config.js
+```
+
+## Deployment
+
+No extra configuration is required for deployment on platforms like [CloudCannon](https://cloudcannon.com/) which support custom plugins.
+
+Please note that this plugin isn't supported by [GitHub Pages](https://pages.github.com/).  
+To host on GitHub Pages and use this plugin, use GitHub Actions to build and deploy your website.
+
+To do that, you need to specify a workflow inside the `.github/workflows` of your repository for your build process. This could look like the following:
+
+```yml
+name: Jekyll Deploy
+
+on:
+  schedule:
+    # run daily at 05:30
+    - cron:  '30 5 * * *'
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - 'Gemfile'
+      - 'README.md'
+      - 'LICENSE.md'
+ 
+# Build site using jekyll
+jobs:
+  jekyll:
+    runs-on: ubuntu-latest
+    steps:
+      # checkout code
+      - uses: actions/checkout@v2
+      # Use ruby/setup-ruby to shorten build times
+      # https://github.com/ruby/setup-ruby
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7 # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      # Install Node as this is needed for PostCSS
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+      # Install PostCSS plugins (from your package.json)
+      - run: npm install
+      - name: Build site
+      # use jekyll-action-ts to build
+      # https://github.com/limjh16/jekyll-action-ts
+        uses: limjh16/jekyll-action-ts@v2
+        with:
+          enable_cache: true
+          # custom_opts: '--verbose --trace'  #'--drafts --future'
+          ### If you need to specify any Jekyll build options, enable the above input
+          ### Flags accepted can be found here https://jekyllrb.com/docs/configuration/options/#build-command-options
+      # use actions-gh-pages to deploy
+      # https://github.com/peaceiris/actions-gh-pages
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          # GITHUB_TOKEN secret is set up automatically
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./_site
+```
+
+See:
+
+- https://github.com/limjh16/jekyll-action-ts/ for more details about the GitHub Action compiling your site.
+
 ## Why v2?
 - Better logging to help catch when things aren't running
 - Processes the output file on disk, skipping the need to parse Sass

data/lib/jekyll-postcss-v2/hook.rb

@@ -4,9 +4,9 @@ require "pathname"
 
 module PostCssV2
   class Engine
-    def initialize(source)
-      @script = Pathname.new(source + "/node_modules/.bin/postcss")
-      unless @script.exist?
+    def initialize(source, options = {})
+      @script = File.expand_path(options[:script] || 'node_modules/.bin/postcss', source)
+      unless File.exist?(@script)
         Jekyll.logger.error "PostCSS v2:",
                             "PostCSS not found.
                              Make sure postcss and postcss-cli
@@ -16,8 +16,8 @@ module PostCssV2
         exit 1
       end
 
-      @config = Pathname.new(source + "/postcss.config.js")
-      unless @config.exist?
+      @config = File.expand_path(options[:config] || 'postcss.config.js', source)
+      unless File.exist?(@config)
         Jekyll.logger.error "PostCSS v2:",
                             "postcss.config.js not found.
                              Make sure it exists in your Jekyll source."
@@ -38,7 +38,10 @@ end
 
 Jekyll::Hooks.register :pages, :post_write do |page|
   if %r!\.css$! =~ page.url
-    engine = PostCssV2::Engine.new(page.site.source)
+    engine = PostCssV2::Engine.new(page.site.source, {
+      script: page.site.config.dig('postcss', 'script'),
+      config: page.site.config.dig('postcss', 'config'),
+    })
     engine.process(page)
   end
 end

data/lib/jekyll-postcss-v2/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module PostCssV2
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-postcss-v2
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Liam Bigelow
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-13 00:00:00.000000000 Z
+date: 2023-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -102,7 +103,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/bglw/jekyll-postcss-v2
   source_code_uri: https://github.com/bglw/jekyll-postcss-v2
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -117,8 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Straight up PostCSS for Jekyll.
 test_files: []