jekyll-vite 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7db450fb50d7d77214596d9f5a78518b4618c2100118502e2d4178cdd242e0ad
-  data.tar.gz: 74dc9598aa9b76bc755c4c1d0513fb6d9ebc50c22c738768e31280146b469d6d
+  metadata.gz: c6687f3165b7bd34011b9d488746cdb5b998a091ec106fe20bc6ec25534861e8
+  data.tar.gz: fe3e88c00738f30d4fde3637a658cf4d617b4dfb4a625d6b5280229ed59452bd
 SHA512:
-  metadata.gz: '09b2ee91572039d136a1db1b3aa4f0cc4f21bd4560a1d5d37d8d548a3176fa4c72b04b479e7f857e7aca2d8e4fec91dd70dce16086635ad905b1488a4ec9173a'
-  data.tar.gz: a6ed6af1378fb9bd128ab45f5f0eea48db46a8dc4f38bdde58f17e1515f894473e451cfc29aa323b470faf137ccbd786106b5d4530f84507cd0c285a43dece8a
+  metadata.gz: bf7a8c2a00fb7f46cf14c0574adaa8d84e0d6a72433b838703e11d18519a7255841502712a594d3e0aacf34f88c4197f804fb254a3363d26aa1c95bae4061d8c
+  data.tar.gz: 24eadaa85832157190f81fece490f8907dbe5f59c14ec4234672da6010dd762b8327d8b478ae6814edece0b73b7834cdb2322148697bc38168ac3867a873ba41

data/CHANGELOG.md

@@ -1,14 +1,45 @@
+# [1.0.0](https://github.com/ElMassimo/jekyll-vite/compare/v0.0.3...v1.0.0) (2021-07-22)
+
+
+### Features
+
+* Watch layouts and partials by default ([004e8f1](https://github.com/ElMassimo/jekyll-vite/commit/004e8f1318fda3031a7ea8ebbd6b396e742b7642))
+
+
+
+## [0.0.3](https://github.com/ElMassimo/jekyll-vite/compare/v0.0.2...v0.0.3) (2021-07-05)
+
+### Features
+
+- Add support for Jekyll 3.9
+- Add `vite_react_refresh_tag` helper
+
+### Bug Fixes
+
+- Ensure non-proxied requests are served with an HTTP status
+- Ensure Ruby 3.0 support
+
+
+## [0.0.2](https://github.com/ElMassimo/jekyll-vite/compare/v0.0.1...v0.0.2) (2021-07-03)
+
+
+### Bug Fixes
+
+* Do not serve files with custom status in local development server ([86cf47b](https://github.com/ElMassimo/jekyll-vite/commit/86cf47b485520879c7b7e7a79c7245dc0ba92b16))
+
+
+
 ## 0.0.1 (2021-07-02)
 
 ### Features
 
-* Build vite assets when generating site and preserve assets correctly ([0b9a138](https://github.com/ElMassimo/vite_ruby/commit/0b9a138393a00c96119e42d5a59ac71539d00912))
-* Ignore Vite dir when the dev server is active, add the last build ([548a47f](https://github.com/ElMassimo/vite_ruby/commit/548a47f8bbb6f22820083d22d4628d445149ba46))
-* Implement a WEBrick proxy servlet for Jekyll ([b5afe03](https://github.com/ElMassimo/vite_ruby/commit/b5afe03b763235c23d9eaf940086d6ddb19399dc))
-* Implement liquid tags to render script and stylesheet tags ([4cbb679](https://github.com/ElMassimo/vite_ruby/commit/4cbb679af2625f31954c56b7cda032c896d7e127))
-* Read mode from JEKYLL_ENV ([acd7181](https://github.com/ElMassimo/vite_ruby/commit/acd7181c507cd1971f056462f240dec0071acf3b))
-* Serve files from the cache when the Vite dev server is down ([d695718](https://github.com/ElMassimo/vite_ruby/commit/d695718b1805211aa8b63c81d140b7212d2347f5))
-* Track dependencies on entrypoints ([5b8c413](https://github.com/ElMassimo/vite_ruby/commit/5b8c41336085e24568750bcbc77192f498488f46))
+* Build vite assets when generating site and preserve assets correctly ([0b9a138](https://github.com/ElMassimo/jekyll-vite/commit/0b9a138393a00c96119e42d5a59ac71539d00912))
+* Ignore Vite dir when the dev server is active, add the last build ([548a47f](https://github.com/ElMassimo/jekyll-vite/commit/548a47f8bbb6f22820083d22d4628d445149ba46))
+* Implement a WEBrick proxy servlet for Jekyll ([b5afe03](https://github.com/ElMassimo/jekyll-vite/commit/b5afe03b763235c23d9eaf940086d6ddb19399dc))
+* Implement liquid tags to render script and stylesheet tags ([4cbb679](https://github.com/ElMassimo/jekyll-vite/commit/4cbb679af2625f31954c56b7cda032c896d7e127))
+* Read mode from JEKYLL_ENV ([acd7181](https://github.com/ElMassimo/jekyll-vite/commit/acd7181c507cd1971f056462f240dec0071acf3b))
+* Serve files from the cache when the Vite dev server is down ([d695718](https://github.com/ElMassimo/jekyll-vite/commit/d695718b1805211aa8b63c81d140b7212d2347f5))
+* Track dependencies on entrypoints ([5b8c413](https://github.com/ElMassimo/jekyll-vite/commit/5b8c41336085e24568750bcbc77192f498488f46))
 
 
 

data/README.md

@@ -1,25 +1,25 @@
 <h1 align="center">
-  <a href="https://vite-ruby.netlify.app/">
+  <a href="https://jekyll-vite.netlify.app/">
     <img src="https://raw.githubusercontent.com/ElMassimo/vite_ruby/main/docs/public/logo.svg" width="120px"/>
   </a>
 
   <br>
 
-  <a href="https://vite-ruby.netlify.app/">
+  <a href="https://jekyll-vite.netlify.app/">
     Jekyll ➕ Vite.js
   </a>
 
   <br>
 
   <p align="center">
-    <!-- <a href="https://github.com/ElMassimo/jekyll-vite/actions">
+    <a href="https://github.com/ElMassimo/jekyll-vite/actions">
       <img alt="Build Status" src="https://github.com/ElMassimo/jekyll-vite/workflows/build/badge.svg"/>
-    </a> -->
- <!--    <a href="https://codeclimate.com/github/ElMassimo/jekyll-vite">
+    </a>
+    <a href="https://codeclimate.com/github/ElMassimo/jekyll-vite">
       <img alt="Maintainability" src="https://codeclimate.com/github/ElMassimo/jekyll-vite/badges/gpa.svg"/>
     </a>
     <a href="https://codeclimate.com/github/ElMassimo/jekyll-vite">
-      <img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/jekyll-vite/badges/coverage.svg"/> -->
+      <img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/jekyll-vite/badges/coverage.svg"/>
     </a>
     <a href="https://rubygems.org/gems/jekyll-vite">
       <img alt="Gem Version" src="https://img.shields.io/gem/v/jekyll-vite.svg?colorB=e9573f"/>
@@ -30,8 +30,8 @@
   </p>
 </h1>
 
-[website]: https://github.com/ElMassimo/vite-ruby
-[website]: https://vite-ruby.netlify.app/
+[vite ruby]: https://github.com/ElMassimo/vite_ruby
+[website]: https://jekyll-vite.netlify.app/
 [jekyll]: https://jekyllrb.com/
 [configuration reference]: https://vite-ruby.netlify.app/config/
 [features]: https://vite-ruby.netlify.app/guide/introduction.html
@@ -44,6 +44,8 @@
 [bundling]: https://vitejs.dev/guide/why.html#why-bundle-for-production
 [rollup.js]: https://rollupjs.org
 [esbuild]: https://esbuild.github.io/
+[example]: https://github.com/ElMassimo/jekyll-vite/tree/main/docs
+[installation]: https://jekyll-vite.netlify.app/posts/installation/
 
 Use [Vite.js] in [Jekyll] and enjoy a modern assets pipeline! ⚡️
 
@@ -53,7 +55,7 @@ Use [Vite.js] in [Jekyll] and enjoy a modern assets pipeline! ⚡️
 
 - ⚡️ Blazing fast hot reload
 - 📦 Zero-config builds
-- 🎨 Use your favorite languages/preprocessors/utilities (TypeScript, Tailwind CSS, etc.)
+- 🎨 Use your favorite tools (TypeScript, Tailwind CSS, etc.)
 
 ## Why Vite? 🤔
 
@@ -66,6 +68,13 @@ a result there is an active ecosystem of plugins and tooling available. In addit
 it's [no bundling] design provides a very fluid authoring experience—changes to
 your assets are reflected instantly in your browser.
 
+## Documentation 📖
+
+The [documentation website][website] is built using `jekyll-vite`.
+
+You can [check the source to see an example setup][example], or visit it to
+[learn how to use `jekyll-vite`][website].
+
 ## Installation 💿
 
 Add this line to your site's Gemfile:
@@ -81,35 +90,7 @@ bundle install
 bundle exec vite install
 ```
 
-This will install the plugin in `_config.yml`, and generate a sample setup in
-`_layouts/default.html` (if it exists).
-
-```yml
-plugins:
-  - jekyll/vite
-```
-
-```html
-<head>
-  <!-- meta tags, etc -->
-  {% vite_client_tag %}
-  {% vite_javascript_tag application %}
-  {% vite_stylesheet_tag styles.scss %}
-</head>
-```
-
-Additional installation instructions are available in the [documentation website][website].
-
-## Getting Started 💻
-
-Run <kbd>bin/vite dev</kbd> to start the Vite development server, and then
-restart your Jekyll server with <kbd>bin/jekyll serve</kbd>.
-
-Visit any page and you should see a printed console output: `Vite ⚡️ Ruby`.
-
-For more [guides] and a full [configuration reference], check the [documentation website][website].
-
-_A new section for Jekyll is coming soon!_
+Additional [installation instructions][installation] are available in the [documentation website][installation].
 
 ## Contact ✉️
 

data/lib/jekyll/vite/config.rb

@@ -4,10 +4,10 @@ module Jekyll::Vite::Config
   # Override: Provide default values for a typical Jekyll site.
   def config_defaults(**opts)
     require 'jekyll'
-    config = Jekyll.configuration
+    cache_dir = Jekyll.configuration['cache_dir'] || '.jekyll-cache'
     super(**opts, mode: Jekyll.env).tap do |defaults|
-      defaults['public_dir'] = config['cache_dir']
-      defaults['build_cache_dir'] = File.join(config['cache_dir'], 'vite-build')
+      defaults['public_dir'] = cache_dir
+      defaults['build_cache_dir'] = File.join(cache_dir, 'vite-build')
     end
   end
 end

data/lib/jekyll/vite/generator.rb

@@ -7,9 +7,22 @@ class Jekyll::Vite::Generator < Jekyll::Generator
   priority :highest
 
   class ViteAssetFile < Jekyll::StaticFile
+    # Override (4.2): Copy to the configured public_output_dir
+    if method_defined?(:cleaned_relative_path)
+      def cleaned_relative_path
+        replace_build_path(super)
+      end
+    end
+
     # Override: Copy to the configured public_output_dir
-    def cleaned_relative_path
-      super.sub(
+    def destination_rel_dir
+      replace_build_path(super)
+    end
+
+  private
+
+    def replace_build_path(src)
+      src.sub(
         ViteRuby.config.build_output_dir.relative_path_from(@site.source).to_s,
         ViteRuby.config.public_output_dir,
       )
@@ -27,12 +40,17 @@ class Jekyll::Vite::Generator < Jekyll::Generator
   # Internal: Build all assets with Vite and add them to the site's static files.
   def generate_vite_build(site)
     ViteRuby.commands.build_from_task
-    assets_dir = ViteRuby.config.build_output_dir.relative_path_from(site.source)
-    files = Dir.chdir(ViteRuby.config.build_output_dir.to_s) {
+    add_static_files(site, ViteRuby.config.build_output_dir)
+  end
+
+  # Internal: Add generated assets to the site's static files.
+  def add_static_files(site, assets_dir)
+    relative_assets_dir = assets_dir.relative_path_from(site.source).to_s
+    vite_static_files = Dir.chdir(assets_dir.to_s) {
       Dir.glob('**/*').select { |f| File.file?(f) }
+    }.map { |file|
+      ViteAssetFile.new(site, site.source, relative_assets_dir, file)
     }
-    site.static_files.concat(files.map { |file|
-      ViteAssetFile.new(site, site.source, assets_dir, file)
-    })
+    site.static_files.concat(vite_static_files)
   end
 end

data/lib/jekyll/vite/installation.rb

@@ -19,7 +19,13 @@ module Jekyll::Vite::Installation
   # Override: Inject the vite client and sample script to the default HTML template.
   def install_sample_files
     super
-    inject_line_after root.join('_config.yml'), 'plugins:', '  - jekyll/vite'
+    inject_line_after_last root.join('_config.yml'), 'plugins:', '  - jekyll/vite'
+    inject_line_after_last root.join('_config.yml'), 'exclude:', <<-YML.chomp("\n")
+  - bin
+  - config
+  - vite.config.ts
+  - tmp
+    YML
     inject_line_before root.join('_layouts/default.html'), '</head>', <<-HTML.chomp("\n")
     {% vite_client_tag %}
     {% vite_javascript_tag application %}

data/lib/jekyll/vite/proxy.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
 require 'rack'
-require 'webrick'
 require 'jekyll/commands/serve/servlet'
 
 # Internal: Extend the default servlet to add a Rack-based proxy in order to
 # forward asset requests to the Vite.js development server.
 module Jekyll::Vite::Proxy
   # Internal: Used to detect proxied requests since it's not a valid status code.
-  STATUS_SERVE_ORIGINAL = 0o07
+  STATUS_SERVE_ORIGINAL = 7
 
   def initialize(server, *args)
     @server = server
@@ -28,7 +27,10 @@ module Jekyll::Vite::Proxy
   # default Jekyll response instead.
   def service(req, res)
     proxy_servlet.service(req, res)
-    super if res.status == STATUS_SERVE_ORIGINAL
+    if res.status == STATUS_SERVE_ORIGINAL
+      res.status = 200
+      super
+    end
   end
 
 private

data/lib/jekyll/vite/tags.rb

@@ -64,7 +64,7 @@ protected
     ['', '.css', '.js', '.ts'].each do |ext|
       if File.file?(asset_path = "#{ path }#{ ext }")
         return [asset_path, last_build_metadata_path].each do |filename|
-          add_include_to_dependency(site, filename, @context)
+          add_include_to_dependency(site, filename.to_s, @context)
         end
       end
     end
@@ -80,7 +80,7 @@ end
 # Public: Renders a path to a Vite asset.
 class Jekyll::Vite::AssetPathTag < Jekyll::Vite::Tag
   def render(context)
-    super { vite_asset_path(@file, @params) }
+    super { vite_asset_path(@file, **@params) }
   end
 end
 
@@ -99,6 +99,17 @@ class Jekyll::Vite::ClientTag < Jekyll::Vite::Tag
   end
 end
 
+# Public: Renders a script tag to enable HMR with React Refresh.
+class Jekyll::Vite::ReactRefreshTag < Jekyll::Vite::Tag
+  def render(_context)
+    vite_manifest.react_refresh_preamble&.html_safe
+  end
+
+  def syntax_example
+    "{% #{ @tag_name } %}"
+  end
+end
+
 # Public: Renders a <link> tag for the specified stylesheet.
 class Jekyll::Vite::StylesheetTag < Jekyll::Vite::Tag
   def render(context)
@@ -149,6 +160,7 @@ end
   'vite_javascript_tag' => Jekyll::Vite::JavascriptTag,
   'vite_typescript_tag' => Jekyll::Vite::JavascriptTag,
   'vite_stylesheet_tag' => Jekyll::Vite::StylesheetTag,
+  'vite_react_refresh_tag' => Jekyll::Vite::ReactRefreshTag,
 }.each do |name, tag|
   Liquid::Template.register_tag(name, tag)
 end

data/lib/jekyll/vite/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Vite
-    VERSION = '0.0.1'
+    VERSION = '1.0.1'
   end
 end

data/templates/config/jekyll-vite.json

@@ -1,7 +1,7 @@
 {
   "all": {
     "sourceCodeDir": "_frontend",
-    "watchAdditionalPaths": []
+    "watchAdditionalPaths": ["index.html", "_includes/**/*", "_layouts/**/*"]
   },
   "development": {
     "autoBuild": true,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-vite
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-02 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -50,6 +50,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +78,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  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'
 description:
 email:
 - maximomussini@gmail.com
@@ -86,8 +142,8 @@ homepage: https://github.com/ElMassimo/jekyll-vite
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/ElMassimo/jekyll-vite/tree/v0.0.1
-  changelog_uri: https://github.com/ElMassimo/jekyll-vite/blob/v0.0.1/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/jekyll-vite/tree/v1.0.1
+  changelog_uri: https://github.com/ElMassimo/jekyll-vite/blob/v1.0.1/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: