better_vite_helper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aa9948651f9cdf4792fdc963c80b45192904b1515298aa2a51d5ccda21a7744
-  data.tar.gz: e217785641ddc537f9fba68f254baad56fbe607e8d26224c6b3931d21620a53c
+  metadata.gz: 3eb6dfcbfe19c34dd9712d350b6c3e8af4325ec07641a5dfe971c7fd49dc2989
+  data.tar.gz: 9c17d2898214eced091ab3f89ebb55cff85858f75ce2b5656016a6d4604a4546
 SHA512:
-  metadata.gz: 77876f7bc002d468e2eb348990fd2898c6983950b708cfd075486d3b625ffe0e7db25ebc6e942a270a412309aa58497d0c19dc9bf7e0cc6c7a2b560693f1ccbd
-  data.tar.gz: a402d5bedc937a416aa28a9403044de878f2e94bcdf49de7f70bd274311b08737c4ef28ba018c20e5d25d0d092e20a5f318f6c117170e88c273a623b16ab442d
+  metadata.gz: f760f9cbfda00fd1a57630e9014b5199aa2e6f0a6a5fcc6b5d0e4900a64f328b4cb27aedd39bec9c444f2185d3c21ee20cbfe429f54efa616b7712bec1a7bfbd
+  data.tar.gz: d76dcf6b385f9e74f710b6a7b310ae51b050164645df5dcbda83c58f6e9f446e31c617534e44deb7b9066704bb6b011d65199f678e22961eb9806ac10ad278af

data/README.md

@@ -22,7 +22,26 @@ bundle install
 bin/rails generate better_vite_helper:install
 ```
 
-This copies `vite.config.js` and `postcss.config.js` to your application.
+The generator automatically:
+- Creates `package.json` if missing (with `dev` and `build` scripts)
+- Installs Vite and Tailwind CSS v4 via yarn (or npm)
+- Copies `vite.config.js` and `postcss.config.js`
+- Copies `app/javascript/application.js` with image glob imports
+- Copies `app/assets/stylesheets/application.css` with Tailwind CSS import
+- Updates `app/views/layouts/application.html.erb` with Vite helpers
+- Updates `.gitignore` with Node/Yarn/Vite entries
+
+### Generator Options
+
+```bash
+bin/rails generate better_vite_helper:install --skip-install  # Skip npm dependencies
+bin/rails generate better_vite_helper:install --skip-layout   # Skip layout modification
+```
+
+| Option | Description |
+|--------|-------------|
+| `--skip-install` | Skip installing Vite via yarn/npm |
+| `--skip-layout` | Skip updating application layout with Vite helpers |
 
 ## Usage
 
@@ -44,6 +63,23 @@ This copies `vite.config.js` and `postcss.config.js` to your application.
 <% end %>
 ```
 
+### Image Helpers
+
+```erb
+<%# Generate img tag with Vite-resolved src %>
+<%= vite_image_tag "logo.png", alt: "Logo", class: "logo" %>
+
+<%# Subdirectory images %>
+<%= vite_image_tag "icons/arrow.svg", alt: "Arrow" %>
+
+<%# Get image path directly %>
+<%= vite_image_path "logo.png" %>
+<%# Dev:  http://localhost:5173/app/assets/images/logo.png %>
+<%# Prod: /assets/logo-abc123.png (with CDN if configured) %>
+```
+
+Images in `app/assets/images/` are automatically included in the Vite build via `import.meta.glob`.
+
 ### Configuration
 
 ```ruby
@@ -52,6 +88,7 @@ BetterViteHelper.configure do |config|
   config.dev_server_url = "http://localhost:5173"  # default, or ENV["VITE_DEV_SERVER_URL"]
   config.manifest_path = Rails.root.join("public/assets/.vite/manifest.json")  # default
   config.asset_host = "https://cdn.example.com"  # optional, falls back to Rails.application.config.asset_host
+  config.images_path = "app/assets/images"  # default
 end
 ```
 

data/lib/better_vite_helper/configuration.rb

@@ -2,13 +2,14 @@
 
 module BetterViteHelper
   class Configuration
-    attr_accessor :asset_host
+    attr_accessor :asset_host, :images_path
     attr_writer :manifest_path, :dev_server_url
 
     def initialize
       @manifest_path = nil
       @dev_server_url = nil
       @asset_host = nil
+      @images_path = "app/assets/images"
     end
 
     def manifest_path

data/lib/better_vite_helper/version.rb

@@ -1,3 +1,3 @@
 module BetterViteHelper
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/better_vite_helper/view_helpers.rb

@@ -65,6 +65,15 @@ module BetterViteHelper
       end
     end
 
+    def vite_image_path(source)
+      full_path = resolve_image_path(source)
+      vite_asset_path(full_path)
+    end
+
+    def vite_image_tag(source, **options)
+      image_tag(vite_image_path(source), **options)
+    end
+
     def reset_vite_manifest_cache!
       @vite_manifest = nil
     end
@@ -79,7 +88,7 @@ module BetterViteHelper
       base_url = resolved_asset_host || BetterViteHelper.configuration.dev_server_url
       case entry_name
       when "application.js"
-        "#{base_url}/app/assets/javascripts/application.js"
+        "#{base_url}/app/javascript/application.js"
       when "application.css"
         "#{base_url}/app/assets/stylesheets/application.css"
       else
@@ -96,7 +105,7 @@ module BetterViteHelper
     def resolve_manifest_key(entry_name)
       case entry_name
       when "application.js"
-        "app/assets/javascripts/application.js"
+        "app/javascript/application.js"
       when "application.css"
         "app/assets/stylesheets/application.css"
       else
@@ -115,5 +124,11 @@ module BetterViteHelper
     def resolved_asset_host
       BetterViteHelper.configuration.asset_host || Rails.application.config.asset_host
     end
+
+    def resolve_image_path(source)
+      return source if source.start_with?("app/", "/", "http://", "https://")
+
+      "#{BetterViteHelper.configuration.images_path}/#{source}"
+    end
   end
 end

data/lib/generators/better_vite_helper/install/install_generator.rb

@@ -1,13 +1,90 @@
 # frozen_string_literal: true
 
 require "rails/generators"
+require "json"
 
 module BetterViteHelper
   module Generators
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("templates", __dir__)
 
-      desc "Copies Vite and PostCSS configuration files to your application"
+      desc "Installs Vite and configures your Rails application for BetterViteHelper"
+
+      class_option :skip_install, type: :boolean, default: false,
+                   desc: "Skip installing npm dependencies"
+      class_option :skip_layout, type: :boolean, default: false,
+                   desc: "Skip updating application layout"
+
+      def create_package_json_if_missing
+        return if File.exist?(File.join(destination_root, "package.json"))
+
+        content = {
+          "name" => File.basename(destination_root),
+          "private" => true,
+          "type" => "module",
+          "scripts" => {
+            "dev" => "vite --host 0.0.0.0 --port 5173",
+            "build" => "vite build"
+          }
+        }
+        create_file "package.json", JSON.pretty_generate(content) + "\n"
+      end
+
+      def update_gitignore
+        gitignore_path = ".gitignore"
+
+        entries = <<~GITIGNORE
+
+          # Node/Yarn
+          /node_modules
+
+          # Logs
+          *.log
+          npm-debug.log*
+          yarn-debug.log*
+          yarn-error.log*
+
+          # Vite
+          /.vite
+
+          # Cache
+          .cache
+          .eslintcache
+          .stylelintcache
+
+          # TypeScript
+          *.tsbuildinfo
+
+          # Yarn PnP
+          /.pnp.*
+          /.yarn/*
+          !/.yarn/patches
+          !/.yarn/plugins
+          !/.yarn/releases
+          !/.yarn/sdks
+          !/.yarn/versions
+        GITIGNORE
+
+        if File.exist?(File.join(destination_root, gitignore_path))
+          append_to_file gitignore_path, entries
+        else
+          create_file gitignore_path, entries.strip + "\n"
+        end
+      end
+
+      def install_vite_dependencies
+        return if options[:skip_install]
+
+        say "Installing Vite and PostCSS dependencies...", :green
+
+        deps = %w[vite @tailwindcss/postcss postcss tailwindcss autoprefixer]
+
+        if File.exist?(File.join(destination_root, "yarn.lock")) || !File.exist?(File.join(destination_root, "package-lock.json"))
+          run "yarn add -D #{deps.join(' ')}"
+        else
+          run "npm install --save-dev #{deps.join(' ')}"
+        end
+      end
 
       def copy_vite_config
         copy_file "vite.config.js", "vite.config.js"
@@ -17,15 +94,36 @@ module BetterViteHelper
         copy_file "postcss.config.js", "postcss.config.js"
       end
 
+      def copy_application_js
+        copy_file "application.js", "app/javascript/application.js"
+      end
+
+      def copy_application_css
+        copy_file "application.css", "app/assets/stylesheets/application.css"
+      end
+
+      def update_application_layout
+        return if options[:skip_layout]
+
+        layout_path = "app/views/layouts/application.html.erb"
+        return unless File.exist?(File.join(destination_root, layout_path))
+
+        gsub_file layout_path,
+          /<%=\s*stylesheet_link_tag\s+["']application["'].*%>/,
+          '<%= vite_stylesheet_link_tag "application.css" %>'
+
+        inject_into_file layout_path, before: "</body>" do
+          "    <%= vite_javascript_include_tag \"application.js\" %>\n  "
+        end
+      end
+
       def show_post_install_message
         say ""
         say "BetterViteHelper installed successfully!", :green
         say ""
-        say "Next steps:"
-        say "  1. Run 'yarn add -D vite' to install Vite"
-        say "  2. Add your JavaScript entry point at app/assets/javascripts/application.js"
-        say "  3. Add your CSS entry point at app/assets/stylesheets/application.css"
-        say "  4. Run 'yarn vite' for development or 'yarn vite build' for production"
+        say "To start development:"
+        say "  yarn dev         # Start Vite dev server"
+        say "  bin/rails server # Start Rails (in another terminal)"
         say ""
       end
     end

data/lib/generators/better_vite_helper/install/templates/application.css

@@ -0,0 +1 @@
+@import "tailwindcss";

data/lib/generators/better_vite_helper/install/templates/application.js

@@ -0,0 +1,10 @@
+// Entry point per Vite
+import "../assets/stylesheets/application.css";
+
+// Import all images to include them in Vite manifest
+// Images will be available via vite_image_tag helper
+import.meta.glob("../assets/images/**/*.{png,jpg,jpeg,gif,svg,webp,avif,ico}", {
+  eager: true,
+});
+
+// Il tuo codice JavaScript qui

data/lib/generators/better_vite_helper/install/templates/vite.config.js

@@ -30,9 +30,8 @@ export default defineConfig({
       input: {
         application: resolve(
           __dirname,
-          "app/assets/javascripts/application.js"
+          "app/javascript/application.js"
         ),
-        styles: resolve(__dirname, "app/assets/stylesheets/application.css"),
       },
       output: {
         entryFileNames: "application-[hash].js",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: better_vite_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Umberto Peserico
@@ -48,6 +48,8 @@ files:
 - lib/better_vite_helper/version.rb
 - lib/better_vite_helper/view_helpers.rb
 - lib/generators/better_vite_helper/install/install_generator.rb
+- lib/generators/better_vite_helper/install/templates/application.css
+- lib/generators/better_vite_helper/install/templates/application.js
 - lib/generators/better_vite_helper/install/templates/postcss.config.js
 - lib/generators/better_vite_helper/install/templates/vite.config.js
 - lib/tasks/better_vite_helper_tasks.rake