jekyll-prettier 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5579df6f0b3f7fb46ced8cc90aaa16d78851cf3b5acb2c99a83635be2b863210
+  data.tar.gz: c86a8bf667bba3820919785485b137a6ad04df6a048724e06b24b380cf2919cb
+SHA512:
+  metadata.gz: 2eac717fa6aa018a3bd8c866bdf00d8ca9d181f2c9b74c96cdd8cfc61ddbebad7bc3e590507cd46d34d9591ecde7977ffd00b9d91448cdcba628dc19801e7195
+  data.tar.gz: bebf0c5b90540144ecba1b64bacbaa8eba95ee203d57c2d0d91377851d3b1e61af0186fdd3090be21f8897a4b65b458884fa9510b0e46469ff44c2560ec14464

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+/Gemfile.lock
+/.bundle/
+*.gemfile.lock
+
+*.swp
+*.swo

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'open3'

data/README.md

@@ -0,0 +1,44 @@
+# jekyll-prettier
+
+Post-render hooks for cleaning up Jekyll outputs with `prettier`. Really basic
+— this README is longer than the plugin itself.
+
+Written as an alternative to
+[jekyll-tidy](https://github.com/apsislabs/jekyll-tidy), which uses
+`htmlbeautifier` under-the-hood. Key distinctions:
+
+- `prettier` is more robust to various input HTML styles
+  ([for example, multi-line self-closing blocks](https://github.com/threedaymonk/htmlbeautifier/issues/53))
+- `prettier` supports more languages
+- `prettier` isn't a Ruby gem, so it needs to be installed manually
+
+---
+
+### Installation
+
+In your site `Gemfile`, add:
+
+```ruby
+group :jekyll_plugins do
+  gem "jekyll-prettier"
+end
+```
+
+---
+
+### Dependencies
+
+Requires that [prettier](https://prettier.io/docs/en/install.html) is installed and
+in the PATH.
+
+Can be installed with npm:
+
+```sh
+npm install --global prettier
+```
+
+or with Yarn:
+
+```sh
+yarn global add prettier
+```

data/jekyll-prettier.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-prettier'
+  spec.version       = '0.0.0'
+  spec.summary       = 'Jekyll formatting plugin'
+  spec.description   = 'Jekyll (Ruby static website generator) plugin that runs prettier on generated outputs.'
+  spec.authors       = %w(brentyi)
+  spec.email         = 'brentyi@berkeley.edu'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.homepage      = 'https://github.com/brentyi/jekyll-prettier'
+  spec.license       = 'MIT'
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.4'
+
+  spec.add_dependency 'jekyll', '>= 3.8'
+end

data/lib/jekyll-prettier.rb

@@ -0,0 +1,37 @@
+require 'open3'
+
+def command?(command)
+  system("which #{ command} > /dev/null 2>&1")
+end
+
+if !command?("prettier")
+  puts "!!!"
+  puts "`prettier` not found; jekyll-prettier will be disabled\e[0m"
+  puts "!!!"
+else
+  # Handle docs
+  Jekyll::Hooks.register :documents, :post_render do |doc|
+    puts "Running prettier on doc: " + doc.url
+    args = ["prettier", "--parser", "html"]
+    Open3.popen2(*args) do |stdin, stdout, wait_thru|
+      stdin.print doc.output
+      stdin.close
+      doc.output = stdout.read
+    end
+  end
+
+  # Handle pages
+  Jekyll::Hooks.register :pages, :post_render do |page|
+    puts "Running prettier on page: " + page.url
+    if page.html?
+      args = ["prettier", "--parser", "html"]
+    else
+      args = ["prettier", "--stdin-filepath", page.relative_path]
+    end
+    Open3.popen2(*args) do |stdin, stdout, wait_thru|
+      stdin.print page.output
+      stdin.close
+      page.output = stdout.read
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-prettier
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- brentyi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: Jekyll (Ruby static website generator) plugin that runs prettier on generated
+  outputs.
+email: brentyi@berkeley.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- jekyll-prettier.gemspec
+- lib/jekyll-prettier.rb
+homepage: https://github.com/brentyi/jekyll-prettier
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Jekyll formatting plugin
+test_files: []