jekyll-plugin-frontend-build 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79ca4dce7ef732a091f7b1fe4735f18bb17231537891a2abafb59a9dbeb3ae94
+  data.tar.gz: 9f65c010e904e66e0da1574d79e4761b647f783135ad49ef3af885912c7fd0c2
+SHA512:
+  metadata.gz: 3f14c463b98445488e8c63f29505a76dcfea69c4276105fd700cc7636bc154c941b00bacb231d15d58f28a7a5519703446033de26cd55e163c9b75025dbe339d
+  data.tar.gz: 808d9ef0a609b27b0ea98350978231173c56a2a0ba5b155e96bda505ba87b36f8fefbeee0bddca889e868a26eb66e122c14c0407b71fc80554cd44276adf49b8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ribose
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,85 @@
+= Jekyll frontend build plugin
+
+This is a very plugin that post-processes frontend assets,
+enabling you to use the latest ES features
+with less worries about cross-browser compatibility.
+
+This plugin depends on Node/NPM and currently uses Babel.
+
+The plugin uses the “assets” directory in site source as input,
+and `_site/assets` as output.
+
+Current limitations:
+
+* As of now, it only processes JavaScript files under `assets/js` with Babel.
+* The output & source directories are hard-coded;
+  if your site output directory is not `_site` this won’t work.
+
+Roadmap:
+
+* Post-process the CSS with at least auto-prefixer
+* Combine front-end assets into a few packages (bulk of JS, bulk of CSS) and minify it
+* Glean site destination directory from configuration
+* Make source asset directory (directories) configurable
+* (?) Use Web components, e.g. Polymer
+
+== Requirements
+
+This plugin requires Node & NPM to be available in Jekyll build environment.
+
+== Setting up
+
+A quick way to use this plugin with a new site is to use
+the https://github.com/riboseinc/[jekyll-site-skeleton] template.
+
+Alternatively, to add this plugin to an existing site,
+create the following files in your site root,
+and run `npm install` afterwards:
+
+.package.json
+[source,json]
+----
+{
+  "version": "1.0.0",
+  "main": "babel.config.js",
+  "dependencies": {
+    "@babel/cli": "^7.5.5",
+    "@babel/core": "^7.5.5",
+    "@babel/polyfill": "^7.4.4",
+    "@babel/preset-env": "^7.5.5"
+  }
+}
+----
+
+.babel.config.js
+[source,javascript]
+----
+const presets = [
+  [
+    "@babel/env",
+    {
+      targets: {
+        ie: "10",
+        edge: "17",
+        firefox: "60",
+        chrome: "67",
+        safari: "11.1",
+      },
+    },
+  ],
+];
+
+module.exports = { presets };
+----
+
+== Using during development
+
+The plugin will take effect if you run `jekyll serve` as usual.
+
+== Using in production/CI
+
+Just make sure that Node/NPM are available in your environment,
+and call `npm install` before building the site.
+
+See `.travis.yml` in https://github.com/riboseinc/[jekyll-site-skeleton]
+for an example.

data/develop/release

@@ -0,0 +1,41 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Make sure the darn thing works? Meh.
+# bundle update
+
+# Build a new gem archive.
+
+rm -rf jekyll-plugin-frontend-build-*.gem
+gem build -q jekyll-plugin-frontend-build.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q 'master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls jekyll-plugin-frontend-build-*.gem | sed 's/^jekyll-plugin-frontend-build-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push jekyll-plugin-frontend-build-*.gem && git tag "$tag" &&
+git push origin master && git push origin "$tag"

data/jekyll-plugin-frontend-build.gemspec

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name          = 'jekyll-plugin-frontend-build'
+  s.version       = '0.0.1'
+  s.authors       = ['Ribose Inc.']
+  s.email         = ['open.source@ribose.com']
+
+  s.summary       = 'Jekyll plugin that post-processes static assets with Babel'
+  s.homepage      = 'https://github.com/riboseinc/jekyll-plugin-frontend-build/'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!) }
+
+  s.add_runtime_dependency 'jekyll', '~> 3.8'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rubocop', '~> 0.50'
+
+  s.require_paths = ["lib"]
+end

data/lib/jekyll-plugin-frontend-build.rb

@@ -0,0 +1,7 @@
+require 'jekyll-plugin-frontend-build/run_babel'
+
+
+module Jekyll
+  module PluginFrontendBuild
+  end
+end

data/lib/jekyll-plugin-frontend-build/run_babel.rb

@@ -0,0 +1,7 @@
+Jekyll::Hooks.register :site, :post_write do |site|
+  run_frontend_build()
+end
+
+def run_frontend_build()
+  system('./node_modules/.bin/babel assets/js --out-dir _site/assets/js')
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-plugin-frontend-build
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-17 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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+description: 
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.adoc
+- develop/release
+- jekyll-plugin-frontend-build.gemspec
+- lib/jekyll-plugin-frontend-build.rb
+- lib/jekyll-plugin-frontend-build/run_babel.rb
+homepage: https://github.com/riboseinc/jekyll-plugin-frontend-build/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin that post-processes static assets with Babel
+test_files: []