bridgetown-plugin-tailwindcss 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4ce91a98c46bff19d557ae368e8f28cdd6abffb27acb37e1a24614e9b0e649a
+  data.tar.gz: 9244712044140697ca0278d98ccf8f300b1d5d219c35bca39b7eec4a4708282e
+SHA512:
+  metadata.gz: 1f50d417e22fc75c27c7f401f8f3b837b94976e6fce3c8843fd56e419106d34c1cf8a15bfbabf90261dab13c4d53f28d95fe965ca234cde5afff219c5cf6791c
+  data.tar.gz: b7a664a5d0970ef790e2148afd38038fa5c98d1d1eb6078be0d687497dc1700f22f8ec64398e443ef447f98f29bb8406d202b9a6d77f10f5b8be79b040e96b58

data/.gitignore

@@ -0,0 +1,39 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+spec/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+    - lib/**/*.rb
+
+  Exclude:
+    - .gitignore
+    - .rspec
+    - .rubocop.yml
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+
+    - script/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# master
+
+* Use this file to keep track of plugin updates
+
+# 0.1.0 / 2020-05-01
+
+* First version

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present
+
+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.md

@@ -0,0 +1,64 @@
+# Sample plugin for Bridgetown
+
+_NOTE: This isn't a real plugin! Copy this sample code and use it to create your own Ruby gem! [Help guide here…](https://www.bridgetownrb.com/docs/plugins)_ 😃
+
+A Bridgetown plugin to [fill in the blank]…
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+$ bundle add my-awesome-plugin -g bridgetown_plugins
+```
+
+## Usage
+
+The plugin will…
+
+### Optional configuration options
+
+The plugin will automatically use any of the following metadata variables if they are present in your site's `_data/site_metadata.yml` file.
+
+…
+
+## Testing
+
+* Run `bundle exec rspec` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and test with rspec together.
+
+## Contributing
+
+1. Fork it (https://github.com/username/my-awesome-plugin/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+----
+
+## Releasing (you can delete this section in your own plugin repo)
+
+To release a new version of the plugin, simply bump up the version number in both `version.rb` and
+`package.json`, and then run `script/release`. This will require you to have a registered account
+with both the [RubyGems.org](https://rubygems.org) and [NPM](https://www.npmjs.com) registries.
+You can optionally remove the `package.json` and `frontend` folder if you don't need to package frontend
+assets for Webpack.
+
+If you run into any problems or need further guidance, please check out our [Bridgetown community resources](https://www.bridgetownrb.com/docs/community)
+where friendly folks are standing by to help you build and release your plugin or theme.
+
+**NOTE:** make sure you add the `bridgetown-plugin` [topic](https://github.com/topics/bridgetown-plugin) to your
+plugin's GitHub repo so the plugin or theme will show up on [Bridgetown's official Plugin Directory](https://www.bridgetownrb.com/plugins)! (There may be a day or so delay before you see it appear.)
+
+
+
+```javascript
+// frontend/styles/index.js
+@import 'tailwindcss/base';
+@import 'tailwindcss/components';
+@import 'tailwindcss/utilities';
+
+// ...
+```

data/Rakefile

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+task :release do
+  Rake.sh "./script/release"
+end
+
+def filelist(*strings)
+  Rake::FileList.new(strings) do |fl|
+    fl.exclude(/node_modules/)
+    fl.exclude(/Rakefile/)
+    fl.exclude(/\.md/)
+    fl.exclude(/\.txt/)
+    fl.exclude(/tags/)
+  end
+end
+
+def file_rename(file, regex, string)
+  return nil unless file =~ regex
+
+  new_file = file.gsub(regex, string)
+  Rake.mkdir_p(File.dirname(new_file))
+  Rake.mv(file, new_file)
+end
+
+PLUGIN_NAME = "bridgetown-plugin-tailwindcss"
+UNDERSCORE_PLUGIN_NAME = PLUGIN_NAME.gsub(/-/, "_")
+MODULE_NAME = "TailwindCss"
+
+SAMPLE_PLUGIN = /sample-plugin/
+UNDERSCORE_SAMPLE_PLUGIN = /sample_plugin/
+BRIDGETOWN_SAMPLE_PLUGIN = /bridgetown-sample-plugin/
+SAMPLE_PLUGIN_MODULE = /SamplePlugin/
+
+ALL_REGEX_ARY = [
+  SAMPLE_PLUGIN,
+  UNDERSCORE_SAMPLE_PLUGIN,
+  BRIDGETOWN_SAMPLE_PLUGIN,
+  SAMPLE_PLUGIN_MODULE
+]
+
+# Reverse it so files come first, then directories
+ALL_FILES = filelist("**/*").reverse
+
+# https://avdi.codes/rake-part-2-file-lists/
+namespace :plugin do
+  desc "Renames and rewrites files"
+  task rename: [:rewrite_files, :rename_files] do
+  end
+
+  desc "Renames the plugin"
+  task :rename_files do
+    ALL_FILES.map do |file|
+      file_rename(file, BRIDGETOWN_SAMPLE_PLUGIN, PLUGIN_NAME)
+      file_rename(file, SAMPLE_PLUGIN, PLUGIN_NAME)
+      file_rename(file, UNDERSCORE_SAMPLE_PLUGIN, UNDERSCORE_PLUGIN_NAME)
+    end
+  end
+
+  desc "Renames the plugin inside of files"
+  task :rewrite_files do
+    ALL_FILES.each do |file|
+      next if File.directory?(file)
+
+      # Fixes an issue with non-unicode characters
+      text = File.read(file).encode("UTF-8", invalid: :replace, replace: "?")
+
+      # Go to next iteration, unless it contains the regex
+      next unless ALL_REGEX_ARY.any? { |regex| text =~ regex }
+
+      # Check for /bridgetown-sample-plugin/ first, if that doesnt
+      # exist, then check for regular /sample-plugin/
+      replacement_text = text.gsub(SAMPLE_PLUGIN_MODULE, MODULE_NAME)
+      replacement_text = replacement_text.gsub(BRIDGETOWN_SAMPLE_PLUGIN, PLUGIN_NAME)
+      replacement_text = replacement_text.gsub(SAMPLE_PLUGIN, PLUGIN_NAME)
+      replacement_text = replacement_text.gsub(UNDERSCORE_SAMPLE_PLUGIN,
+                                               UNDERSCORE_PLUGIN_NAME)
+      File.open(file, "w") { |file| file.puts replacement_text }
+    end
+  end
+end
+
+

data/bridgetown-plugin-tailwindcss.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-plugin-tailwindcss/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-plugin-tailwindcss"
+  spec.version       = TailwindCss::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.summary       = "Sample code for creating new Bridgetown plugins"
+  spec.homepage      = "https://github.com/bridgetownrb/bridgetown-plugin-tailwindcss"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^spec/!)
+  spec.require_paths = ["lib"]
+  spec.metadata      = { "yarn-add" => "bridgetown-plugin-tailwindcss@#{TailwindCss::VERSION}" }
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency "bridgetown", ">= 0.14", "< 2.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.2"
+end

data/lib/bridgetown-plugin-tailwindcss.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "bridgetown-plugin-tailwindcss/builder"
+
+Bridgetown::PluginManager.new_source_manifest(
+  origin: TailwindCss,
+)

data/lib/bridgetown-plugin-tailwindcss/builder.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module TailwindCss
+  class Builder < Bridgetown::Builder
+  end
+end
+
+TailwindCss::Builder.register

data/lib/bridgetown-plugin-tailwindcss/command.rb

@@ -0,0 +1,115 @@
+require 'bridgetown'
+require 'utils'
+
+class Command < Bridgetown::Command
+  include Utils
+
+  class << self
+    def init_with_program(prog)
+      prog.command(:init) do |c|
+        c.syntax "init"
+        c.description 'Initialize config for Tailwind'
+        # c.option 'path', '--path', 'Choose the path to install tailwind'
+
+        c.action do |args, options|
+          generate_tailwind
+        end
+      end
+    end
+
+    private
+
+    def generate_tailwind
+      install_tailwind
+      write_files
+    end
+
+    def install_tailwind
+      yarn_add = "yarn add -D"
+      packages = "tailwindcss postcss-import postcss-loader"
+      Bridgetown::Utils::Exec.run(yarn_add, packages)
+    end
+
+    def write_files
+      webpack_config = File.expand_path("webpack.config.js")
+      tailwind_config = File.expand_path("tailwind.config.js")
+
+      File.open(webpack_config) do |f|
+        f.write(webpack_file_contents)
+      end
+
+      File.open(tailwind_config) do |f|
+        f.write(tailwind_config_contents)
+      end
+
+      prepend_to_stylesheet
+    end
+
+    def prepend_to_stylesheet
+      frontend_stylesheet = File.join("frontend", "styles", "index.scss")
+      frontend_stylesheet = File.expand_path(frontend_stylesheet)
+
+      return unless File.exist?(frontend_stylesheet)
+
+      prepend_to_file(frontend_stylesheet, import_tailwind_contents)
+    end
+
+    def import_tailwind_contents
+      <<~IMPORT
+        @import 'tailwindcss/base';
+        @import 'tailwindcss/components';
+        @import 'tailwindcss/utilities';
+      IMPORT
+    end
+
+    def tailwind_config_contents
+      <<~TAILWIND
+        module.exports = {
+          purge: {
+            enabled: true,
+            content: ['./src/**/*.html'],
+          },
+          theme: {
+            extend: {},
+          },
+          variants: {},
+          plugins: [],
+        }
+      TAILWIND
+    end
+
+    def webpack_file_contents
+      <<~WEBPACK
+        {
+          test: /\.(s[ac]|c)ss$/,
+          use: [
+            MiniCssExtractPlugin.loader,
+            "css-loader",
+            {
+              loader: "sass-loader",
+              options: {
+                sassOptions: {
+                  includePaths: [
+                    path.resolve(__dirname, "src/_components"),
+                    path.resolve(__dirname, "src/_includes"),
+                  ],
+                },
+              },
+            },
+            {
+              loader: "postcss-loader",
+              options: {
+                ident: "postcss",
+                plugins: [
+                  require("postcss-import"),
+                  require("tailwindcss"),
+                  require("autoprefixer"),
+                ],
+              },
+            },
+          ],
+        },
+      WEBPACK
+    end
+  end
+end

data/lib/bridgetown-plugin-tailwindcss/utils.rb

@@ -0,0 +1,10 @@
+module Utils
+  def prepend_to_file(file, str)
+    File.open(file, 'w') do |open_file|
+      open_file.puts(str)
+      File.foreach(file) do |line|
+        open_file.puts(line)
+      end
+    end
+  end
+end

data/lib/bridgetown-plugin-tailwindcss/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TailwindCss
+  VERSION = "0.1.0"
+end

data/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "bridgetown-plugin-tailwindcss",
+  "version": "0.1.0",
+  "main": "frontend/javascript/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/paramagicdev/bridgetown-plugin-tailwindcss.git"
+  },
+  "author": "Konnor Rogers <konnor7414@gmail.com>",
+  "homepage": "https://www.bridgetownrb.com",
+  "license": "MIT",
+  "private": false,
+  "files": [
+    "frontend"
+  ]
+}

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-plugin-tailwindcss
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email: maintainers@bridgetownrb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown-plugin-tailwindcss.gemspec
+- lib/bridgetown-plugin-tailwindcss.rb
+- lib/bridgetown-plugin-tailwindcss/builder.rb
+- lib/bridgetown-plugin-tailwindcss/command.rb
+- lib/bridgetown-plugin-tailwindcss/utils.rb
+- lib/bridgetown-plugin-tailwindcss/version.rb
+- package.json
+- tags
+homepage: https://github.com/bridgetownrb/bridgetown-plugin-tailwindcss
+licenses:
+- MIT
+metadata:
+  yarn-add: bridgetown-plugin-tailwindcss@0.1.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Sample code for creating new Bridgetown plugins
+test_files: []